Metadata-Version: 2.1
Name: Flask-Mux
Version: 0.0.2
Summary: Minimal routing extension for Flask
Home-page: https://github.com/ElMehdi19/flask-mux
Author: El Mehdi Rami
Author-email: elmehdirami5@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://flask-mux.readthedocs.com
Project-URL: Source Code, https://github.com/ElMehdi19
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.6
Requires-Dist: flask

Flask-Mux
================

|Build Status| |Latest Version| |Supported Python versions|
|License|

**Flask-Mux** is a lightweight Flask_ extension that provides a routing 
system similar to that of Express.js_. It basically wraps Flask's 
url route registrations API to add more flexibility.

.. _Flask: https://palletsprojects.com/p/flask/
.. _Express.js: https://www.expressjs.com


Installing
----------
Install using `pip`_:

.. code-block:: text

  $ pip install Flask-Mux

.. _pip: https://pip.pypa.io/en/stable/quickstart/


A Simple Example
----------------

.. code-block:: python

    from flask import Flask
    from flask_mux import Mux, Router

    app = Flask(__name__)
    mux = Mux(app)

    def home():
        return 'home'

    def about():
        return 'about'

    index_router = Router()
    index_router.get('/', home)
    index_router.get('/about', about)

    mux.use('/', index_router)


User's Guide
------------
You'll find the user guide and all documentation here_

.. _here: https://emr-flask-mux.readthedocs-hosted.com/en/latest/

Links
-----

-   Documentation: https://emr-flask-mux.readthedocs-hosted.com/en/latest/ 
-   PyPI Releases: https://pypi.org/project/Flask-Mux/
-   Source Code: https://github.com/ElMehdi19/flask-mux/
-   Issue Tracker: https://github.com/ElMehdi19/flask-mux/issues/


.. |Build Status| image:: https://github.com/ElMehdi19/flask-mux/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/ElMehdi19/flask-mux/actions
.. |Latest Version| image:: https://img.shields.io/pypi/v/Flask-Mux.svg
   :target: https://pypi.python.org/pypi/Flask-Mux/
.. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/Flask-Mux.svg
   :target: https://img.shields.io/pypi/pyversions/Flask-Mux.svg
.. |License| image:: http://img.shields.io/:license-mit-blue.svg
   :target: https://pypi.python.org/pypi/Flask-Mux

