django-thumbnail-works / INSTALL

George Notaras 6be5718 

George Notaras eb984d7 



George Notaras 6be5718 


George Notaras eb984d7 

George Notaras a15e390 
George Notaras eb984d7 



George Notaras 6be5718 

George Notaras eb984d7 






George Notaras a15e390 

George Notaras 6be5718 


George Notaras eb984d7 
George Notaras 6be5718 
George Notaras eb984d7 

George Notaras 6be5718 
George Notaras eb984d7 



George Notaras 6be5718 


George Notaras eb984d7 
George Notaras 6be5718 


George Notaras eb984d7 


George Notaras 6be5718 


George Notaras eb984d7 
George Notaras 6be5718 


George Notaras eb984d7 
George Notaras 6be5718 
George Notaras eb984d7 






George Notaras a15e390 
George Notaras eb984d7 













































django-thumbnail-works Installation Instructions
========================================================================

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


Requirements
============

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

.. _Python: http://python.org
.. _Django: http://www.djangoproject.com

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

.. literalinclude:: ../requirements.txt

This information exists in the ``requirements.txt`` file inside the
django-thumbnail-works 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.


Download
========

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

.. _`project page`: http://pypi.python.org/pypi/django-thumbnail-works

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 https://source.codetrax.org/hgroot/django-thumbnail-works
    hg tags
    hg update 0.1.0


Install
=======

To install django-thumbnail-works, use the provided installation script::

    python setup.py install

You can install ``django-thumbnail-works`` using ``pip``::

    pip install django-thumbnail-works

Or use ``easy_install``::

    easy_install -Z django-thumbnail-works

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

Alternatively, you can simply place the ``thumbnail_works`` 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+https://source.codetrax.org/hgroot/django-thumbnail-works#egg=django-thumbnail-works

The above command will install the latest development release of
django-thumbnail-works.

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+https://source.codetrax.org/hgroot/django-thumbnail-works@0.1.0#egg=django-thumbnail-works-0.1.0

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

.. _mercurial: http://mercurial.selenic.com/
.. _`source code repository`: https://source.codetrax.org/hgroot/django-thumbnail-works


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::

    docs/_build/html/index.html
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.