# flake8-django-migrations
<p align="center">
<a href="https://github.com/browniebroke/flake8-django-migrations/actions/workflows/ci.yml?query=branch%3Amain">
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/browniebroke/flake8-django-migrations/ci.yml?branch=main&label=CI&logo=github&style=flat-square">
</a>
<a href="https://codecov.io/gh/browniebroke/flake8-django-migrations">
<img src="https://img.shields.io/codecov/c/github/browniebroke/flake8-django-migrations.svg?logo=codecov&style=flat-square" alt="Test coverage percentage">
</a>
</p>
<p align="center">
<a href="https://python-poetry.org/">
<img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
</a>
<a href="https://github.com/ambv/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
</a>
</p>
<p align="center">
<a href="https://pypi.org/project/flake8-django-migrations/">
<img src="https://img.shields.io/pypi/v/flake8-django-migrations.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPi Status">
</a>
<img src="https://img.shields.io/pypi/pyversions/flake8-django-migrations.svg?style=flat-square" alt="pyversions">
<img src="https://img.shields.io/pypi/l/flake8-django-migrations.svg?style=flat-square" alt="license">
</p>
Flake8 plugin to lint for backwards incompatible database migrations.
## Installation
Install using `pip` (or your favourite package manager):
```sh
pip install flake8-django-migrations
```
## Usage
This plugin should be used automatically when running flake8:
```sh
flake8
```
## Checks
This is the list of checks currently implemented by this plugin.
### DM001
`RemoveField` operation should be wrapped in `SeparateDatabaseAndState`.
Such an operation should be run in two separate steps, using `SeparateDatabaseAndState`, otherwise it is not backwards compatible.
- Step 1: remove the field from the model and code. For foreign key fields, the foreign key constraint should also be dropped.
- Step 2: remove the column from the database.
#### Bad
```python
class Migration(migrations.Migration):
operations = [
migrations.RemoveField(
model_name="order",
name="total",
),
]
```
#### Good
```python
class Migration(migrations.Migration):
operations = [
migrations.SeparateDatabaseAndState(
state_operations=[
migrations.RemoveField(
model_name="order",
name="total",
),
],
),
]
```
Raw data
{
"_id": null,
"home_page": "https://github.com/browniebroke/flake8-django-migrations",
"name": "flake8-django-migrations",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "flake8,lint,django,migrations",
"author": "Bruno Alla",
"author_email": "bruno.alla@festicket.com",
"download_url": "https://files.pythonhosted.org/packages/7c/f1/d74474aa62f389df6a6eed499ce7b7b71c3376f8b55d56bf46b2a86260cd/flake8_django_migrations-1.0.0.tar.gz",
"platform": null,
"description": "# flake8-django-migrations\n\n<p align=\"center\">\n <a href=\"https://github.com/browniebroke/flake8-django-migrations/actions/workflows/ci.yml?query=branch%3Amain\">\n <img alt=\"CI Status\" src=\"https://img.shields.io/github/actions/workflow/status/browniebroke/flake8-django-migrations/ci.yml?branch=main&label=CI&logo=github&style=flat-square\">\n </a>\n <a href=\"https://codecov.io/gh/browniebroke/flake8-django-migrations\">\n <img src=\"https://img.shields.io/codecov/c/github/browniebroke/flake8-django-migrations.svg?logo=codecov&style=flat-square\" alt=\"Test coverage percentage\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://python-poetry.org/\">\n <img src=\"https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=\" alt=\"Poetry\">\n </a>\n <a href=\"https://github.com/ambv/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square\" alt=\"black\">\n </a>\n <a href=\"https://github.com/pre-commit/pre-commit\">\n <img src=\"https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square\" alt=\"pre-commit\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://pypi.org/project/flake8-django-migrations/\">\n <img src=\"https://img.shields.io/pypi/v/flake8-django-migrations.svg?logo=python&logoColor=fff&style=flat-square\" alt=\"PyPi Status\">\n </a>\n <img src=\"https://img.shields.io/pypi/pyversions/flake8-django-migrations.svg?style=flat-square\" alt=\"pyversions\">\n <img src=\"https://img.shields.io/pypi/l/flake8-django-migrations.svg?style=flat-square\" alt=\"license\">\n</p>\n\nFlake8 plugin to lint for backwards incompatible database migrations.\n\n## Installation\n\nInstall using `pip` (or your favourite package manager):\n\n```sh\npip install flake8-django-migrations\n```\n\n## Usage\n\nThis plugin should be used automatically when running flake8:\n\n```sh\nflake8\n```\n\n## Checks\n\nThis is the list of checks currently implemented by this plugin.\n\n### DM001\n\n`RemoveField` operation should be wrapped in `SeparateDatabaseAndState`.\n\nSuch an operation should be run in two separate steps, using `SeparateDatabaseAndState`, otherwise it is not backwards compatible.\n\n- Step 1: remove the field from the model and code. For foreign key fields, the foreign key constraint should also be dropped.\n- Step 2: remove the column from the database.\n\n#### Bad\n\n```python\nclass Migration(migrations.Migration):\n operations = [\n migrations.RemoveField(\n model_name=\"order\",\n name=\"total\",\n ),\n ]\n```\n\n#### Good\n\n```python\nclass Migration(migrations.Migration):\n operations = [\n migrations.SeparateDatabaseAndState(\n state_operations=[\n migrations.RemoveField(\n model_name=\"order\",\n name=\"total\",\n ),\n ],\n ),\n ]\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flake8 plugin to lint for backwards incompatible database migrations",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/browniebroke/flake8-django-migrations",
"Repository": "https://github.com/browniebroke/flake8-django-migrations"
},
"split_keywords": [
"flake8",
"lint",
"django",
"migrations"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6e47efd88e37e5c59717c1d60f19e950d0bcbf0e944cd58d8c93db6bd25cddd6",
"md5": "b0c88f05e70b8688bc38d975fce4bbb8",
"sha256": "838971daee6ab86e883a5bf9eab92a6f553a7eb2b60f2c43ee12975f2b192a06"
},
"downloads": -1,
"filename": "flake8_django_migrations-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b0c88f05e70b8688bc38d975fce4bbb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 5617,
"upload_time": "2023-06-27T12:25:36",
"upload_time_iso_8601": "2023-06-27T12:25:36.919682Z",
"url": "https://files.pythonhosted.org/packages/6e/47/efd88e37e5c59717c1d60f19e950d0bcbf0e944cd58d8c93db6bd25cddd6/flake8_django_migrations-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7cf1d74474aa62f389df6a6eed499ce7b7b71c3376f8b55d56bf46b2a86260cd",
"md5": "e03a95e9541a31d70a1ec0177bf249ad",
"sha256": "f3f2a72d97159c3e86fba0581c85d9dd19b5a5872cff92f788ccbd8fdb435df7"
},
"downloads": -1,
"filename": "flake8_django_migrations-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e03a95e9541a31d70a1ec0177bf249ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4092,
"upload_time": "2023-06-27T12:25:37",
"upload_time_iso_8601": "2023-06-27T12:25:37.919805Z",
"url": "https://files.pythonhosted.org/packages/7c/f1/d74474aa62f389df6a6eed499ce7b7b71c3376f8b55d56bf46b2a86260cd/flake8_django_migrations-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 12:25:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "browniebroke",
"github_project": "flake8-django-migrations",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flake8-django-migrations"
}
JSON
