Flask-Mux’s documentation!

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.

Get started with Installation and then get an overview with the Quickstart. There is also a more detailed Flask-Mux example that shows how to create a small but complete application with Flask. The rest of the docs describe each component of Flask in detail, with a full reference in the API Reference section.

• Quickstart
  • Express-like approach
  • Using the route decorator
• Tutorial
  • Pure Flask example
  • Flask-Mux example
  • Writing middlewares
• API Reference
  • flask_mux.mux module
  • flask_mux.router module
  • flask_mux.errors module

Installation

Install Flask-Mux using pip:

$ pip3 install flask-mux

User’s Guide

• Quickstart

• Tutorial

  • Pure Flask example

  • Flask-Mux example

  • Writing middlewares

• API Reference

Tests

Tests are all kept in tests/, to run them, install tox and simply invoke tox in your command line.

Contributing

Contributions are very welcome. Please feel free to clone the project’s repository and submit a PR with your improved version.
If you have a question or would like to request a feature, please create an issue on Github, tweet me @DMehdi19 or reach to me by email.