Table/data-grid framework for Django
Project description
django-tables2 - An app for creating HTML tables
================================================
|Build status|
django-tables2 simplifies the task of turning sets of data into HTML
tables. It has native support for pagination and sorting. It does for
HTML tables what ``django.forms`` does for HTML forms. e.g.
.. figure:: http://dl.dropbox.com/u/33499139/django-tables2/example.png
:alt: An example table rendered using django-tables2
An example table rendered using django-tables2
Its features include:
- Any iterable can be a data-source, but special support for Django
querysets is included.
- The builtin UI does not rely on JavaScript.
- Support for automatic table generation based on a Django model.
- Supports custom column functionality via subclassing.
- Pagination.
- Column based table sorting.
- Template tag to enable trivial rendering to HTML.
- Generic view mixin.
Example
=======
Creating a table for a model ``Simple`` is as simple as:
.. code:: python
import django_tables2 as tables
class SimpleTable(tables.Table):
class Meta:
model = Simple
This would then be used in a view:
.. code:: python
def simple_list(request):
queryset = Simple.objects.all()
table = SimpleTable(queryset)
return render_to_response("simple_list.html", {"table": table},
context_instance=RequestContext(request))
And finally in the template:
::
{% load django_tables2 %}
{% render_table table %}
This example shows one of the simplest cases, but django-tables2 can do
a lot more! Check out the
`documentation <http://django-tables2.readthedocs.org/en/latest/>`__ for
more details.
Building the documentation
==========================
If you want to build the docs from within a virtualenv, and Sphinx is
installed globally, use:
::
make html SPHINXBUILD="python $(which sphinx-build)"
Publishing a release
====================
1. Bump the version in ``django-tables2/__init__.py``.
2. Update ``CHANGELOG.md``.
3. Create a tag ``git tag -a v1.0.6 -m 'tagging v1.0.6'``
4. Run
``python setup.py sdist upload --sign --identity=<your gpg identity>``.
.. |Build status| image:: https://travis-ci.org/bradleyayers/django-tables2.svg
:target: https://travis-ci.org/bradleyayers/django-tables2
================================================
|Build status|
django-tables2 simplifies the task of turning sets of data into HTML
tables. It has native support for pagination and sorting. It does for
HTML tables what ``django.forms`` does for HTML forms. e.g.
.. figure:: http://dl.dropbox.com/u/33499139/django-tables2/example.png
:alt: An example table rendered using django-tables2
An example table rendered using django-tables2
Its features include:
- Any iterable can be a data-source, but special support for Django
querysets is included.
- The builtin UI does not rely on JavaScript.
- Support for automatic table generation based on a Django model.
- Supports custom column functionality via subclassing.
- Pagination.
- Column based table sorting.
- Template tag to enable trivial rendering to HTML.
- Generic view mixin.
Example
=======
Creating a table for a model ``Simple`` is as simple as:
.. code:: python
import django_tables2 as tables
class SimpleTable(tables.Table):
class Meta:
model = Simple
This would then be used in a view:
.. code:: python
def simple_list(request):
queryset = Simple.objects.all()
table = SimpleTable(queryset)
return render_to_response("simple_list.html", {"table": table},
context_instance=RequestContext(request))
And finally in the template:
::
{% load django_tables2 %}
{% render_table table %}
This example shows one of the simplest cases, but django-tables2 can do
a lot more! Check out the
`documentation <http://django-tables2.readthedocs.org/en/latest/>`__ for
more details.
Building the documentation
==========================
If you want to build the docs from within a virtualenv, and Sphinx is
installed globally, use:
::
make html SPHINXBUILD="python $(which sphinx-build)"
Publishing a release
====================
1. Bump the version in ``django-tables2/__init__.py``.
2. Update ``CHANGELOG.md``.
3. Create a tag ``git tag -a v1.0.6 -m 'tagging v1.0.6'``
4. Run
``python setup.py sdist upload --sign --identity=<your gpg identity>``.
.. |Build status| image:: https://travis-ci.org/bradleyayers/django-tables2.svg
:target: https://travis-ci.org/bradleyayers/django-tables2
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-tables2-1.1.0.tar.gz
(966.1 kB
view details)
File details
Details for the file django-tables2-1.1.0.tar.gz.
File metadata
- Download URL: django-tables2-1.1.0.tar.gz
- Upload date:
- Size: 966.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 46bdcae04087a20911dc10e30383743bca464696448e9351424efe2582a90499 |
|
| MD5 | 296be24b9af3152e0689cc4e7e2c2e96 |
|
| BLAKE2b-256 | 0bc4c97099241bd950429ea20094dc368786cdbe22fa35ff62e299e146d4c4a6 |
