Files
deb-python-django-compressor/docs/installation.txt
Jaap Roes b6d5131611 Created new parser, HtmlParser, based on the stdlib HTMLParser module.
Added AutoSelectParser, picks LxmlParser if lxml is available, falls back to HtmlParser if not, also the new default.
Created a special BeautifulSoupTest in order to still test this parser.
Updated README, installation and settings docs to reflect these changes.
2011-04-20 12:01:33 +02:00

65 lines
1.7 KiB
Plaintext

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 :ref:`settings` to modify Django Compressor's
default behaviour and make adjustements for your website.
* In case you use Django 1.3's staticfiles_ contrib app (or its standalone
counterpart django-staticfiles_) you have to add Django Compressor's file
finder to the ``STATICFILES_FINDERS`` setting, for example with
``django.contrib.staticfiles``::
STATICFILES_FINDERS = (
'django.contrib.staticfiles.finders.FileSystemFinder',
'django.contrib.staticfiles.finders.AppDirectoriesFinder',
# other finders..
'compressor.finders.CompressorFinder',
)
.. _staticfiles: http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/
.. _django-staticfiles: http://pypi.python.org/pypi/django-staticfiles
.. _dependencies:
Dependencies
------------
BeautifulSoup_ (optional)
^^^^^^^^^^^^^^^^^^^^^^^^^
for the :ref:`parser <compress_parser>`
``compressor.parser.BeautifulSoupParser``::
pip install BeautifulSoup
lxml_ (optional)
^^^^^^^^^^^^^^^^
for the :ref:`parser <compress_parser>` ``compressor.parser.LxmlParser``,
also requires libxml2_::
STATIC_DEPS=true pip install lxml
html5lib_ (optional)
^^^^^^^^^^^^^^^^^^^^
for the :ref:`parser <compress_parser>` ``compressor.parser.Html5LibParser``::
pip install html5lib
.. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
.. _lxml: http://codespeak.net/lxml/
.. _libxml2: http://xmlsoft.org/
.. _html5lib: http://code.google.com/p/html5lib/