Skip to main content

A Django library to automatically format your migrations.

Project description

django-migrations-formatter

GitHub Workflow Status (branch) Codecov branch Version License Python Versions Django Versions

This Django library will format Django migrations using black and isort.

Installation

Start by installing django-migrations-formatter from PyPI:

(env)$ python -m pip install django-migrations-formatter

You will also need to make sure to have black and/or isort installed. Without them, this library doesn't provide any value. For ease of use, you can install either of them by including them as "extras" during the installation.

(env)$ python -m pip install "django-migrations-formatter[black,isort]"

Then you need to add django_migrations_formatter.apps.MigrationsFormatter to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...,
    'django_migrations_formatter.apps.MigrationsFormatter',
]

Contributing

The project uses black and isort for formatting its code. flake8 is used for linting. All these are combined into pre-commit to run before each commit and push. To set it up:

(env)$ python -m pip install '.[black,dev,isort,test]'
(env)$ pre-commit install -t pre-commit -t pre-push --install-hooks

To run the unit tests:

(env)$ django-admin test --pythonpath . -v 2 --settings=tests.settings

If you spot an problem, please open an issue on GitHub.

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-migrations-formatter-1.0.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file django-migrations-formatter-1.0.0.tar.gz.

File metadata

  • Download URL: django-migrations-formatter-1.0.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for django-migrations-formatter-1.0.0.tar.gz
Algorithm Hash digest
SHA256 229b14d5cdfb32d329437691854cea139aa493ad6cb6eaa0194227686b2f61d4
MD5 5ef7e25ed8b9f1a422d7619e0e84ee9b
BLAKE2b-256 3fb35deb5808160102632aa6b4d193088932eeecf2ac82126a146bbdb813106e

See more details on using hashes here.

Provenance

File details

Details for the file django_migrations_formatter-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: django_migrations_formatter-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for django_migrations_formatter-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 122773e221bfa7d3e0d395a3e7640af7063c9800560b27eee4e1b0a0e32413e0
MD5 782804aa0970e9c901347a470ded4d3d
BLAKE2b-256 9d4766cc63dfa4c145af6e91cbb06f88fc2c381035edf368f4ac3d2478e6dd5b

See more details on using hashes here.

Provenance

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