Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Static migration conflict checker for Django

Project description

django-migration-checker

https://img.shields.io/pypi/v/django_migration_checker.svg https://img.shields.io/travis/tonyo/django-migration-checker.svg https://coveralls.io/repos/github/tonyo/django-migration-checker/badge.svg?branch=master

The package allows to detect migration conflicts in Django application via static code analysis. In other words, it doesn’t run or import any of your code, but finds and parses Django migration files.

The package should work fine with Python 2.7 and 3.4+, and migrations generated by Django 1.7 and later.

Example:

>>> from django_migration_checker import get_conflicts
>>> get_conflicts(app_dir='./django-project/apps')
[('accounts', ['0001_initial', '0002_new_migration'])]
  • Free software: MIT license

Installation

pip install django-migration-checker

Why?

The initial goal was to have some way to quickly analyze pull requests to a Django project and detect if the new changes introduce migration conflicts if they are merged to master.

Here are a few features:

  • Fast

    No database connections, heavy modules loading, or checks are performed, so why would it be slow?

  • No up-to-date environment needed

    You don’t need to have a working Django environment (valid settings.py file, all installed dependencies, etc.) to use this package. The only requirement is to have properly generated migration files.

  • No dependencies

    The package doesn’t require Django itself, NumPy, left-pad, or any other packages.

Command-line tool

After installing the package you can use the command-line script django-find-conflicts to detect migration conflicts from your console.

Here’s how it looks like:

$ django-find-conflicts ./django-project/apps
[('accounts', ['0001_initial', '0002_new_migration'])]

$ django-find-conflicts ./another-django-project/apps
No conflicts detected.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2016-09-09)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-migration-checker, version 0.5.0
Filename, size File type Python version Upload date Hashes
Filename, size django_migration_checker-0.5.0-py2.py3-none-any.whl (7.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size django-migration-checker-0.5.0.tar.gz (16.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page