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.
** Also Note:** Saving orderable models invokes a fair number of queries and in order to avoid race conditions should be run in a transaction. If you’re using django >= 1.6 we recommend you set DATABASES[‘default’][‘ATOMIC_REQUESTS’] = True in your settings, if you’re not yet on django 1.6, we recommend use of TransactionMiddleware.
Subclass the appropriate Orderable admin classes:
from orderable.admin import OrderableAdmin, OrderableTabularInline
class SomeInlineClass(OrderableTabularInline):
...
class SomeAdminClass(OrderableAdmin):
list_display = ('__unicode__', 'sort_order_display')
...
jQuery and jQuery UI are used in the Admin for the actual moveable UI. You may override the versions with your own (rather than using the google cdn):
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-orderable-3.1.0.tar.gz.
File metadata
- Download URL: django-orderable-3.1.0.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9aa88c0c65ef1b56ce19c533118df4e24a78f28797f116d9474843dd7400fa2d |
|
| MD5 | 6d3b2b8e8c95e0fdca526536610df268 |
|
| BLAKE2b-256 | 9737b448aebaa7de125d72248ae1dbb75ca76506015568dc11c0bbcc1180ca30 |
File details
Details for the file django_orderable-3.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: django_orderable-3.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 12.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2ef093d68b0f1acccf21d6e4cd65b957dbb71dd2f8fb54fa44004c494c2c15c8 |
|
| MD5 | 86161b6734745b8a835e597f96ad6f0d |
|
| BLAKE2b-256 | 32283ff2181acae82a3e9a2ab6afa6949a147ae1a61035f26d1e071a675b2f23 |
