Quickstart

Installation

• Install Django Compressor with your favorite Python package manager:

  pip install django_compressor
  

• Add 'compressor' to your INSTALLED_APPS setting:

  INSTALLED_APPS = (
      # other apps
      "compressor",
  )
  

• See the list of Settings to modify Django Compressor’s default behaviour and make adjustments for your website.

• In case you use Django’s staticfiles contrib app you have to add Django Compressor’s file finder to the STATICFILES_FINDERS setting, like this:

  STATICFILES_FINDERS = (
      'django.contrib.staticfiles.finders.FileSystemFinder',
      'django.contrib.staticfiles.finders.AppDirectoriesFinder',
      # other finders..
      'compressor.finders.CompressorFinder',
  )
  

• Define COMPRESS_ROOT in settings if you don’t have already STATIC_ROOT or if you want it in a different folder.

Optional Dependencies

• BeautifulSoup

  For the parser compressor.parser.BeautifulSoupParser and compressor.parser.LxmlParser:

  pip install beautifulsoup4
  

• lxml

  For the parser compressor.parser.LxmlParser, also requires libxml2:

  STATIC_DEPS=true pip install lxml
  

• html5lib

  For the parser compressor.parser.Html5LibParser:

  pip install html5lib
  

• Calmjs

  For the Calmjs filter compressor.filters.jsmin.CalmjsFilter:

  pip install calmjs.parse
  

• csscompressor

  For the csscompressor filter compressor.filters.cssmin.CSSCompressorFilter:

  pip install csscompressor
  

• brotli

  For brotli file compressor compressor.storage.BrotliCompressorFileStorage:

  pip install brotli