https://github.com/evansd/whitenoise

Radically simplified static file serving for Python web apps
https://github.com/evansd/whitenoise

Last synced: 6 days ago
JSON representation

Radically simplified static file serving for Python web apps

• Host: GitHub
• URL: https://github.com/evansd/whitenoise
• Owner: evansd
• License: mit
• Created: 2013-08-08T11:02:06.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T21:02:48.000Z (6 months ago)
• Last Synced: 2024-05-01T12:54:34.623Z (6 months ago)
• Language: Python
• Homepage: https://whitenoise.readthedocs.io
• Size: 896 KB
• Stars: 2,437
• Watchers: 24
• Forks: 142
• Open Issues: 40
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

• awesome-starts - evansd/whitenoise - Radically simplified static file serving for Python web apps (others)
• best-of-web-python - GitHub - 15% open · ⏱️ 30.05.2024): (Servers)
• -awesome-django - whitenoise - Simplified static file serving for Python websites. (Python Packages / Views)
• django-awesome - x - Simplified static file serving for Python websites. (Release Features)
• awesome-django - whitenoise - Simplified static file serving for Python websites. (Third-Party Packages / Static Assets)
• starred-awesome - whitenoise - Radically simplified static file serving for Python web apps (Python)

README

        
==========

WhiteNoise

==========

.. image:: https://img.shields.io/readthedocs/whitenoise?style=for-the-badge

   :target: https://whitenoise.readthedocs.io/en/latest/

.. image:: https://img.shields.io/github/actions/workflow/status/evansd/whitenoise/main.yml.svg?branch=master&style=for-the-badge

   :target: https://github.com/evansd/whitenoise/actions?workflow=CI

.. image:: https://img.shields.io/badge/Coverage-96%25-success?style=for-the-badge

   :target: https://github.com/evansd/whitenoise/actions?workflow=CI

.. image:: https://img.shields.io/pypi/v/whitenoise.svg?style=for-the-badge

   :target: https://pypi.org/project/whitenoise/

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge

   :target: https://github.com/psf/black

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge

   :target: https://github.com/pre-commit/pre-commit

   :alt: pre-commit

**Radically simplified static file serving for Python web apps**

With a couple of lines of config WhiteNoise allows your web app to serve its

own static files, making it a self-contained unit that can be deployed anywhere

without relying on nginx, Amazon S3 or any other external service. (Especially

useful on Heroku, OpenShift and other PaaS providers.)

It's designed to work nicely with a CDN for high-traffic sites so you don't have to

sacrifice performance to benefit from simplicity.

WhiteNoise works with any WSGI-compatible app but has some special auto-configuration

features for Django.

WhiteNoise takes care of best-practices for you, for instance:

* Serving compressed content (gzip and Brotli formats, handling Accept-Encoding

  and Vary headers correctly)

* Setting far-future cache headers on content which won't change

Worried that serving static files with Python is horribly inefficient?

Still think you should be using Amazon S3? Have a look at the `Infrequently

Asked Questions`_.

To get started, see the documentation_.

.. _Infrequently Asked Questions: https://whitenoise.readthedocs.io/en/stable/#infrequently-asked-questions

.. _documentation: https://whitenoise.readthedocs.io/en/stable/