Home

Getting started with django-reversion

To install django-reversion, follow these steps:

1. Checkout the latest django-reversion release and copy or symlink the src/reversion directory into your PYTHONPATH.
2. Add 'reversion' to your INSTALLED_APPS setting.
3. Run the command manage.py syncdb.

The latest release (1.7) of django-reversion is designed to work with Django 1.5. If you have installed anything other than the latest version of Django, please check the compatible Django versions page before downloading 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.

Admin integration

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 visit the admin integration wiki page.

Low Level API

You can use django-reversion's API to build powerful version-controlled views outside of the built-in admin site. For more information, please visit the low level API wiki page.

More information

Installation

• Installation methods
• Compatible django versions
• Schema migrations
• Admin integration

Further reading

• Low-level API
• Management commands
• Signals sent by django-reversion
• How it works
• Generating diffs