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",
)
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:
now
is a function that outputs the current date in the passed format -{{ now('%Y') }}
->YYYY
versioned_static
is 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
.
Project details
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
Hashes for canonicalwebteam.flask-base-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8807678b75256c3e8b1c859251df953a1eb261b995eb88cbd0b3cea308d3f71 |
|
MD5 | 8a7aba00e885be3eb449b6d895acb5de |
|
BLAKE2b-256 | 2257510de8254cf392129b0c28be17eb9d94c92f5f5d273bc44578d8ceebc5c9 |
Hashes for canonicalwebteam.flask_base-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbb6e9f8a9e3b07c118341bce19624385c7184d1ef49bcd883f61b7ffc147971 |
|
MD5 | 74ac8bb0ed2fbc83b9be81fc2d52c3b0 |
|
BLAKE2b-256 | 421e25d1ee04a4fc2edd2c2ab882598e01bcb76c8dfbfac0145364164281b479 |