Skip to main content

Orderable model and admin

Project description

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):
    list_display = ('__unicode__', 'sort_order_display')
    ...

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.

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-orderable-2.0.0.tar.gz (6.0 kB view details)

Uploaded Source

File details

Details for the file django-orderable-2.0.0.tar.gz.

File metadata

File hashes

Hashes for django-orderable-2.0.0.tar.gz
Algorithm Hash digest
SHA256 5bb10c2fb00bfa4239b6dd984eb9f36a275be33a7faaf6c65e1cea2f8cf8104f
MD5 179ed1d0f8ab20d2bcd5bba1cdf4d665
BLAKE2b-256 26ceb13c37448a21956f484dd63ccd8678e70f276028836e1f7ae99d329b6ca6

See more details on using hashes here.

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