softwarefabrica.django.forms 0.9dev-BZR-r9-panta-elasticworld.org-20081216120255-bfxtvm59se53cu9k

softwarefabrica.django.forms library
====================================

A forms library for `Django`_ projects, which aims at providing increased
functionality and flexibility to the standard `forms library`_.

Please see the documentation for more information and examples.

Don't forget to check also our other `Django`_ applications,
``softwarefabrica.django.utils``, and ``softwarefabrica.django.forms``.

Happy coding!

.. _`Django`: http://www.djangoproject.com
.. _`forms library`: http://docs.djangoproject.com/en/dev/topics/forms/


*Marco Pantaleoni*

.. contents::

PRE-REQUISITES
--------------

This library depends on `softwarefabrica.django.utils` from the same
author.
If you use the EasyInstall_ outlined below, dependencies will be satisfied
automatically (the ``easy_install`` will take care of everything).
There are no dependencies right now, except for Django itself.

INSTALLATION
------------

You can download and install the most up-to-date version in one step
using EasyInstall_. For example, on a unix-like system:

::

$ su
# easy_install softwarefabrica.django.forms

If you are using Ubuntu, to install system-wide:

::

$ sudo easy_install softwarefabrica.django.forms

Otherwise you can just download the source package (eg. from PyPI_),
extract it and run the usual ``setup.py`` commands:

::

$ su
# python setup.py install

Then you can use the library in any django project by simple including it in the
``INSTALLED_APPS`` settings variable, as outlined below.

.. _EasyInstall: http://peak.telecommunity.com/DevCenter/EasyInstall
.. _PyPI: http://pypi.python.org/pypi

DOWNLOAD
--------

If you don't want or cannot install using EasyInstall_, download the
package from Cheese Shop:

http://cheeseshop.python.org/pypi/softwarefabrica.django.forms/

In a future, it will be possible to download also from:

http://www.softwarefabrica.org/projects/softwarefabrica.django.forms//

Using the forms library in your applications
--------------------------------------------

Once you've installed the library and want to use it in your Django
applications, simply put ``'softwarefabrica.django.forms'`` in your
``INSTALLED_APPS`` setting.

Since there are no associated models, a ``manage.py syncdb`` command is not
necessary.

That's it!

DOCUMENTATION
-------------

Documentation is included in the form of *docstrings*, inside the library source
code.

For some advanced examples, please see also the included automatic tests.

TESTING
-------

The library includes automatic tests.
To run the tests, do:

::

$ export DJANGO_SETTINGS_MODULE=softwarefabrica.django.forms.tests.settings
$ django-admin.py test

CONTACTS
--------

It's possible to contact the author by e-mail at the following addresses:

m.pantaleoni at softwarefabrica.org

panta at elasticworld.org

marco.pantaleoni at gmail.com


LICENSE
-------

This software is covered by the GNU General Public License version 2.
If you want to use this software in a closed source application, you
need to buy a commercial license from the author.

This open source version is:

Copyright (C) 2007-2008 Marco Pantaleoni. All rights reserved.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


CHANGES
-------

2008-12-16 Marco Pantaleoni <panta@elasticworld.org>

* softwarefabrica/django/forms/extended.py
(extended_formfield_cb): 'required' is forced into fields kwargs,
because in some cases it's not honoured.

2008-12-01 Marco Pantaleoni <panta@elasticworld.org>

* bug fixes.

2008-11-27 Marco Pantaleoni <panta@elasticworld.org>

* Added RelatedItemField, SelectPopupField,
SelectMultiplePopupField fields and corresponding widgets
(RelatedItemWidget, SelectPopupWidget, SelectMultiplePopupWidget
widgets).

2008-11-25 Marco Pantaleoni <panta@elasticworld.org>

* Added extended fields and widgets. Modified form classes to use
new widgets.

* Fixes, added regression tests.

* Created.