softwarefabrica.django.utils 1.0dev-BZR-r99-panta-elasticworld.org-20091108103118-d0qlvtj52q236au0

Utility module for SoftwareFabrica django projects

.. _topics-overview:

============================
Softwarefabrica Django Utils
============================

.. admonition:: About this document

This document provides an overview of what Softwarefabrica Django Utils is.

.. contents::
:depth: 3

What is this?
=============

This is a library that provides many useful routines and abstractions for
applications developed with the `Django`_ web framework.

Your help and feedback is precious. Suggestions and contributions are very much
appreciated. See below on how you can contribute.

If you want to actively collaborate and provide code, documentation, tests or
bug fixes, please feel free to create a new Bazaar branch in Launchpad, and tell
us about it! See the collaboration_ section for more information.

And don't forget to check also our other `Django`_ applications,
`softwarefabrica.django.forms`_, `softwarefabrica.django.crud`_, and
`softwarefabrica.django.wiki`_.

.. _`Django`: http://www.djangoproject.com
.. _`softwarefabrica.django.utils`: http://pypi.python.org/pypi/softwarefabrica.django.utils
.. _`softwarefabrica.django.forms`: http://pypi.python.org/pypi/softwarefabrica.django.forms
.. _`softwarefabrica.django.crud`: http://pypi.python.org/pypi/softwarefabrica.django.crud
.. _`softwarefabrica.django.wiki`: http://pypi.python.org/pypi/softwarefabrica.django.wiki
.. _`sflib`: http://pypi.python.org/pypi/sflib

Feature overview
----------------

- an handy `UUID`_ Django database field (``UUIDField``)
- a simple search functionality to search inside the application database
- views helper functions (to automatically populate template context with usuful
information, a ``render_to_response`` using a ``RequestContext``, ...)

.. _`UUID`: http://en.wikipedia.org/wiki/UUID
.. _`Markdown`: http://daringfireball.net/projects/markdown/syntax
.. _`Django`: http://www.djangoproject.com
.. _`forms library`: http://docs.djangoproject.com/en/dev/topics/forms/

Pre-requisites and installation
===============================

See the `installation guide document`_.

.. _`installation guide document`: install.html

.. _collaboration:

How can I contribute?
=====================

As said, your help is precious. We'll warmly appreciate any help you'll want to
give. Just using this library is a reward for us, but if you want to become more
actively involved, you are welcome!

The project has a `development home page`_ at `LaunchPad`_:

https://launchpad.net/sf-django-utils

There you can file `bugs`_, suggest `enhancements`_, follow development or ask
to become an active `team`_ member.

You can checkout the development branch using `Bazaar`_:

::

bzr branch lp:sf-django-utils

We'll appreciate very much if you'll want to contribute back any changes. Just
register your branch with `LaunchPad`_ and tell us!

Source code can also be browsed `online`_.

.. _`development home page`: https://launchpad.net/sf-django-utils
.. _`LaunchPad`: http://launchpad.net
.. _`Bazaar`: http://bazaar-vcs.org/
.. _`online`: http://bazaar.launchpad.net/~softwarefabrica/sf-django-utils/trunk/changes
.. _`Softwarefabrica`: https://edge.launchpad.net/softwarefabrica
.. _`team`: https://launchpad.net/~softwarefabrica
.. _`bugs`: https://bugs.launchpad.net/sf-django-utils
.. _`enhancements`: https://bugs.launchpad.net/sf-django-utils


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

2009-11-08 Marco Pantaleoni <[e-mail]>

* added sf_display_profile command.

* added runners.py - useful test runners.

* added tracequeries.py, providing a means to intercept SQL query
execution (and optionally perform logging).

2009-10-21 Marco Pantaleoni <[e-mail]>

* integrated sflib.finddata.find_package_data() in setup.py

2009-10-19 Marco Pantaleoni <[e-mail]>

* removed legacy stuff dependencies from paginator template-tag template.

