Getting started with django-reversion¶
To install django-reversion, follow these steps:
- Install with pip: pip install django-reversion.
- Add 'reversion' to INSTALLED_APPS.
- Run manage.py syncdb.
The latest release (1.8) of django-reversion is designed to work with Django 1.6. If you have installed anything other than the latest version of Django, please check the compatible Django versions page before installing django-reversion.
There are a number of alternative methods you can use when installing django-reversion. Please check the installation methods page for more information.
django-reversion can be used to add a powerful rollback and recovery facility to your admin site. To enable this, simply register your models with a subclass of reversion.VersionAdmin:
import reversion class YourModelAdmin(reversion.VersionAdmin): pass admin.site.register(YourModel, YourModelAdmin)
Whenever you register a model with the VersionAdmin class, be sure to run the ./manage.py createinitialrevisions command to populate the version database with an initial set of model data. Depending on the number of rows in your database, this command could take a while to execute.
For more information about admin integration, please read the admin integration documentation.
To store a new revision for every save() in your views, the simplest way is to add those two classes to MIDDLEWARE_CLASSES:
MIDDLEWARE_CLASSES = ( # Your middlewares... 'django.middleware.transaction.TransactionMiddleware', 'reversion.middleware.RevisionMiddleware' )
The first one makes sure data is only saved if the request completed succesfully, ensuring data integrity. The second one automatically commits a new revision. Order is important.
Low Level API¶
You can use django-reversion’s API to build powerful version-controlled views. For more information, please read the low level API documentation.