Flask extension that applies common configurationsto all of webteam's flask apps.
Project description
Canonical Webteam Flask-Base
Flask extension that applies common configurations to all of webteam's flask apps.
Usage
from canonicalwebteam.flask_base.app import FlaskBase
app = FlaskBase(__name__, "app.name")
Or:
from canonicalwebteam.flask_base.app import FlaskBase
app = FlaskBase(
__name__,
"app.name",
template_404="404.html",
template_500="500.html",
favicon_url="/static/favicon.ico",
)
Local development
For local development, it's best to test this module with one of our website projects like ubuntu.com. For more information, follow this guide (internal only).
Features
Redirects and deleted paths
FlaskBase uses yaml-responses to allow easy configuration of redirects and return of deleted responses, by creating redirects.yaml, permanent-redirects.yaml and deleted.yaml in the site root directory.
Error templates
FlaskBase can optionally use templates to generate the 404 and 500 error responses:
app = FlaskBase(
__name__,
"app.name",
template_404="404.html",
template_500="500.html",
)
This will lead to e.g. http://localhost/non-existent-path returning a 404 status with the contents of templates/404.html.
Redirect /favicon.ico
FlaskBase can optionally provide redirects for the commonly queried paths /favicon.ico, /robots.txt and /humans.txt to sensible locations:
from canonicalwebteam.flask_base.app import FlaskBase
app = FlaskBase(
__name__,
"app.name",
template_404="404.html",
template_500="500.html",
favicon_url="/static/favicon.ico",
robots_url="/static/robots.txt",
humans_url="/static/humans.txt"
)
This will lead to e.g. http://localhost/favicon.ico returning a 302 redirect to http://localhost/static/favicon.ico.
Jinja2 helpers
You get two jinja2 helpers to use in your templates from flask-base:
nowis a function that outputs the current date in the passed format -{{ now('%Y') }}->YYYYversioned_staticis a function that fingerprints the passed asset -{{ versioned_static('asset.js') }}->static/asset?v=asset-hash
robots.txt and humans.txt
If you create a robots.txt or humans.txt in the root of your project, these will be served at /robots.txt and /humans.txt respectively.
Tests
To run the tests execute SECRET_KEY=fake python3 -m unittest discover tests.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file canonicalwebteam.flask-base-1.1.0.tar.gz.
File metadata
- Download URL: canonicalwebteam.flask-base-1.1.0.tar.gz
- Upload date:
- Size: 10.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d2d5eea7d4a417b7f8a2cb0348c21213995eca5600cdc7eeedf04f5f76839fa8 |
|
| MD5 | 638c6220775085c2a6366da74694063b |
|
| BLAKE2b-256 | d3396dcc68feae1e05149bb3f9a5a2cd0158e72b0419a0299a24c92fb9bf0b6e |
File details
Details for the file canonicalwebteam.flask_base-1.1.0-py3-none-any.whl.
File metadata
- Download URL: canonicalwebteam.flask_base-1.1.0-py3-none-any.whl
- Upload date:
- Size: 10.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cca0802527b1b1b79fd96b0f7f2b53637e78b155416f2003a0a9464c8e5cce6b |
|
| MD5 | 11bb3ad21a7e528b07aa31cb6beeddbf |
|
| BLAKE2b-256 | 6c7c292656ea0e8d716ce417e2394d7a3d02147bfe09ab5950bca296b4326734 |
