Django Version Control

A third-party Django application generated with django-plugin-template-cookiecutter.

Quick Start

1. Installation

Install the package via pip:

pip install version_control

2. Configuration

Add "version_control" to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    # ...existing apps...
    "version_control",
]

Enable the middleware by adding it to your MIDDLEWARE setting:

MIDDLEWARE = [
    # ...existing middleware...
    "version_control.middleware.VersionControlMiddleware",
]

3. Version Control Dependencies

Depending on the version control system used by your project, install the corresponding third-party modules:

For Git projects:

pip install GitPython

For Mercurial projects:

pip install hglib         # Python 3.x
pip install python-hglib  # Python 2.7.x

For projects with bumpversion:

pip install bumpversion

Supported Backends

You can explicitly set which backend to use by defining VERSION_CONTROL_BACKEND in your settings.py. The available backends are:

Git

Requires the GitPython dependency.

VERSION_CONTROL_BACKEND = "version_control.backends.git.GitBackend"

Mercurial

Requires the hglib (or python-hglib) dependency.

VERSION_CONTROL_BACKEND = "version_control.backends.mercurial.MercurialBackend"

Bumpversion

Reads the version directly from your bumpversion configuration.

VERSION_CONTROL_BACKEND = "version_control.bumpversion.BumpversionVersionControlBackend"

Dummy

A basic backend useful for testing or local development environments that lack a version control system.

VERSION_CONTROL_BACKEND = "version_control.dummy.DummyBackend"