Skip to main content

Compresses linked and inline JavaScript or CSS into single cached files.

Project description

http://codecov.io/github/django-compressor/django-compressor/coverage.svg?branch=develop https://pypip.in/v/django_compressor/badge.svg https://pypip.in/d/django_compressor/badge.svg Build Status https://caniusepython3.com/project/django_compressor.svg

Django Compressor combines and compresses linked and inline Javascript or CSS in a Django template into cacheable static files by using the compress template tag.

HTML in between {% compress js/css %} and {% endcompress %} is parsed and searched for CSS or JS. These styles and scripts are subsequently processed with optional, configurable compilers and filters.

The default filter for CSS rewrites paths to static files to be absolute and adds a cache busting timestamp. For Javascript the default filter compresses it using jsmin.

As the final result the template tag outputs a <script> or <link> tag pointing to the optimized file. These files are stored inside a folder and given a unique name based on their content. Alternatively it can also return the resulting content to the original template directly.

Since the file name is dependent on the content these files can be given a far future expiration date without worrying about stale browser caches.

The concatenation and compressing process can also be jump started outside of the request/response cycle by using the Django management command manage.py compress.

Configurability & Extendibility

Django Compressor is highly configurable and extendible. The HTML parsing is done using lxml or if it’s not available Python’s built-in HTMLParser by default. As an alternative Django Compressor provides a BeautifulSoup and a html5lib based parser, as well as an abstract base class that makes it easy to write a custom parser.

Django Compressor also comes with built-in support for CSS Tidy, YUI CSS and JS compressor, yUglify CSS and JS compressor, the Google’s Closure Compiler, a Python port of Douglas Crockford’s JSmin, a Python port of the YUI CSS Compressor cssmin and a filter to convert (some) images into data URIs.

If your setup requires a different compressor or other post-processing tool it will be fairly easy to implement a custom filter. Simply extend from one of the available base classes.

More documentation about the usage and settings of Django Compressor can be found on django-compressor.readthedocs.org.

The source code for Django Compressor can be found and contributed to on github.com/django-compressor/django-compressor. There you can also file tickets.

The in-development version of Django Compressor can be installed with pip install http://github.com/django-compressor/django-compressor/tarball/develop.

Project details


Download files

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

Source Distribution

django_compressor-1.6.tar.gz (117.5 kB view details)

Uploaded Source

Built Distribution

django_compressor-1.6-py2.py3-none-any.whl (127.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django_compressor-1.6.tar.gz.

File metadata

File hashes

Hashes for django_compressor-1.6.tar.gz
Algorithm Hash digest
SHA256 33926c7754821baf2d68f7c972804c584b94c51db7e2e12f057dc68147619e4e
MD5 21aff524cc1b3fc50b44d4ef4846036e
BLAKE2b-256 dbefa330b8b398996a35a1ad0ad710f14b02c9ce80d65f58ba62f0fd4e2a7b1b

See more details on using hashes here.

Provenance

File details

Details for the file django_compressor-1.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_compressor-1.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d83a3a23613333f1b715d1276b540185bc1fcb6975d84edbffc597f9238d6659
MD5 7f2840e78a829cfc9ae10cf17b79d069
BLAKE2b-256 f1e588dabefa9eb0a892dd069bf45bb473afa20f2ebf03392f2b91da46b55cbb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page