Skip to main content

Django-style url handling for Flask

Project description

flask_url_mapping

Django-style url handling for Flask

Inspired by [https://stackoverflow.com/questions/31680048/django-styled-flask-url-pattern-for-large-application] this package is an attempt to generalize the concept of Django-like url-view / endpoint-mapping.

You can install it via

pip install flask-url-mapping

Centerpiece is an urls.py which contains the mapping.

urls = [
    ("/", views.index),                             #1
    ("/login", views.login, ["GET", "POST"]),       #2
    ("/home", "home.urls")                          #3
    ("/admin", views.admin, ["GET"], "admin_role"), #4
]

There are four ways to map routes to endpoints

  1. route to endpoint, http method default is GET
  2. route to endpoint with array of http methods
  3. route to component see Components
  4. route to endpoint with array of http methods and required role

After declaring your url mapping You can register the urls to the flask app via register_urls

A sample setup without permissions

  • wsgi.py
from flask import Flask
from flask_url_mapping import register_urls
from urls import urls
app = Flask(__name__)

if __name__ == '__main__':
    flask_urls = FlaskUrls(app)
    flask_urls.register_urls(urls)
    app.run()
  • urls.py
from views import *
urls = [
    ("/", hello_world, ["GET"])
]
  • views.py
def hello_world():
    return 'Hello World!'    

A sample setup with permissions

When adding a role to a route endpoint mapping your project has to use flask_login

Components

A component is a subfolder which contains at least an urls.py and an views.py When this folder also contains a templates directory, it will be automatically added to the jinja2 search path for html templates

Travis-CI

Build Status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_url_mapping-0.6.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

flask_url_mapping-0.6-py2.py3-none-any.whl (4.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file flask_url_mapping-0.6.tar.gz.

File metadata

  • Download URL: flask_url_mapping-0.6.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.1.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for flask_url_mapping-0.6.tar.gz
Algorithm Hash digest
SHA256 d42389a12089eb07f65edf48569846890642111c5e0288051f8213f51855dee7
MD5 528174c40bc1b6a34a3c26e7fa17adc6
BLAKE2b-256 c7c2959f740197e59f2ae3cf9e93422a61bfbb3216317bb9d95a8768c3b4af0a

See more details on using hashes here.

File details

Details for the file flask_url_mapping-0.6-py2.py3-none-any.whl.

File metadata

  • Download URL: flask_url_mapping-0.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.1.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for flask_url_mapping-0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 82f5a16b2a2333563117cbe99a3210b19167a69da1b013fed76b1ea6961a422f
MD5 23c334d7d27b8cd0ac0fc091a631d5d2
BLAKE2b-256 dd2098d98539466783af8ee41882819a43850653f9e8a65c5ebbf2d5a964fe2e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page