Skip to main content

Simple flask plugin to allow overriding static files

Project description

Author: Pierre-Yves Chibon <pingou@pingoured.fr>

This project is a simple flask plugin to add support for overriding static files.

Dependencies:

The dependency list is therefore:

Usage:

In your flask application:

import flask
from flask_multistatic import MultiStaticFlask

And replace the way you build you flask application from

APP = flask.Flask(__name__)

by

APP = MultiStaticFlask(__name__)

You can then specify multiple folder where static files are located, for example:

APP.static_folder = [
    os.path.join(APP.root_path, 'static', APP.config['THEME_FOLDER']),
    os.path.join(APP.root_path, 'static', 'default')
]

Note

The order of the folder is important, the last folder should be the one where most files are present, the other folders are where you override the static files. So in the example above, all the default static files are in /static/default/ and the files specific for one theme are under /static/<theme_name>/.

Production:

Note that this is most likely less efficient than having apache serve the static files itself, but even if you do that you might want to have multiple static directories and have apache fallback.

In this case, you can use the example.conf file that is shipped as part of this repository.

The example.conf file has an example configuration that will try to serve a file from an instance-specific theme directory, and only if the file was not found, fall back to the application default theme.

License:

This project is licensed GPLv3+.

Project details


Release history Release notifications

This version
History Node

1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
flask-multistatic-1.0.tar.gz (15.5 kB) Copy SHA256 hash SHA256 Source None Feb 11, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page