Skip to main content

Detect backward incompatible migrations for your django project

Project description

# Django migration linter

Detect backward incompatible migrations for your django project.

## Usage

python migration_linter.py DJANGO_PROJECT_FOLDER [GIT_COMMIT_ID] [–ignore-name-contains=IGNORE_NAME_CONTAINS] [–include-apps INCLUDE_APPS [INCLUDE_APPS …] | –exclude-apps EXCLUDE_APPS [EXCLUDE_APPS …]]

  • DJANGO_PROJECT_FOLDER - an absolute or relative path to the django project.

  • GIT_COMMIT_ID - if specified, only migrations since this commit will be taken into account. If not specified, the initial repo commit will be used.

  • –ignore-name-contains IGNORE_NAME_CONTAINS - ignore migrations containing this name

  • –ignore-name IGNORE_NAME [IGNORE_NAME …] - ignore migrations with exactly one of these names

  • –include-apps INCLUDE_APPS [INCLUDE_APPS …] - check only migrations that are in the specified django apps

  • –exclude-apps EXCLUDE_APPS [EXCLUDE_APPS …] - ignore migrations that are in the specified django apps

  • –verbose or -v - print more information during execution

  • –database DATABASE - specify the database for which to generate the SQL. Defaults to default

## Requirements

Needed software (in PATH):

  • python

  • git

  • UNIX command line tools like tail

The linter will try to detect if the project is a django project and is versioned with git.

## Tests

The easiest way to run the tests is to invoke [py.test](https://docs.pytest.org/en/latest/).

More tests are always welcome.

Project details


Download files

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

Source Distribution

django-migration-linter-0.0.1.tar.gz (6.6 kB view hashes)

Uploaded Source

Built Distribution

django_migration_linter-0.0.1-py2-none-any.whl (11.5 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page