README.rst

Flask-Reggie

Enable Regex Routes within Flask

Installation

pip install flask-reggie

Configuration

To enable regex routes within your application

from flask import Flask
from flask_reggie import Reggie

app = Flask(__name__)
Reggie(app)

or

from flask import Flask
from flask_reggie import Reggie

reggie = Reggie()

def create_app():
    app = Flask(__name__)
    reggie.init_app(app)
    return app

Usage

If we were looking to have a UUID supplied as a view argument, we would follow this pattern

@app.route('/<regex("[0-9a-f]{32}"):uuid>')
def example(uuid):
    return uuid

As you can see, we are able to supply a regular expression, and have it passed as a view argument.

Simple.

Contribute

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet.
2. Fork the repository on Github to start making your changes to the master branch (or branch off of it).
3. Write a test which shows that the bug was fixed or that the feature works as expected.
4. Send a pull request and bug the maintainer until it gets merged and published.