Skip to main content

Reusable application for Django featuring DataTables integration

Project description

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

release lic coverage

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:

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:

{% load sitetables %}

<!-- The following line usually goes into head tag. It'll load all needed css. -->
{% sitetables_css table_entries %}

<!-- The following resides in body tag. Note that in this scenario
     thead and tbody will be populated using JS automatically. -->
<table id="table-entries"></table>

<script type="text/javascript">
     $(function() {
         <!-- Initialize table using generated config. -->
         $('#table-entries').dataTable({% sitetable_config table_entries %});
     });
 </script>

<!-- The following line usually goes somewhere near the end of the body.
     It'll load all needed js. -->
{% sitetables_js table_entries %}

Done. More information is available in the documentation.

Documentation

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-sitetables-0.2.1.tar.gz (20.6 kB view hashes)

Uploaded Source

Built Distribution

django_sitetables-0.2.1-py2.py3-none-any.whl (20.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page