Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whs/django-static-compress
Precompress your Django static files
https://github.com/whs/django-static-compress
brotli django zopfli
Last synced: 3 days ago
JSON representation
Precompress your Django static files
- Host: GitHub
- URL: https://github.com/whs/django-static-compress
- Owner: whs
- License: mit
- Created: 2017-07-15T18:38:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-01T22:48:54.000Z (21 days ago)
- Last Synced: 2024-12-01T23:30:04.766Z (21 days ago)
- Topics: brotli, django, zopfli
- Language: Python
- Size: 49.8 KB
- Stars: 9
- Watchers: 3
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Django-static-compress
[](LICENSE)
[](https://travis-ci.org/whs/django-static-compress)
[](https://pypi.python.org/pypi/django-static-compress)
[](http://unmaintained.tech/)
Precompress your static files automatically with [Brotli](https://github.com/google/brotli) and [Zopfli](https://github.com/obp/zopfli)
## Installation
Install this from pip:
```sh
$ pip install django-static-compress
```
(you may want to write this in your requirements.txt)
Then update your settings.py:
```py
STATICFILES_STORAGE = 'static_compress.CompressedStaticFilesStorage'
```
When you run `python manage.py collectstatic` it will have an additional post-processing pass to compress your static files.
Make sure that your web server is configured to serve precompressed static files:
- If using nginx:
- Setup [ngx_http_gzip_static_module](https://nginx.org/en/docs/http/ngx_http_gzip_static_module.html) to serve gzip (.gz) precompressed files.
- Out of tree module [ngx_brotli](https://github.com/google/ngx_brotli) is required to serve Brotli (.br) precompressed files.
- [Caddy](https://caddyserver.com) will serve .gz and .br without additional configuration.
Also, as Brotli is not supported by all browsers you should make sure that your reverse proxy/CDN honor the Vary header, and your web server set it to [`Vary: Accept-Encoding`](https://blog.stackpath.com/accept-encoding-vary-important).
## Available storages
- `static_compress.CompressedStaticFilesStorage`: Generate `.br` and `.gz` from your static files
- `static_compress.CompressedManifestStaticFilesStorage`: Like [`ManifestStaticFilesStorage`](https://docs.djangoproject.com/en/1.11/ref/contrib/staticfiles/#manifeststaticfilesstorage), but also generate compressed files for the hashed files
You can also add support to your own backend by applying `static_compress.CompressMixin` to your class.
By default it will only compress files ending with `.js`, `.css` and `.svg`. This is controlled by the settings below.
## Settings
_django-static-compress_ settings and their default values:
```py
STATIC_COMPRESS_FILE_EXTS = ['js', 'css', 'svg']
STATIC_COMPRESS_METHODS = ['gz', 'br']
STATIC_COMPRESS_KEEP_ORIGINAL = True
STATIC_COMPRESS_MIN_SIZE_KB = 30
```
After compressing the static files, _django-static-compress_ still leaves the original files in _STATIC_ROOT_ folder. If you want to delete (to save disk space), change `STATIC_COMPRESS_KEEP_ORIGINAL` to `False`.
If the file is too small, it isn't worth compressing. You can change the minimum size in KiB at which file should be compressed, by changing `STATIC_COMPRESS_MIN_SIZE_KB`.
By default, _django-static-compress_ use Zopfli to compress to gzip. Zopfli compress better than gzip, but will take more time to compress. If you want to create gzip file with built-in zlib compressor, replace `'gz'` with `'gz+zlib'` in `STATIC_COMPRESS_METHODS`.
## File size reduction
Here's some statistics from [TipMe](https://tipme.in.th)'s jQuery and React bundle. Both bundle have related plugins built in with webpack (eg. Bootstrap for jQuery bundle, and [classnames](https://github.com/JedWatson/classnames) for React bundle), and is already minified.
```
101K jquery.9aa33728c6b5.js
33K jquery.9aa33728c6b5.js.gz (33%)
31K jquery.9aa33728c6b5.js.br (31%)
174K react.5c4899aeda53.js
51K react.5c4899aeda53.js.gz (29%)
44K react.5c4899aeda53.js.br (25%)
```
(.gz is Zopfli compressed, and .br is Brotli compressed)
## Developing
This project is [unmaintained](http://unmaintained.tech/). You may use it, but issues and pull requests might be ignored.
1. Run `python setup.py develop`
2. Run `pip install -r requirements-dev.txt && pre-commit install`
3. Start hacking
4. Run test: `python setup.py test`
5. Run integration test: `cd integration_test; python manage.py test`
6. Commit. Pre-commit will warn if you have any changes.
## License
Licensed under the [MIT License](LICENSE)