2009-10-12 Marco Pantaleoni <[e-mail]>

* Added softwarefabrica.django.basicauth to support HTTP Basic Auth in
Django projects (from snippet 243: http://www.djangosnippets.org/snippets/243/)

2009-10-07 Marco Pantaleoni <[e-mail]>

* paginator template tag: now preserves the query string, if present.
So the paginator now works in list views with search forms.

2009-09-24 Marco Pantaleoni <[e-mail]>

* paginator template tag: modernized, now uses only the django
Paginator object.

2009-05-27 Marco Pantaleoni <[e-mail]>

* SyntheticUploadedFile.py: added (support for programmatically added files
in FileField and ImageField fields).

2009-05-16 Marco Pantaleoni <[e-mail]>

* djangothreads.py: added (support for django thread joining).

2009-05-12 Marco Pantaleoni <[e-mail]>

* added expr template tag and filter library (with comparison filters and
the ``expr`` template tag).

2009-04-20 Marco Pantaleoni <[e-mail]>

* middleware.logger: added get_logger() function.

2009-04-20 Marco Pantaleoni <[e-mail]>

* added useful middleware classes (under softwarefabrica.django.utils.middleware)
Right now the following are available: logger.LoggingMiddleware,
sqldebug.SqlDebugMiddleware, profile.ProfileMiddleware, stats.StatsMiddleware.

2009-04-15 Marco Pantaleoni <[e-mail]>

* fixed a bug in new render_to_response.

2009-04-14 Marco Pantaleoni <[e-mail]>

* added compiled template caching support.

2009-02-20 Marco Pantaleoni <[e-mail]>

* softwarefabrica/django/utils/templatetags/macros.py: added (django
snippet nr. 363, see http://www.djangosnippets.org/snippets/363/)

2009-02-19 Marco Pantaleoni <[e-mail]>

* softwarefabrica/django/utils/IPv4MaskedAddressField.py: handled the u'' case
in validation.

2009-01-29 Marco Pantaleoni <[e-mail]>

* softwarefabrica/django/utils/templatetags/forward_query_param.py: added.
Provides the ``forward_query_param`` template tag.

2009-01-21 Marco Pantaleoni <[e-mail]>

* softwarefabrica/django/utils/templatetags/in_list.py: added.

2009-01-15 Marco Pantaleoni <[e-mail]>

* managers.py: added. Provides the ``QuerySetManager`` described in
http://simonwillison.net/2008/May/1/orm/

2009-01-10 Marco Pantaleoni <[e-mail]>

* paginator.py paginator.html: now correctly handles pagination in
popup windows (``is_popup`` and ``_popup`` variables, from s.d.crud
generic views).

2008-12-22 Marco Pantaleoni <[e-mail]>

* IPv4MaskedAddressField can now be used with django admin too.

* added a test module.

* IPv4MaskedAddressField.py: added. This module provides model and form
fields for IPv4 addresses with an optional network mask.

2008-12-19 Marco Pantaleoni <[e-mail]>

* added doc bundle generation.

* docs/install.txt: improved installation instructions.

2008-12-18 Marco Pantaleoni <[e-mail]>

* Makefile: updated to build for all supported python versions
(2.4, 2.5, 2.6)
Fixed.

* added extensive documentation.

2008-12-17 Marco Pantaleoni <[e-mail]>

* setup.py: Added specific ('uuid') dependency for Python 2.4

2008-12-16 Marco Pantaleoni <[e-mail]>

* Removed obsolete material.

2008-12-01 Marco Pantaleoni <[e-mail]>

* softwarefabrica/django/utils/templatetags/paginator.py: template
is now 'utils/paginator.html'

* softwarefabrica/django/utils/templates/utils/paginator.html:
added.

2008-11-25 Marco Pantaleoni <[e-mail]>

* softwarefabrica/django/utils/templatetags/sitevars.py
(SitevarsNode.render): made Django `Site` framework optional.

* softwarefabrica/django/utils/viewshelpers.py (context_vars):
made Django `Site` framework optional.

* setup.py: set zip_safe to False (since we include templates and tests).

2008-11-24 Marco Pantaleoni <[e-mail]>

* Removed unused empty tests. Updated datetimewidget.py and
relatedwidget.py

* Changed references to 'newforms' into 'forms'.

* README.txt: Updated.

* Integrated setuptools and packages as
'softwarefabrica.django.utils'

2008-11-02 Marco Pantaleoni <[e-mail]>

* templatetags/sitevars.py: added - {% sitevars %} template
tag that populates the context with project variables.

2008-10-29 Marco Pantaleoni <[e-mail]>

* crud.py: added - Object-Oriented generic views and respective
functional support adapters. Also present classes that add
'fieldorder' support to ModelForms and templated forms.

2008-10-25 Marco Pantaleoni <[e-mail]>

* usearch.py: added - super-simple search support.

2008-10-19 Marco Pantaleoni <[e-mail]>

* UUIDField.py: added - UUID field.

2008-10-27 Marco Pantaleoni <[e-mail]>

* templatetags/paginator.py: modernized and added
'template_object_name' parameter (defaults to 'object').

2008-09-04 Marco Pantaleoni <[e-mail]>

* viewshelpers.py: modernized, removed functional generic views.

2008-09-02 Marco Pantaleoni <[e-mail]>

* forms.py mlforms.py: modernized (adapted to support also django-1.0)

2008-05-30 Marco Pantaleoni <[e-mail]>

* added DateRangeWidget and DateRangeField.

2008-05-29 Marco Pantaleoni <[e-mail]>

* added white space in id field (edit form), to separate it when no
value is present.

2008-05-27 Marco Pantaleoni <[e-mail]>

* added (non-editable) 'id' support to table forms.

2008-05-26 Marco Pantaleoni <[e-mail]>

* changed date format to 'dd/mm/yyyy'

* removed '--' in empty FK also from detail view

2008-05-22 Marco Pantaleoni <[e-mail]>

* removed "--" from empty related widgets.

2008-05-21 Marco Pantaleoni <[e-mail]>

* added missing classes 'value' and 'label'.

* fixed (commented) formfield_search_cb().

* relatedwidget.py: improved. Added support for creation.

* relatedwidget.py foreign.html: added support for textual representation
of selected records.

* tableforms.py: now uses the functions copied to erp.forms

2008-05-20 Marco Pantaleoni <[e-mail]>

* datetimewidget.py: added mark_safe() calls.

2008-05-15 Marco Pantaleoni <[e-mail]>

* tableforms.py: fixed bug ('coldwidth' -> 'colwidth', for FormRow).

2008-05-14 Marco Pantaleoni <[e-mail]>

* tableforms.py (FormField_operator_get_HTML_entity.Perform):
removed TD in error list.

* tableforms.py (FormField_operator_get_HTML_entity.Perform): adds
'label' and 'value' to fields.

* datetimewidget.py: switched from <nobr> to CSS.

* tableforms.py
(FormField_operator_get_view_HTML_entity.Perform): translated db
choice in text form in detail view.

* tableforms.py (FormField_operator_get_view_HTML_entity.Perform):
return icon in detail view for boolean fields.

* tableforms.py: defaulted to italian date format.

* datetimewidget.py: defaulted to italian date format.

* datetimewidget.py: added 'date' css attribute to widget.

2008-05-13 Marco Pantaleoni <[e-mail]>

* tableforms.py: adapted for split in DateTimeWidget and
DateWidget.

* forms.py: adapted for split in DateTimeWidget and DateWidget.

* datetimewidget.py: split in DateTimeWidget and DateWidget.

* templates/utils/widget/foreign.html: removed 'folder' icon
(detail view).

* tableforms.py (formfield_cb) relatedwidget.py: fixed required
field bug for "ForeignKey"s.

* viewshelpers.py: Added translation to messages.

2008-05-06 Marco Pantaleoni <[e-mail]>

* tableforms.py (build_query_from_form): fixed bug: now handles
also missing fields in form_data and searches with related fields
(RelatedField).

2008-04-28 Marco Pantaleoni <[e-mail]>

* relatedwidget.py (RelatedItemWidget.value_from_datadict): fixed
validation bug.

* tableforms.py: return link to detail view for foreign keys in detail
view "form".

2008-04-27 Marco Pantaleoni <[e-mail]>

* tableforms.py: boolean fields are rendered with a 3-way select in
search forms.

* tableforms.py (FormField_operator_get_HTML_entity.Perform): fixed
ForeignKey label extraction.

2008-04-26 Marco Pantaleoni <[e-mail]>

* added 'model' and 'meta' to delete_object() and edit_object() template
context.

2008-04-26 Marco Pantaleoni <[e-mail]>

* tableforms.py: renamed getElementName() into getElementTypeName(), and
getElementsByName() into getElementsByTypeName().
Added getElementName() returning the passed 'name' parameter value, if
present.
Added getElementsByName() and getElementByName().
Added 'name' paremeter query in getElements().

* templates/utils/widget/foreign.html: added <span></span> and
<nobr></nobr>.

2008-04-25 Marco Pantaleoni <[e-mail]>

* tableforms.py: added some DOM navigation functions.
Added fields (FormField, django field, db field) extraction functions.
Now django forms are created with only the fields present in tableforms
Form (passing 'fields').

2008-04-22 Marco Pantaleoni <[e-mail]>

* tableforms.py: now emits toggleFormGroup().

2008-04-22 Marco Pantaleoni <[e-mail]>

* tableforms.py (Form.make_formclass): moved formclass creation out of
the constructor, so to allow late injection of a different form metaclass.

* tableforms.py: added build_query_from_form() to Form class.
Now it's also possible to pass the (newforms) form metaclass to the Form
constructor. A SearchModelFormTable metaclass has been added to be used
when making search forms (it keeps all fields as optional).

* viewshelpers.py: updated object_list() generic view to match
recent django.

2008-04-21 Marco Pantaleoni <[e-mail]>

* viewshelpers.py: fixed opts.verbose_name proxy string issue
(forcing unicode).
Made more uniform template search.
Added object_detail() generic view.
Improved comments.

* tableforms.py: added get_view_HTML_entity operation for detail views.

* relatedwidget.py: removed unused select_btn and new_btn strings.

2008-04-19 Marco Pantaleoni <[e-mail]>

* templates/: added.

* tableforms.py: integrated support for foreign key fields
(relatedwidget).

* relatedwidget.py: added.

* viewshelpers.py: added static_media_images_prefix() and
static_media_js_prefix().

2008-04-06 Marco Pantaleoni <[e-mail]>

* tableforms.py: added multiple generation operation backends
(get_HTML_entity, get_pages_HTML_entity, get_page_ids).
Small improvements. Added support to form group javascript.

2008-04-05 Marco Pantaleoni <[e-mail]>

* templatetags/paginator.py templatetags/urlsave.py: added.

* tableforms.py: implemented visitor pattern based generation of
HTML content.

* viewshelpers.py: added object_list() (based on django generic
view).

2008-04-02 Marco Pantaleoni <[e-mail]>

* tableforms.py: Added.

2008-02-17 Marco Pantaleoni <[e-mail]>

* newforms_crud.py (create_object, update_object): added the
possibility of passing initial values to forms in form_for_model()
and form_for_instance().

* viewshelpers.py: settings.STATIC_MEDIA_PREFIX is not strictly
required anymore. The static_media_prefix() function tries to
determine the correct value, with a sensible fallback.

2007-11-22 Marco Pantaleoni <[e-mail]>

* Created (with bits from portal, a lot of bits...)