Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rocioar/flake8-django
A flake8 plugin to detect bad practices on Django projects.
https://github.com/rocioar/flake8-django
Last synced: 3 months ago
JSON representation
A flake8 plugin to detect bad practices on Django projects.
- Host: GitHub
- URL: https://github.com/rocioar/flake8-django
- Owner: rocioar
- License: gpl-3.0
- Created: 2018-09-27T19:31:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T09:53:22.000Z (9 months ago)
- Last Synced: 2024-05-16T12:15:30.330Z (6 months ago)
- Language: Python
- Homepage:
- Size: 196 KB
- Stars: 178
- Watchers: 7
- Forks: 30
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-flake8-extensions - flake8-django - Plugin for Django projects. (Library-specific checks)
README
# flake8-django
[](https://pypi.python.org/pypi/flake8-django/)
[](https://codecov.io/gh/rocioar/flake8-django)
[](https://pepy.tech/project/flake8-django)
A flake8 plugin to detect bad practices on Django projects.
## Installation
Install from pip with:
```
$ pip install flake8-django
```
## Testing
flake8-django uses pytest for tests. To run them use:
```
$ pytest
````
Run coverage report using:
```
$ pytest --cov=.
```
## List of Rules
| Rule | Description |
| ---- | ----------- |
| [`DJ01`](https://github.com/rocioar/flake8-django/wiki/%5BDJ01%5D-Avoid-using-null=True-on-string-based-fields-such-as-CharField-and-TextField) | Avoid using null=True on string-based fields such as CharField and TextField |
| [`DJ03`](https://github.com/rocioar/flake8-django/wiki/%5BDJ03%5D-Avoid-passing-locals()-as-context-to-a-render-function) | Avoid passing locals() as context to a render function |
| [`DJ06`](https://github.com/rocioar/flake8-django/wiki/%5BDJ06%5D-Do-not-use-exclude-with-ModelForm,-use-fields-instead) | Do not use exclude with ModelForm, use fields instead |
| [`DJ07`](https://github.com/rocioar/flake8-django/wiki/%5BDJ07%5D-Do-not-set-fields-to-'__all__'-on-ModelForm,-use-fields-instead) | Do not use `__all__` with ModelForm, use fields instead |
| [`DJ08`](https://github.com/rocioar/flake8-django/wiki/%5BDJ08%5D-Model-does-not-define-__str__-method) | Model does not define `__str__` method |
| [`DJ12`](https://github.com/rocioar/flake8-django/wiki/%5BDJ12%5D-Order-of-Model's-inner-classes,-methods,-and-fields-does-not-follow-the-Django-Style-Guide) | Order of Model's inner classes, methods, and fields does not follow the [Django Style Guide](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#model-style) |
| [`DJ13`](https://github.com/rocioar/flake8-django/wiki/DJ13---@receiver-decorator-must-be-on-top-of-all-the-other-decorators) | @receiver decorator must be on top of all the other decorators |
More details about each of the Rules can be found on the [wiki page](https://github.com/rocioar/flake8-django/wiki).
## Optional Rules - Disabled by Default
| Rule | Description |
| ---- | ----------- |
| [`DJ10`](https://github.com/rocioar/flake8-django/wiki/%5BDJ10%5D-Model-should-define-verbose_name-on-its-Meta-inner-class) | Model should define verbose_name on its Meta inner class |
| [`DJ11`](https://github.com/rocioar/flake8-django/wiki/%5BDJ11%5D-Model-should-define-verbose_name_plural-on-its-Meta-inner-class) | Model should define verbose_name_plural on its Meta inner class |
To enable optional rules you can use the `--select` parameter. It's default values are: E,F,W,C90.
For example, if you wanted to enable `DJ10`, you could call `flake8` in the following way:
```
flake8 --select=E,F,W,C90,DJ,DJ10
```
You could also add it to your configuration file:
```
[flake8]
max-line-length = 120
...
select = C,E,F,W,DJ,DJ10
```
## Licence
GPL
## Thanks
[@stummjr](https://github.com/stummjr) for teaching me AST, and what I could do with it. His [blog](https://stummjr.org/post/building-a-custom-flake8-plugin/) is cool.