1. Benoît Bryon
  2. django-formrenderingtools

Source

django-formrenderingtools / INSTALL

############
Installation
############

The code is published under the BSD license. See LICENSE for details.

If you just want to discover the application, have a look at the :doc:`/demo`.

*********************
Installation synopsis
*********************

* Check requirements
* Get the code
* Update project settings

************
Requirements
************

Notice that managing requirements is easier if you choose an automatic
installation procedure.

This application requires:

* `Django-1.3`_. The application targets the latest stable release of 
  branch 1.x. It may work with previous versions, but tests focus on the latest
  one.
* `django-templateaddons`_: a set of helpers for the template designer and
  template tag developer.

.. _`Django-1.3`: http://djangoproject.com/
.. _`django-templateaddons`: http://bitbucket.org/benoitbryon/django-templateaddons

************
Get the code
************

The code is published under the BSD license. See :doc:`LICENSE` for details.

Latest release
==============

This application is known as "django-formrenderingtools" on 
`Pypi <http://pypi.python.org/>`_. 

So you can install it with pip or easy_install. As an example::

  # pip install -U django-formrenderingtools

Obviously, you can also add it to your eggs list in a buildout configuration
file.

Development files
=================

You can use pip to automatically download and install the project with 
versionning::

  # pip install -U -e hg+http://bitbucket.org/benoitbryon/django-formrenderingtools#egg=djc.formrenderingtools

Manual installation
===================

Manual installation is not the recommended way: you'd better learn about
buildout or virtualenv+pip.

The main project page is http://bitbucket.org/benoitbryon/django-formrenderingtools.

You can clone the repository with the following command line:

.. code-block:: bash

  $ hg clone http://bitbucket.org/benoitbryon/django-formrenderingtools

Copy the django-formrenderingtools/djc folder somewhere in your PYTHON_PATH. It
may be in your project's directory.

***************
Update settings
***************

* add 'djc.formrenderingtools' to your INSTALLED_APPS