Skip to main content

A static files storage backend for compression using GZip and/or Brotli that inherits from Djangos ManifestFilesMixin and StaticFilesStorage; also minifies static files.

Project description

django-compress-staticfiles

A Django static files storage backend inheriting from ManifestFilesMixin and StaticFilesStorage. Compresses, using GZip and/or Brotli, and minifies static files when running the Django collectstatic command.

What this package does:

What this package does not do:

  • Does not support concatenation/bundling of JS or CSS.
  • Does not support transpiling from any transpiling Javascript language.
  • Does not support SASS, LESS or any other CSS preprocessor.
  • This package is not a linter or tester. The collectstatic command is not the place to be linting or testing your code. The primary purpose of this package is compressing staticfiles for use in staging or production environments — minification is optional but does so by default.
  • Does not delete stale files from your STATIC_ROOT directory. If changes were made to some of your static files; old files will remain there. Use the --clear flag when running collectstatic to delete the entire STATIC_ROOT and recreate it — check out the Django docs for more info.

Some important things to take note of:

  • If DEBUG = True in your Django settings.py file; only the normal file is used in templates. Templates will only use the hashed and minified version of the file when DEBUG = False. This is the behaviour of the Django staticfiles app in the url method of the ManifestFilesMixin.
  • The compressed version of the file is never used in the template. Your webserver can decide which version of the file to serve depending on the Accept-Encoding header in the request.
  • This package updates the manifest JSON file created by ManifestFilesMixin with a path pointing to the hashed and minified version of each processed file where applicable.
  • If there is a .min file to be copied to STATIC_ROOT; that file will be compressed but not re-minified. If that .min file has a corresponding non-minified counterpart, that non-minified file will be minified and that minified file is the one that will be used to map regular.css to regular.min.{hash}.css in the manifest file.
  • This package does not yet deal with the @import rule and url() function in CSS; therefore the value is not updated after ManifestFilesMixin handles those things — the minified file will not be referenced, only the hashed version as substituted by ManifestFilesMixin.
  • The original files, for example, somefile.css won't be compressed to somefile.css.gz because we will likely never use it.
  • Files smaller than 200 bytes will not be compressed.

Usage with cloud storage like Google Cloud Storage or Amazon S3:

Even though the CompressStaticFilesStorage inherits from StaticFilesStorage, which inherits from FileSystemStorage, the CompressStaticFilesMixin and MinifyFilesMixin can be used with your own storage.

Quickstart

Install the app and it's dependencies using:

pip install git+https://github.com/armandtvz/django-compress-staticfiles.git

Set the STATICFILES_STORAGE setting in your project settings.py as follows:

STATICFILES_STORAGE = 'compress_staticfiles.storage.CompressStaticFilesStorage'

You don't need to set any other settings for everything to work but for some mild customisation see the settings heading for more info.

Run the collectstatic command as you usually would:

python manage.py collectstatic

Settings

There's no need to set these settings as they have defaults — they're there if you want them. All are True by default.

# All are True by default.
MINIFY_STATIC = True
BROTLI_STATIC_COMPRESSION = True
GZIP_STATIC_COMPRESSION = True

Included filetypes for compression

Only files ending with these extensions will be compressed:

  • css
  • js
  • txt
  • xml
  • json
  • svg
  • md
  • rst

Included filetypes for minification

  • css
  • js

JS Minification

The rJSMin Python package is used for JavaScript minification. See rJSMin's Github repo for docs and more information. JS is not obfuscated. Exclamation/bang comments will be retained.

CSS Minification

Exclamation/bang comments will be retained.

There might be some questions

Why not just use django-compressor or django-pipeline instead?

Though I haven't used django-compressor or django-pipeline myself; I have gone through their respective documentation. I'm sure django-compressor and django-pipeline are excellent tools and I'm sure there's a time and place to be using them.

However, this package aims to be something smaller and simpler with absolutely no configuration needed; no template tags and no extra management commands. It aims to be unobtrusive; to slide straight into the regular Django `collectstatic' management command.

Why no bundling/concatenation of JS or CSS?

Bundling is so HTTP/1.1. Join us in HTTP/2 where things are multiplexed. :) Jokes aside... If you really need bundling: it's probably best to look at something like Webpack, django-compressor or django-pipeline.

Why does this package use the ManifestFilesMixin?

For those who are unfamiliar with the ManifestFilesMixin please read the Django docs for ManifestFilesMixin and ManifestStaticFilesStorage.

Compatiblity

  • Compatible with Python 3.5 and above.
  • Compatible with Django 1.10 and above. Do remember that, at the time of writing, Django 2.2 and below is deprecated and therefore there is only official support for Django 2.2 and above.
  • Check rJSMin's Github repo / docs for more info regarding ES6 compatibility.

Versioning

This project follows semantic versioning (SemVer).

License, code of conduct and requirements

Check the root of the repo for these files.

Project details


Download files

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

Files for django-compress-staticfiles, version 1.0.1b0
Filename, size File type Python version Upload date Hashes
Filename, size django_compress_staticfiles-1.0.1b0-py3-none-any.whl (28.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-compress-staticfiles-1.0.1b0.tar.gz (13.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page