Skip to main content

Django extension to inspect validity of migration files

Project description

Django-Migration-Inspector

License

Django-Migration-Inspector is a Python package that allows you to validate Django migrations in the command line.

Features

  • Validates whether Django migration files refer to valid files when defining dependencies or run-after.
  • Validates the depdency graph of the migration tree.
  • Ensured that migration history for the prjoect on DB is linear.
  • Easy to integrate into your Django project.

Installation

You can install Django-Migration-Inspector using pip:

pip install django-migration-inspector

Usage

To use Django-Migration-Inspector, run the following command in your Django project:

!! You must configure INSPECTOR_DATABASES in settings with nested dictionary conataining the options for an individual database.

INSPECTOR_DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.postgresql",
        "NAME": "mydatabase",
        "USER": "mydatabaseuser",
        "PASSWORD": "mypassword",
        "HOST": "127.0.0.1",
        "PORT": "5432",
    }
}
python manage.py inspectmigrations

To run all the migration checks including the migration history validation on the 'default' database.

python manage.py inspectmigrations --skip-history-check

Skips the validation of applied migrations.

Support and Issues

For bug reports, feature requests, or general questions, please use the GitHub Issues.

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-inspector-0.0.1.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

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