From 2008cf0052984bfb365f90b83231e09e63646185 Mon Sep 17 00:00:00 2001 From: Bradley Ayers Date: Thu, 9 Jun 2011 09:06:34 +1000 Subject: [PATCH] renamed to django-tables2 --- MANIFEST.in | 4 +- README.rst | 42 ++++++-- {django_tables => django_tables2}/__init__.py | 0 {django_tables => django_tables2}/columns.py | 2 +- {django_tables => django_tables2}/models.py | 0 {django_tables => django_tables2}/rows.py | 2 +- .../themes/paleblue/css/screen.css | 0 .../themes/paleblue/img/arrow-active-down.png | Bin .../themes/paleblue/img/arrow-active-up.png | Bin .../paleblue/img/arrow-inactive-down.png | Bin .../themes/paleblue/img/arrow-inactive-up.png | Bin .../themes/paleblue/img/header-bg.gif | Bin .../themes/paleblue/img/pagination-bg.gif | Bin {django_tables => django_tables2}/tables.py | 4 +- .../django_tables2}/basic_table.html | 0 .../templates/django_tables2}/table.html | 2 +- .../templatetags/__init__.py | 0 .../templatetags/django_tables2.py | 5 +- {django_tables => django_tables2}/utils.py | 4 +- {django_tables => django_tables2}/views.py | 2 +- docs/Makefile | 8 +- docs/conf.py | 12 +-- docs/index.rst | 100 +++++++++--------- docs/make.bat | 4 +- example/app/tables.py | 2 +- example/settings.py | 4 +- example/templates/example.html | 24 ++--- setup.py | 6 +- tests/__init__.py | 2 +- tests/columns.py | 6 +- tests/core.py | 4 +- tests/models.py | 2 +- tests/rows.py | 4 +- tests/templates.py | 10 +- tests/utils.py | 2 +- 35 files changed, 144 insertions(+), 113 deletions(-) rename {django_tables => django_tables2}/__init__.py (100%) rename {django_tables => django_tables2}/columns.py (99%) rename {django_tables => django_tables2}/models.py (100%) rename {django_tables => django_tables2}/rows.py (99%) rename {django_tables => django_tables2}/static/django_tables/themes/paleblue/css/screen.css (100%) rename {django_tables => django_tables2}/static/django_tables/themes/paleblue/img/arrow-active-down.png (100%) rename {django_tables => django_tables2}/static/django_tables/themes/paleblue/img/arrow-active-up.png (100%) rename {django_tables => django_tables2}/static/django_tables/themes/paleblue/img/arrow-inactive-down.png (100%) rename {django_tables => django_tables2}/static/django_tables/themes/paleblue/img/arrow-inactive-up.png (100%) rename {django_tables => django_tables2}/static/django_tables/themes/paleblue/img/header-bg.gif (100%) rename {django_tables => django_tables2}/static/django_tables/themes/paleblue/img/pagination-bg.gif (100%) rename {django_tables => django_tables2}/tables.py (98%) rename {django_tables/templates/django_tables => django_tables2/templates/django_tables2}/basic_table.html (100%) rename {django_tables/templates/django_tables => django_tables2/templates/django_tables2}/table.html (98%) rename {django_tables => django_tables2}/templatetags/__init__.py (100%) rename django_tables/templatetags/django_tables.py => django_tables2/templatetags/django_tables2.py (97%) rename {django_tables => django_tables2}/utils.py (98%) rename {django_tables => django_tables2}/views.py (97%) diff --git a/MANIFEST.in b/MANIFEST.in index 5962fc8..1429610 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,5 @@ include README.rst -recursive-include django_tables/templates * -recursive-include django_tables/static * +recursive-include django_tables2/templates * +recursive-include django_tables2/static * recursive-include example/app/fixtures * recursive-include example/app/templates * diff --git a/README.rst b/README.rst index 171ecfd..79c3960 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,44 @@ -=============================================== -django-tables - An app for creating HTML tables -=============================================== +================================================ +django-tables2 - An app for creating HTML tables +================================================ -django-tables simplifies the task of turning sets of datainto HTML tables. It +.. note:: + + Prior to v0.6.0 this package was a fork of miracle2k's and both were known + as *django-tables*. This caused some problems (e.g. ambiguity and inability + to put this library on PyPI) so as of v0.6.0 this package is known as + *django-tables2*. + +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. -Documentation_ is available on http://readthedocs.org +Creating a table is as simple as:: + + import django_tables2 as tables + + class SimpleTable(tables.Table): + class Meta: + model = Simple + +This would then be used in a view:: + + 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`__ for more details. -.. _Documentation: http://readthedocs.org/docs/django-tables/en/latest/ +.. __: http://readthedocs.org/docs/django-tables/en/latest/ Building the documentation diff --git a/django_tables/__init__.py b/django_tables2/__init__.py similarity index 100% rename from django_tables/__init__.py rename to django_tables2/__init__.py diff --git a/django_tables/columns.py b/django_tables2/columns.py similarity index 99% rename from django_tables/columns.py rename to django_tables2/columns.py index e3626d2..e711d71 100644 --- a/django_tables/columns.py +++ b/django_tables2/columns.py @@ -203,7 +203,7 @@ class LinkColumn(Column): ) # tables.py - from django_tables.utils import A # alias for Accessor + from django_tables2.utils import A # alias for Accessor class PeopleTable(tables.Table): name = tables.LinkColumn('people_detail', args=[A('pk')]) diff --git a/django_tables/models.py b/django_tables2/models.py similarity index 100% rename from django_tables/models.py rename to django_tables2/models.py diff --git a/django_tables/rows.py b/django_tables2/rows.py similarity index 99% rename from django_tables/rows.py rename to django_tables2/rows.py index f9b9770..5579ebd 100644 --- a/django_tables/rows.py +++ b/django_tables2/rows.py @@ -18,7 +18,7 @@ class BoundRow(object): .. code-block:: python - >>> import django_tables as tables + >>> import django_tables2 as tables >>> class SimpleTable(tables.Table): ... a = tables.Column() ... b = tables.CheckBoxColumn(attrs={'name': 'my_chkbox'}) diff --git a/django_tables/static/django_tables/themes/paleblue/css/screen.css b/django_tables2/static/django_tables/themes/paleblue/css/screen.css similarity index 100% rename from django_tables/static/django_tables/themes/paleblue/css/screen.css rename to django_tables2/static/django_tables/themes/paleblue/css/screen.css diff --git a/django_tables/static/django_tables/themes/paleblue/img/arrow-active-down.png b/django_tables2/static/django_tables/themes/paleblue/img/arrow-active-down.png similarity index 100% rename from django_tables/static/django_tables/themes/paleblue/img/arrow-active-down.png rename to django_tables2/static/django_tables/themes/paleblue/img/arrow-active-down.png diff --git a/django_tables/static/django_tables/themes/paleblue/img/arrow-active-up.png b/django_tables2/static/django_tables/themes/paleblue/img/arrow-active-up.png similarity index 100% rename from django_tables/static/django_tables/themes/paleblue/img/arrow-active-up.png rename to django_tables2/static/django_tables/themes/paleblue/img/arrow-active-up.png diff --git a/django_tables/static/django_tables/themes/paleblue/img/arrow-inactive-down.png b/django_tables2/static/django_tables/themes/paleblue/img/arrow-inactive-down.png similarity index 100% rename from django_tables/static/django_tables/themes/paleblue/img/arrow-inactive-down.png rename to django_tables2/static/django_tables/themes/paleblue/img/arrow-inactive-down.png diff --git a/django_tables/static/django_tables/themes/paleblue/img/arrow-inactive-up.png b/django_tables2/static/django_tables/themes/paleblue/img/arrow-inactive-up.png similarity index 100% rename from django_tables/static/django_tables/themes/paleblue/img/arrow-inactive-up.png rename to django_tables2/static/django_tables/themes/paleblue/img/arrow-inactive-up.png diff --git a/django_tables/static/django_tables/themes/paleblue/img/header-bg.gif b/django_tables2/static/django_tables/themes/paleblue/img/header-bg.gif similarity index 100% rename from django_tables/static/django_tables/themes/paleblue/img/header-bg.gif rename to django_tables2/static/django_tables/themes/paleblue/img/header-bg.gif diff --git a/django_tables/static/django_tables/themes/paleblue/img/pagination-bg.gif b/django_tables2/static/django_tables/themes/paleblue/img/pagination-bg.gif similarity index 100% rename from django_tables/static/django_tables/themes/paleblue/img/pagination-bg.gif rename to django_tables2/static/django_tables/themes/paleblue/img/pagination-bg.gif diff --git a/django_tables/tables.py b/django_tables2/tables.py similarity index 98% rename from django_tables/tables.py rename to django_tables2/tables.py index 3112e75..3bd4c56 100644 --- a/django_tables/tables.py +++ b/django_tables2/tables.py @@ -334,10 +334,10 @@ class Table(StrAndUnicode): The rendered table won't include pagination or sorting, as those features require a RequestContext. Use the ``render_table`` template - tag (requires ``{% load django_tables %}``) if you require this extra + tag (requires ``{% load django_tables2 %}``) if you require this extra functionality. """ - template = get_template('django_tables/basic_table.html') + template = get_template('django_tables2/basic_table.html') return template.render(Context({'table': self})) @property diff --git a/django_tables/templates/django_tables/basic_table.html b/django_tables2/templates/django_tables2/basic_table.html similarity index 100% rename from django_tables/templates/django_tables/basic_table.html rename to django_tables2/templates/django_tables2/basic_table.html diff --git a/django_tables/templates/django_tables/table.html b/django_tables2/templates/django_tables2/table.html similarity index 98% rename from django_tables/templates/django_tables/table.html rename to django_tables2/templates/django_tables2/table.html index 6400b75..d580a1a 100644 --- a/django_tables/templates/django_tables/table.html +++ b/django_tables2/templates/django_tables2/table.html @@ -1,5 +1,5 @@ {% spaceless %} -{% load django_tables %} +{% load django_tables2 %} {% if table.page %}
{% endif %} diff --git a/django_tables/templatetags/__init__.py b/django_tables2/templatetags/__init__.py similarity index 100% rename from django_tables/templatetags/__init__.py rename to django_tables2/templatetags/__init__.py diff --git a/django_tables/templatetags/django_tables.py b/django_tables2/templatetags/django_tables2.py similarity index 97% rename from django_tables/templatetags/django_tables.py rename to django_tables2/templatetags/django_tables2.py index 1166a3d..3b1a6a5 100644 --- a/django_tables/templatetags/django_tables.py +++ b/django_tables2/templatetags/django_tables2.py @@ -1,4 +1,5 @@ -""" +#! -*- coding: utf-8 -*- +""" Allows setting/changing/removing of chosen url query string parameters, while maintaining any existing others. @@ -102,7 +103,7 @@ class RenderTableNode(template.Node): "table": table}) try: table.request = context["request"] - return get_template("django_tables/table.html").render(context) + return get_template("django_tables2/table.html").render(context) finally: del table.request except: diff --git a/django_tables/utils.py b/django_tables2/utils.py similarity index 98% rename from django_tables/utils.py rename to django_tables2/utils.py index 93107dd..de376ce 100644 --- a/django_tables/utils.py +++ b/django_tables2/utils.py @@ -65,7 +65,7 @@ class OrderBy(str): class OrderByTuple(tuple, StrAndUnicode): """Stores ordering as (as :class:`.OrderBy` objects). The - :attr:`django_tables.tables.Table.order_by` property is always converted + :attr:`django_tables2.tables.Table.order_by` property is always converted to an :class:`.OrderByTuple` object. This class is essentially just a :class:`tuple` with some useful extras. @@ -262,7 +262,7 @@ class AttributeDict(dict): .. code-block:: python - >>> from django_tables.utils import AttributeDict + >>> from django_tables2.utils import AttributeDict >>> attrs = AttributeDict({'class': 'mytable', 'id': 'someid'}) >>> attrs.as_html() 'class="mytable" id="someid"' diff --git a/django_tables/views.py b/django_tables2/views.py similarity index 97% rename from django_tables/views.py rename to django_tables2/views.py index 886ffe3..ca58560 100644 --- a/django_tables/views.py +++ b/django_tables2/views.py @@ -9,7 +9,7 @@ class SingleTableMixin(object): ``TemplateResponseMixin``. :param table_class: table class - :type table_class: subclass of ``django_tables.Table`` + :type table_class: subclass of ``django_tables2.Table`` :param table_data: data used to populate the table :type table_data: any compatible data source diff --git a/docs/Makefile b/docs/Makefile index 4dab0d9..0d39543 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -72,17 +72,17 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-tables.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-tables2.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-tables.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-tables2.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/django-tables" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-tables" + @echo "# mkdir -p $$HOME/.local/share/devhelp/django-tables2" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-tables2" @echo "# devhelp" epub: diff --git a/docs/conf.py b/docs/conf.py index c8cc665..cd6c4fb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# django-tables documentation build configuration file, created by +# django-tables2 documentation build configuration file, created by # sphinx-quickstart on Wed Jan 5 13:04:34 2011. # # This file is execfile()d with the current directory set to its containing dir. @@ -20,7 +20,7 @@ os.environ["DJANGO_SETTINGS_MODULE"] = "example.settings" # import our libs sys.path.insert(0, os.path.join(os.path.abspath('.'), os.pardir)) import example -import django_tables as tables +import django_tables2 as tables sys.path.pop(0) @@ -46,7 +46,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'django-tables' +project = u'django-tables2' #copyright = u'' # The version info for the project you're documenting, acts as replacement for @@ -170,7 +170,7 @@ html_show_copyright = False #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'django-tablesdoc' +htmlhelp_basename = 'django-tables2doc' # -- Options for LaTeX output -------------------------------------------------- @@ -184,7 +184,7 @@ htmlhelp_basename = 'django-tablesdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'django-tables.tex', u'django-tables Documentation', + ('index', 'django-tables2.tex', u'django-tables2 Documentation', u'n/a', 'manual'), ] @@ -217,6 +217,6 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'django-tables', u'django-tables Documentation', + ('index', 'django-tables2', u'django-tables2 Documentation', [u'n/a'], 1) ] diff --git a/docs/index.rst b/docs/index.rst index ca43428..7d5d33a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,21 +1,21 @@ .. default-domain:: py -=============================================== -django-tables - An app for creating HTML tables -=============================================== +================================================ +django-tables2 - An app for creating HTML tables +================================================ -django-tables simplifies the task of turning sets of datainto HTML tables. It +django-tables2 simplifies the task of turning sets of datainto HTML tables. It has native support for pagination and sorting. It does for HTML tables what ``django.forms`` does for HTML forms. Quick start guide ================= -1. Download and install from https://github.com/bradleyayers/django-tables. +1. Download and install from https://github.com/bradleyayers/django-tables2. Grab a ``.tar.gz`` of the latest tag, and run ``pip install ``. -2. Hook the app into your Django project by adding ``'django_tables'`` to your +2. Hook the app into your Django project by adding ``'django_tables2'`` to your ``INSTALLED_APPS`` setting. -3. Write a subclass of :class:`~django_tables.tables.Table` that describes the +3. Write a subclass of :class:`~django_tables2.tables.Table` that describes the structure of your table. 4. Create an instance of your table in a :term:`view`, provide it with :term:`table data`, and pass it to a :term:`template` for display. @@ -39,13 +39,13 @@ turn it into an HTML table. This is the data we'll be using: ] -The first step is to subclass :class:`~django_tables.tables.Table` and describe +The first step is to subclass :class:`~django_tables2.tables.Table` and describe the table structure. This is done by creating a column for each attribute in the :term:`table data`. .. code-block:: python - import django_tables as tables + import django_tables2 as tables class CountryTable(tables.Table): name = tables.Column() @@ -72,7 +72,7 @@ write a view that would look something like: context_instance=RequestContext(request)) In your template, the easiest way to :term:`render` the table is via the -:meth:`~django_tables.tables.Table.as_html` method: +:meth:`~django_tables2.tables.Table.as_html` method: .. code-block:: django @@ -97,7 +97,7 @@ table via the :ref:`template tag ` rather than .. code-block:: django - {% load django_tables %} + {% load django_tables2 %} {% render_table table %} .. note:: @@ -128,7 +128,7 @@ adding a ``class Meta:`` to the table class and defining a ``attrs`` variable. .. code-block:: python - import django_tables as tables + import django_tables2 as tables class CountryTable(tables.Table): name = tables.Column() @@ -143,7 +143,7 @@ The last thing to do is to include the stylesheet in the template. .. code-block:: html - + Save your template and reload the page in your browser. @@ -164,7 +164,7 @@ table with data, pass it in as the first argument when instantiating a table. Each item in the :term:`table data` is called a :term:`record` and is used to populate a single row in the table. By default, the table uses column names as :term:`accessors ` to retrieve individual cell values. This can -be changed via the :attr:`~django_tables.columns.Column.accessor` argument. +be changed via the :attr:`~django_tables2.columns.Column.accessor` argument. Any iterable can be used as table data, and there's builtin support for :class:`QuerySet` objects (to ensure they're handled effeciently). @@ -285,7 +285,7 @@ Column headers ============== The header cell for each column comes from the column's -:meth:`~django_tables.columns.BoundColumn.header` method. By default this +:meth:`~django_tables2.columns.BoundColumn.header` method. By default this method returns the column's ``verbose_name``, which is either explicitly specified, or generated automatically based on the column name. @@ -354,12 +354,12 @@ CSS --- In order to use CSS to style a table, you'll probably want to add a -``class`` or ``id`` attribute to the ```` element. ``django-tables`` has +``class`` or ``id`` attribute to the ``
`` element. ``django-tables2`` has a hook that allows abitrary attributes to be added to the ``
`` tag. .. code-block:: python - >>> import django_tables as tables + >>> import django_tables2 as tables >>> class SimpleTable(tables.Table): ... id = tables.Column() ... age = tables.Column() @@ -404,7 +404,7 @@ arguments you're interested in, and the function will recieve them .. code-block:: python - >>> import django_tables as tables + >>> import django_tables2 as tables >>> class SimpleTable(tables.Table): ... row_number = tables.Column() ... id = tables.Column() @@ -440,7 +440,7 @@ To change the way cells are rendered, simply override the .. code-block:: python - >>> import django_tables as tables + >>> import django_tables2 as tables >>> >>> class AngryColumn(tables.Column): ... def render(self, value): @@ -500,7 +500,7 @@ ignore the built-in generation tools, and instead pass an instance of your .. code-block:: django - {% load django_tables %} + {% load django_tables2 %}
@@ -535,14 +535,14 @@ Template tags render_table ------------ -Renders a :class:`~django_tables.tables.Table` object to HTML and includes as +Renders a :class:`~django_tables2.tables.Table` object to HTML and includes as many features as possible. Sample usage: .. code-block:: django - {% load django_tables %} + {% load django_tables2 %} {% render_table table %} This tag temporarily modifies the :class:`.Table` object while it is being @@ -625,7 +625,7 @@ Class Based Generic Mixins ========================== Django 1.3 introduced `class based views`__ as a mechanism to reduce the -repetition in view code. django-tables comes with a single class based view +repetition in view code. django-tables2 comes with a single class based view mixin: ``SingleTableMixin``. It makes it trivial to incorporate a table into a view/template, however it requires a few variables to be defined on the view: @@ -641,7 +641,7 @@ For example: .. code-block:: python - from django_tables.views import SingleTableMixin + from django_tables2.views import SingleTableMixin from django.generic.views.list import ListView @@ -664,7 +664,7 @@ The template could then be as simple as: .. code-block:: django - {% load django_tables %} + {% load django_tables2 %} {% render_table table %} Such little code is possible due to the example above taking advantage of @@ -699,7 +699,7 @@ Example:: ['name'] To have a mixin contribute a column, it needs to be a subclass of -:class:`~django_tables.tables.Table`. With this in mind the previous example +:class:`~django_tables2.tables.Table`. With this in mind the previous example *should* have been written as follows:: >>> class UsefulMixin(tables.Table): @@ -735,7 +735,7 @@ Often a table will become quite complex after time, e.g. `table.render_foo`_, changing ``verbose_name`` on columns, or adding an extra :class:`~.CheckBoxColumn`. -``django-tables`` offers the :attr:`.Table.Meta.model` option to ease the pain. +``django-tables2`` offers the :attr:`.Table.Meta.model` option to ease the pain. The ``model`` option causes the table automatically generate columns for the fields in the model. This means that the above table could be re-written as follows:: @@ -750,7 +750,7 @@ follows:: If you want to customise one of the columns, simply define it the way you would normally:: - >>> from django_tables import A + >>> from django_tables2 import A >>> class PersonTable(tables.Table): ... user = tables.LinkColumn("admin:auth_user_change", args=[A("user.pk")]) ... @@ -794,14 +794,14 @@ API Reference :class:`Accessor` Objects: -------------------------- -.. autoclass:: django_tables.utils.Accessor +.. autoclass:: django_tables2.utils.Accessor :members: :class:`Table` Objects: ----------------------- -.. autoclass:: django_tables.tables.Table +.. autoclass:: django_tables2.tables.Table :class:`Table.Meta` Objects: @@ -816,7 +816,7 @@ API Reference Allows custom HTML attributes to be specified which will be added to the ``
`` tag of any table rendered via - :meth:`~django_tables.tables.Table.as_html` or the + :meth:`~django_tables2.tables.Table.as_html` or the :ref:`template-tags.render_table` template tag. :type: ``dict`` @@ -867,14 +867,14 @@ API Reference ... last_name = tables.Column() ... >>> Person.base_columns - {'first_name': , - 'last_name': } + {'first_name': , + 'last_name': } >>> class ForgetfulPerson(Person): ... class Meta: ... exclude = ("last_name", ) ... >>> ForgetfulPerson.base_columns - {'first_name': } + {'first_name': } .. note:: @@ -967,41 +967,41 @@ API Reference :class:`TableData` Objects: ------------------------------ -.. autoclass:: django_tables.tables.TableData +.. autoclass:: django_tables2.tables.TableData :members: __init__, order_by, __getitem__, __len__ :class:`Column` Objects: ------------------------ -.. autoclass:: django_tables.columns.Column +.. autoclass:: django_tables2.columns.Column :class:`CheckBoxColumn` Objects: -------------------------------- -.. autoclass:: django_tables.columns.CheckBoxColumn +.. autoclass:: django_tables2.columns.CheckBoxColumn :members: :class:`LinkColumn` Objects: ---------------------------- -.. autoclass:: django_tables.columns.LinkColumn +.. autoclass:: django_tables2.columns.LinkColumn :members: :class:`TemplateColumn` Objects: -------------------------------- -.. autoclass:: django_tables.columns.TemplateColumn +.. autoclass:: django_tables2.columns.TemplateColumn :members: :class:`BoundColumns` Objects ----------------------------- -.. autoclass:: django_tables.columns.BoundColumns +.. autoclass:: django_tables2.columns.BoundColumns :members: all, items, sortable, visible, __iter__, __contains__, __len__, __getitem__ @@ -1009,42 +1009,42 @@ API Reference :class:`BoundColumn` Objects ---------------------------- -.. autoclass:: django_tables.columns.BoundColumn +.. autoclass:: django_tables2.columns.BoundColumn :members: :class:`BoundRows` Objects -------------------------- -.. autoclass:: django_tables.rows.BoundRows +.. autoclass:: django_tables2.rows.BoundRows :members: __iter__, __len__, count :class:`BoundRow` Objects ------------------------- -.. autoclass:: django_tables.rows.BoundRow +.. autoclass:: django_tables2.rows.BoundRow :members: __getitem__, __contains__, __iter__, record, table :class:`AttributeDict` Objects ------------------------------ -.. autoclass:: django_tables.utils.AttributeDict +.. autoclass:: django_tables2.utils.AttributeDict :members: :class:`OrderBy` Objects ------------------------ -.. autoclass:: django_tables.utils.OrderBy +.. autoclass:: django_tables2.utils.OrderBy :members: :class:`OrderByTuple` Objects ----------------------------- -.. autoclass:: django_tables.utils.OrderByTuple +.. autoclass:: django_tables2.utils.OrderByTuple :members: __unicode__, __contains__, __getitem__, cmp @@ -1054,10 +1054,10 @@ Glossary .. glossary:: accessor - Refers to an :class:`~django_tables.utils.Accessor` object + Refers to an :class:`~django_tables2.utils.Accessor` object bare orderby - The non-prefixed form of an :class:`~django_tables.utils.OrderBy` + The non-prefixed form of an :class:`~django_tables2.utils.OrderBy` object. Typically the bare form is just the ascending form. Example: ``age`` is the bare form of ``-age`` @@ -1082,7 +1082,7 @@ Glossary A single Python object used as the data for a single row. render - The act of serialising a :class:`~django_tables.tables.Table` into + The act of serialising a :class:`~django_tables2.tables.Table` into HTML. template @@ -1090,4 +1090,4 @@ Glossary table data An interable of :term:`records ` that - :class:`~django_tables.tables.Table` uses to populate its rows. + :class:`~django_tables2.tables.Table` uses to populate its rows. diff --git a/docs/make.bat b/docs/make.bat index f2874c0..71ef011 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -95,9 +95,9 @@ if "%1" == "qthelp" ( echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-tables.qhcp + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-tables2.qhcp echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-tables.ghc + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-tables2.ghc goto end ) diff --git a/example/app/tables.py b/example/app/tables.py index 522e666..56e5d9d 100644 --- a/example/app/tables.py +++ b/example/app/tables.py @@ -1,4 +1,4 @@ -import django_tables as tables +import django_tables2 as tables class CountryTable(tables.Table): diff --git a/example/settings.py b/example/settings.py index d8d8d9f..f67caa8 100644 --- a/example/settings.py +++ b/example/settings.py @@ -1,4 +1,4 @@ -# import django_tables +# import django_tables2 from os.path import dirname, join, abspath import sys @@ -129,7 +129,7 @@ INSTALLED_APPS = ( 'django.contrib.messages', 'django.contrib.staticfiles', 'example.app', - 'django_tables', + 'django_tables2', ) # A sample logging configuration. The only tangible logging diff --git a/example/templates/example.html b/example/templates/example.html index d444881..7e168d1 100644 --- a/example/templates/example.html +++ b/example/templates/example.html @@ -1,8 +1,8 @@ - django-tables examples - + django-tables2 examples +