Skip to content

Latest commit

 

History

History
138 lines (105 loc) · 5.62 KB

README.md

File metadata and controls

138 lines (105 loc) · 5.62 KB
Raw

Datatable View

This package is used in conjunction with the jQuery plugin DataTables, and supports state-saving detection with fnSetFilteringDelay. The package consists of a class-based view, and a small collection of utilities for rendering table data from models.

PyPI Downloads PyPI Version Build Status Documentation Status

Dependencies:

Getting Started

Install the package:

pip install django-datatable-view

Add to INSTALLED_APPS (so default templates and js can be discovered), and use the DatatableView like a Django ListView:

# settings.py
INSTALLED_APPS = [
    'datatableview',
    # ...
]


# views.py
from datatableview.views import DatatableView
class ZeroConfigurationDatatableView(DatatableView):
    model = MyModel

Use the {{ datatable }} provided in the template context to render the table and initialize from server ajax:

<!-- myapp/mymodel_list.html -->

<!-- Load dependencies -->
<script src="https://code.jquery.com/jquery-3.3.1.min.js"
        integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="
        crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://cdn.datatables.net/1.10.19/css/jquery.dataTables.min.css">
<script type="text/javascript" charset="utf8" src="https://cdn.datatables.net/1.10.19/js/jquery.dataTables.min.js"></script>

<!-- Load js for initializing tables via their server-side options -->
<script type="text/javascript" charset="utf8" src="{% static 'js/datatableview.js' %}"></script>
<script type="text/javascript">
    $(function(){
        datatableview.initialize($('.datatable'));
    });
</script>

<!-- Render the table skeleton, includes the .datatable class for the on-ready initializer. -->
{{ datatable }}

Features at a glance

  • DatatableView, a drop-in replacement for ListView that allows options to be specified for the datatable that will be rendered on the page.
  • MultipleDatatableView for configurating multiple Datatable specifications on a single view
  • ModelForm-like declarative table design.
  • Support for ValuesQuerySet execution mode instead of object instances
  • Queryset caching between requests
  • Customizable table headers
  • Compound columns (columns representing more than one model field)
  • Columns backed by methods or callbacks instead of model fields
  • Easy related fields
  • Automatic search and sort support
  • Total control over cell contents (HTML, processing of raw values)
  • Search data fields that aren't present on the table
  • Support for DT_RowData
  • Customization hook for full JSON response object
  • Drop-in x-editable support, per-column
  • Customizable table templates
  • Easy Bootstrap integration
  • Allows all normal dataTables.js and x-editable Javascript options
  • Small library of common column markup processors
  • Full test suite

Documentation and Live Demos

Read the module documentation at http://django-datatable-view.readthedocs.org.

A public live demo server is in the works. For version 0.8, we will continue to keep the live demo site alive at http://django-datatable-view.appspot.com/ Please note that 0.8 does not reflect the current state or direction of the project.

You can run the live demos locally from the included example project, using a few common setup steps.

$ git clone https://github.com/pivotal-energy-solutions/django-datatable-view.git
$ cd django-datatable-view
$ mkvirtualenv datatableview
(datatableview)$ pip install -r requirements.txt
(datatableview)$ datatableview/tests/example_project/manage.py migrate
(datatableview)$ datatableview/tests/example_project/manage.py loaddata initial_data
(datatableview)$ datatableview/tests/example_project/manage.py runserver

The example project is configured to use a local sqlite3 database, and relies on the django-datatable-view app itself, which is made available in the python path by simply running the project from the distributed directory root.

Authors

  • Autumn Valenta
  • Steven Klass

Copyright and license

Copyright 2011-2023 Pivotal Energy Solutions. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.