django-reversion-compare

django-reversion-compare is an extension to django-reversion that provides a history compare view to compare two versions of a model which is under reversion.

Comparing model versions is not a easy task. Maybe there are different view how this should looks like. This project will gives you a generic way to see whats has been changed.

Many parts are customizable by overwrite methods or subclassing, see above.

Installation

Just use:

pip install django-reversion-compare

Setup

Add reversion_compare to INSTALLED_APPS in your settings.py, e.g.:

INSTALLED_APPS = (
    'django...',
    ...
    'reversion', # https://github.com/etianen/django-reversion
    'reversion_compare', # https://github.com/jedie/django-reversion-compare
    ...
)

# Add reversion models to admin interface:
ADD_REVERSION_ADMIN=True
# optional settings:
REVERSION_COMPARE_FOREIGN_OBJECTS_AS_ID=False
REVERSION_COMPARE_IGNORE_NOT_REGISTERED=False

Usage

Inherit from CompareVersionAdmin instead of VersionAdmin to get the comparison feature.

admin.py e.g.:

from django.contrib import admin
from reversion_compare.admin import CompareVersionAdmin

from my_app.models import ExampleModel

@admin.register(ExampleModel)
class ExampleModelAdmin(CompareVersionAdmin):
    pass

If you're using an existing third party app, then you can add patch django-reversion-compare into its admin class by using the reversion_compare.helpers.patch_admin() method. For example, to add version control to the built-in User model:

from reversion_compare.helpers import patch_admin

patch_admin(User)

e.g.: Add django-cms Page model:

from cms.models.pagemodel import Page
from reversion_compare.helpers import patch_admin

# Patch django-cms Page Model to add reversion-compare functionality:
patch_admin(Page)

Customize

It's possible to change the look for every field or for a entire field type. You must only define a methods to your admin class with this name scheme:

• "compare_%s" % field_name
• "compare_%s" % field.get_internal_type()

If there is no method with this name scheme, the fallback_compare() method will be used.

An example for specifying a compare method for a model field by name:

class YourAdmin(CompareVersionAdmin):
    def compare_foo_bar(self, obj_compare):
        """ compare the foo_bar model field """
        return "%r <-> %r" % (obj_compare.value1, obj_compare.value2)

and example using patch_admin with custom version admin class:

patch_admin(User, AdminClass=YourAdmin)

Class Based View

Beyond the Admin views, you can also create a Class Based View for displaying and comparing version differences. This is a single class-based-view that either displays the list of versions to select for an object or displays both the versions and their differences (if the versions to be compared have been selected). This class can be used just like a normal DetailView:

More information about this can be found in DocString of:

• HistoryCompareDetailView

The make run-test-server test project contains a Demo, use the links under:

HistoryCompareDetailView Examples:

Screenshots

Here some screenshots of django-reversion-compare:

How to select the versions to compare:

from v0.1.0: DateTimeField compare (last update), TextField compare (content) with small changes and a ForeignKey compare (child model instance was added):

from v0.1.0: Same as above, but the are more lines changed in TextField and the ForeignKey relation was removed:

Example screenshot from v0.3.0: a many-to-many field compare (friends, hobbies):

• In the first line, the m2m object has been changed.
• line 2: A m2m object was deleted
• line 3: A m2m object was removed from this entry (but not deleted)
• line 4: This m2m object has not changed

create developer environment

We use manage_django_project, so you just need to clone the sources and call manage.py to start hacking.

e.g.:

~$ git clone https://github.com/jedie/django-reversion-compare.git
~$ cd django-reversion-compare

# Just call manage.py and the magic happen:
~/django-reversion-compare$ ./manage.py

# start local dev. web server:
~/django-reversion-compare$ ./manage.py run_dev_server

# run tests:
~/django-reversion-compare$ ./manage.py test
# or with coverage
~/django-reversion-compare$ ./manage.py coverage
# or via tox:
~/django-reversion-compare$ ./manage.py tox p

Backwards-incompatible changes

v0.16.0

We use https://github.com/jedie/manage_django_project to manage the dev venv and we switch to main branch.

You must reinit your dev setup.

v0.12.0

Google "diff-match-patch" is now mandatory and not optional.

Version compatibility

These are the unittests variants. See also: /pyproject.toml Maybe other versions are compatible, too.

Changelog

• v0.18.1
  • 2024-09-10 - Bugfix packaging: We use rich in production code
• v0.18.0
  • 2024-09-10 - modernized code
  • 2024-09-10 - Update test matrix and requirements
  • 2024-09-10 - Apply manageprojects updates
  • 2024-09-10 - Update requirements
  • 2024-05-21 - fix time in snapshots
  • 2024-05-21 - Apply manageprojects update
  • 2024-02-20 - Update README.md
• v0.17.0
  • 2024-02-20 - Enhance diff
  • 2024-02-20 - Update requirements
  • 2024-01-17 - mamageprojects updates + update requirements
  • 2023-12-17 - Update tests.yml
  • 2023-12-17 - Configure unittests via "load_tests Protocol"
  • 2023-12-17 - Apply manageproject updates
  • 2023-11-07 - Add Python 3.12 to text matrix + project upgrade
  • 2023-05-23 - Bump requests from 2.28.2 to 2.31.0
• v0.16.2
  • 2023-05-08 - Bugfix RegistrationError: has not been registered with django-reversion
  • 2023-05-08 - Update requirements
  • 2023-04-28 - Fix link for CBV

Links

| Github | https://github.com/jedie/django-reversion-compare | | Python Packages | https://pypi.org/project/django-reversion-compare/ |

Donation

• paypal.me/JensDiemer
• Flattr This!
• Send Bitcoins to 1823RZ5Md1Q2X5aSXRC5LRPcYdveCiVX6F