https://github.com/em-r/flask-mux

Minimal routing extension for Flask
https://github.com/em-r/flask-mux

flask

Last synced: 8 days ago
JSON representation

Minimal routing extension for Flask

• Host: GitHub
• URL: https://github.com/em-r/flask-mux
• Owner: em-r
• License: mit
• Created: 2021-04-24T02:26:12.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-06T17:15:54.000Z (over 3 years ago)
• Last Synced: 2024-10-18T20:29:18.255Z (21 days ago)
• Topics: flask
• Language: Python
• Homepage: https://flask-mux.readthedocs.io/en/latest/
• Size: 74.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Flask-Mux

================

|Build Status| |Downloads| |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(__name__)

    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://flask-mux.readthedocs.io/en/latest/

Links

-----

-   Documentation: https://flask-mux.readthedocs.io/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

.. |Downloads| image:: https://static.pepy.tech/personalized-badge/flask-mux?period=total&units=international_system&left_color=black&right_color=blue&left_text=Downloads 

   :target: https://pepy.tech/project/flask-mux