Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/idlesign/django-sitetables

Reusable application for Django featuring DataTables integration
https://github.com/idlesign/django-sitetables

datatables django integration python python3

Last synced: 20 days ago
JSON representation

Reusable application for Django featuring DataTables integration

Awesome Lists containing this project

README

        

django-sitetables
=================
https://github.com/idlesign/django-sitetables

|release| |lic| |coverage|

.. |release| image:: https://img.shields.io/pypi/v/django-sitetables.svg
:target: https://pypi.python.org/pypi/django-sitetables

.. |lic| image:: https://img.shields.io/pypi/l/django-sitetables.svg
:target: https://pypi.python.org/pypi/django-sitetables

.. |coverage| image:: https://img.shields.io/coveralls/idlesign/django-sitetables/master.svg
:target: https://coveralls.io/r/idlesign/django-sitetables

Description
-----------

*Reusable application for Django featuring DataTables integration*

**Offers:**

* Various data sources support: models, query sets, list of dicts.
* Serverside tables support.
* ``DataTables`` plugins support: styling, internationalization, etc.
* Template tags for easy js and css inclusion.
* Template tags for DOM-based tables.

How to use
----------

First place table definition into ``views.py``:

.. code-block:: python

from django.shortcuts import render
from sitetables.toolbox import Table

from .models import Entries

def entries(request):
# We create table from entries queryset,
table_entries = Table(Entries.objects.filter(hidden=False))
return render(request, 'entries.html', {'table_entries': table_entries})

Next create page template ``entries.html``:

.. code-block:: html

{% load sitetables %}


{% sitetables_css table_entries %}



$(function() {
<!-- Initialize table using generated config. -->
$('#table-entries').dataTable({% sitetable_config table_entries %});
});


{% sitetables_js table_entries %}

Done. *More information is available in the documentation.*

Documentation
-------------

http://django-sitetables.readthedocs.org/