sheepdog-tables 1.1.0

Installation

pip install latest currenty need to add JS dependencies; we use bower: - backbone (1.0.0, say) - underscore (1.4.4, say) - Lots of js dependencies. Some subset of:

<script type="text/javascript" src="{% static "bower/jquery/jquery.min.js" %}"></script>
<script type="text/javascript" src="{% static "bower/bootstrap/js/bootstrap-collapse.js" %}"></script>
<script type="text/javascript" src="{% static "bower/bootstrap/js/bootstrap-dropdown.js" %}"></script>
<script type="text/javascript" src="{% static "bower/bootstrap/js/bootstrap-alert.js" %}"></script>
<script type="text/javascript" src="{% static "bower/bootstrap/js/bootstrap-tooltip.js" %}"></script>
<script type="text/javascript" src="{% static "bower/bootstrap/js/bootstrap-modal.js" %}"></script>
<script type="text/javascript" src="{% static "tables/js/jquery.ba-bbq.js" %}"></script>
<script type="text/javascript" src="{% static "bower/underscore/underscore.js" %}"></script>
<script type="text/javascript" src="{% static "bower/backbone/backbone.js" %}"></script>
<script type="text/coffeescript" src="{% static "tables/js/utils.coffee" %}"></script>
<script type="text/coffeescript" src="{% static "tables/js/tables.coffee" %}"></script>
<script type="text/coffeescript" src="{% static "tables/js/pagination.coffee" %}"></script>
<script type="text/coffeescript" src="{% static "tables/js/filtering.coffee" %}"></script>
<script type="text/coffeescript" src="{% static "tables/js/sort_form.coffee" %}"></script>
<script type="text/coffeescript" src="{% static "tables/js/edittable.coffee" %}"></script>

Starting Points

A few things should be noted for this API. The primary mixin to add a table to a page is TablesMixin. The corresponding template is found in tables/tables.html. The mixin should be mixed in to a class based view inheriting from a ListView. It’s get_context_data method should be run after the ListView’s same function.

Each table is to be declared as class parameters. For example, if I have two tables, Table1 and Table2, we could have a class that looks like this:

class MyView(TablesMixin, ListView):
    table_1 = Table1()
    table_2 = Table2()

    def get_context_data(self, **kwargs):
        context = ListView.get_context_data(self, **kwargs)
        context.update(TablesMixin.get_context_data(self, **kwargs)

The table class works similarly to models. Full docs for that are in it’s class doc string.

Good practice with this API

The general rules of Django and Python apply to the application of this API. Generally, it is a good idea to have all of your tables for your application in a tables.py file, and columns in their own separate columns.py file, just like one would do for forms and fields.