Using ServeStatic with WSGI apps¶

To enable ServeStatic on an existing WSGI application, wrap it in a ServeStatic instance and tell it where to find your static files. For example:

1
2
3
4
5
6
7

from servestatic import ServeStatic

from example_framework import ExampleApp

wsgi_app = ExampleApp()
wsgi_app = ServeStatic(wsgi_app, root="/path/to/static/files")
wsgi_app.add_files("/path/to/more/static/files", prefix="more-files/")

Alternatively, you can use ServeStatic as a standalone file server by not providing a WSGI app. For example:

wsgi_app = ServeStatic(application=None, root="/path/to/static/files")

On initialization, ServeStatic walks over all the files in the directories that have been added (descending into sub-directories) and builds a list of available static files. Any requests which match a static file get served by ServeStatic, all others are passed through to the original application.

After configuring ServeStatic, you can use your favourite WSGI server (such as gunicorn or waitress) to run your application.

gunicorn my_project:wsgi_app

See the API reference documentation for detailed usage and features.