Rename to linter

This commit is contained in:
david_wobrock committed 2017-04-05 14:41:44 +02:00
1 parent 69cf2fe7b5
commit 3b7d567d72
3 files changed
+17 -19

No files matched your search

+6 -9
View File
@@ -1,10 +1,10 @@
# Django migration checker
# Django migration linter
Detect backward incompatible migrations for your django projects. All in one file.
Detect backward incompatible migrations for your django project. All in one file.
## Usage
`python migration_checker.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 ...]]`
`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.
@@ -20,20 +20,17 @@ Needed software (in PATH):
* `git`
* UNIX command line tools like `tail`
The checker will try to detect whether if the project is a django project and is versioned with git.
The linter will try to detect whether if the project is a django project and is versioned with git.
## Tests
Launch the tests with: `python -m unittest test_migration_checker`
Launch the tests with: `python -m unittest test_migration_linter`
More test are to be written.
## Improvements
* Add an appropriate license
* More tests (always!)
* Detect data migration (not only scheme migrations)
* Detection dependent on specified database (mysql, postgresql, ...)
## Credits
[3YOURMIND GmbH](https://www.3yourmind.com)