<commit_before>django-orderable
================

Make models orderable in the Admin.

Included:

* Abstract base Model
* Admin class
* Inline admin class
* Admin templates


Installation
------------

Grab from the PyPI: ::

    pip install django-orderable


Add to your INSTALLED_APPS: ::

    ...
    'orderable',
    ...


Subclass the Orderable class: ::

    from orderable.models import Orderable


    class Book(Orderable):
        ...


Note: If your subclass of Orderable has a Metaclass then make sure it subclasses the Orderable one so the model is sorted by ``sort_order``.


Subclass the appropriate Orderable admin classes: ::

    from orderable.admin import OrderableAdmin, OrderableTabularInline


    class SomeInlineClass(OrderableTabularInline):
        ...

    class SomeAdminClass(OrderableAdmin):
        ...


You need jQuery 1.2+ and jQuery UI 1.5+ available in the Admin for the actual moveable UI. You can either override the base admin template or add them in a Media class: ::

    class SomeAdminClass(OrderableAdmin):
        class Media:
            js = (
                'path/to/jquery.js',
                'path/to/jquery.ui.js',
            )


Common Gotchas
--------------

Adding Orderable to Existing Models
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You will need to populate the required `sort_order` field. Typically this is done by adding the
field in one migration with a default of `0` then creating a data migration to set it's value to
that of it's primary key::

    for obj in orm['appname.Model'].objects.all():
        obj.sort_order = obj.pk
        obj.save()


Multiple Models using Orderable
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When multiple models inherit from Orderable the `next()` and `previous()` methods will look for the
next/previous model with a sort order. However you'll likely want to have the various sort orders
determined by a foreign key or some other predicate. The easiest way (currently) is to override the
method in question.<commit_msg>Update README.rst<commit_after>django-orderable
================

Make models orderable in the Admin.

Included:

* Abstract base Model
* Admin class
* Inline admin class
* Admin templates


Installation
------------

Grab from the PyPI: ::

    pip install django-orderable


Add to your INSTALLED_APPS: ::

    ...
    'orderable',
    ...


Subclass the Orderable class: ::

    from orderable.models import Orderable


    class Book(Orderable):
        ...


Note: If your subclass of Orderable has a Metaclass then make sure it subclasses the Orderable one so the model is sorted by ``sort_order``.


Subclass the appropriate Orderable admin classes: ::

    from orderable.admin import OrderableAdmin, OrderableTabularInline


    class SomeInlineClass(OrderableTabularInline):
        ...

    class SomeAdminClass(OrderableAdmin):
        ...


You need jQuery 1.2+ and jQuery UI 1.5+ available in the Admin for the actual moveable UI. You can either override the base admin template or add them in a Media class: ::

    class SomeAdminClass(OrderableAdmin):
        class Media:
            js = (
                'path/to/jquery.js',
                'path/to/jquery.ui.js',
            )


Common Gotchas
--------------

Adding Orderable to Existing Models
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You will need to populate the required `sort_order` field. Typically this is done by adding the
field in one migration with a default of `0`, then creating a data migration to set the value to
that of its primary key::

    for obj in orm['appname.Model'].objects.all():
        obj.sort_order = obj.pk
        obj.save()


Multiple Models using Orderable
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When multiple models inherit from Orderable the `next()` and `previous()` methods will look for the
next/previous model with a sort order. However you'll likely want to have the various sort orders
determined by a foreign key or some other predicate. The easiest way (currently) is to override the
method in question.
{'fraction_non_alphanumeric': 0.11688634667993036, 'fraction_numerical': 0.002486943546381497, 'mean_word_length': 3.0099700897308077, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1908327', 'n_tokens_mistral': 1103, 'n_tokens_neox': 1023, 'n_words': 456}