A django application to enable versioning of data stored in Django models.
Failed to load latest commit information.
bin Updated setup.py to be able to run tests. Removed imports from base p… Jun 21, 2010
docs Fixed VersionsForeignKey fields to update all related objects. Jun 22, 2010
versions Added code to fix editing of deleted unique objects. Jan 3, 2011
.gitignore Centralized settings for easier development. Jul 27, 2010
AUTHORS Initial commit of django-versions. Jun 17, 2010
LICENSE.rst Added basic docs. Jun 20, 2010
REQUIREMENTS Added a pip requirements file. Aug 16, 2010
django.patch One more time fixing the patch. Jul 22, 2010
runtests.py Added a simple logging handler to the test suite, so supress warnings. Jul 28, 2010
setup.py Updated setup.py to include new packages that were added since last r… Aug 11, 2010




django-versions allows you to version the data stored in django models seamlessly. To get started all you need to do is to set VERSIONS_REPOSITORIES variable in your settings and configure the repositories you would like to use, then just subclass your Model from VersionsModel and start saving data:

from django.db import models
from versions.models import VersionsModel

class MyModel(VersionsModel):
    text = models.TextField()



  • Mercurial >= 1.5.2
  • Django == 1.1.X

Installing django-versions

If your are installing from source, you just need to run the following command from the base of the django-versions source tree:

python setup.py install

If you want to install the package without checking out the source you should run:

pip install django-versions

# OR if you don't have pip installed (you should definitely check out pip)
easy_install django-versions

For the time being, we need to patch Django to allow us to gain access to the related model from Manager classes. There is a patch included at the root of the source tree django.patch that includes the required changes. To patch django, go to the root of your checkout of django 1.1.X and run:

patch -p0 < /path/to/django-versions/django.patch

Add VERSIONS_REPOSITORIES to your settings file, pointing to the location where you would like django-versions to create and store your model history:

     'default': {
          'backend': 'versions.backends.hg',
          'local': '/path/to/my/projects/model/history',

Enabling Version Management

Install the VersionsMiddleware:


Or handle enabling editing of Versioned models manually:

from versions.base import revision

def my_editing_function(request):
    m = MyModel.objects.get(pk=1)

def my_other_editing_function(request):
    with revision:
        m = MyModel.objects.get(pk=1)