django-primary-filters / INSTALL

django-primary-filters Installation Instructions

This section contains information about how to download and install
django-primary-filters in your system. It also contains brief instructions about how
to build the included documentation.


This application requires Python_ 2.4 or later and a functional installation
of Django_.

.. _Python:
.. _Django:

Detailed information about the minimum supported Django version and other
Python modules that may be required in order to run this software is shown

.. literalinclude:: ../requirements.txt

This information exists in the ``requirements.txt`` file inside the
django-primary-filters distribution package. If ``pip`` is used to install this software,
then all these dependencies will also be installed, if they are not already
installed in your system.


You can download the latest django-primary-filters releases from the `releases page`_ at
the *Python Package Index* (PyPI).

.. _`releases page`:

Alternatively, you can clone the project's public source code repository
and then check-out any stable release, all of which are tagged::

    hg clone
    hg tags
    hg update 0.1.0


To install django-primary-filters, use the provided installation script::

    python install

You can install ``django-primary-filters`` using ``pip``::

    pip install django-primary-filters

Or use ``easy_install``::

    easy_install -Z django-primary-filters

Note: the ``-Z`` flag is required to force ``easy_install`` to do a normal
source install rather than a zipped egg; django-primary-filters cannot be
used from a zipped egg install.

Alternatively, you can simply place the ``primary_filters`` directory,
which exists under the ``src`` directory, somewhere on your Python path
or symlink to it from somewhere on your Python path.

Finally, it is also possible to install this application directly from
the `source code repository`_ using ``pip``::

    pip install -e hg+

The above command will install the latest development release of

To install a stable release directly from the `source code repository`_,
for instance, the ``0.1.0`` release, run the following command::

    pip install -e hg+

Please note that the mercurial_ source control management tool is required
for this operation.

.. _mercurial:
.. _`source code repository`:

How to build the documentation

This project's documentation is located in source form under the ``docs``
directory. In order to convert the documentation to a format that is
easy to read and navigate you need the ``sphinx`` package.

You can install ``sphinx`` using ``pip``::

    pip install sphinx

Or ``easy_install``::

    easy_install sphinx

Once ``sphinx`` is installed, change to the ``docs`` directory, open a shell
and run the following command::

    make html

This will build a HTML version of the documentation. You can read the
documentation by opening the following file in any web browser::