Metadata-Version: 2.1
Name: pre-commit-hooks-django
Version: 0.4.0
Summary: Some useful hooks for Django development
Home-page: https://github.com/ecugol/pre-commit-hooks-django
Author: Ivan Vedernikov
Author-email: ecugol@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
License-File: LICENSE

pre-commit-hooks-django
================

Some useful hooks for Django development

See also: https://github.com/pre-commit/pre-commit

### Using pre-commit-hooks-django with pre-commit

Add this to your `.pre-commit-config.yaml`

```yaml
-   repo: https://github.com/ecugol/pre-commit-hooks-django
    rev: v0.4.0  # Use the ref you want to point at
    hooks:
    -   id: check-untracked-migrations
        # Optional, if specified, hook will work only on these branches
        # otherwise it will work on all branches
        args: ["--branches", "main", "other_branch"]
    -   id: check-unapplied-migrations
    -   id: check-absent-migrations
    -   id: po-location-format
        # Mandatory, select one of the following options:
        # file: show only the file path as location
        # never: remove all locations
        args: ["--add-location", "file"]
```

### Hooks available

#### `check-untracked-migrations`

Forbids commit if untracked migrations files are found (e.g. `*/migrations/0001_initial.py`)

##### Options:
    --branches

    Optional, if specified, hook will work only on these branches
    otherwise it will work on all branches

#### `check-unapplied-migrations`

*WARNING: USE ONLY WITH DJANGO > v3.1*

Check for unapplied migrations with manage.py migrate --check

#### `check-absent-migrations`

Check for absent migrations with manage.py makemigrations --check --dry-run

#### `po-location-format`

Changes location format for .po files

##### Options:

    --add-location [file, never]

    Mandatory, select one of the following options:

    file: show only the file path as location
    never: remove all locations


