https://github.com/bukosabino/python-good-practices
Swiss army knife for Python good practices code style
https://github.com/bukosabino/python-good-practices
Last synced: 17 days ago
JSON representation
Swiss army knife for Python good practices code style
- Host: GitHub
- URL: https://github.com/bukosabino/python-good-practices
- Owner: bukosabino
- License: gpl-3.0
- Created: 2020-02-06T12:29:28.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T15:31:52.000Z (about 1 year ago)
- Last Synced: 2025-03-26T00:43:56.534Z (about 1 month ago)
- Language: Makefile
- Size: 64.5 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Swiss army knife for Python good practices code style
This show how to configure any python project to follow good practices code style.
Some features:
* mypy
* pylint
* black
* coverage
* isort
* sphinx
### Install dependencies
```bash
make init
```
### Check python type hints
```bash
make typehint
```
### Check if the code is standard
```bash
make lint
```
### Check the order of imports
```bash
make isort
```
### Sort the imports
```bash
make isort-fix
```
### Test package post checks
```bash
make test
```
### Generate Sphinx automated documentation
```bash
make doc
```
### Format the python code following Python Software Foundation style
```bash
make format-fix
```
### Generate UML diagrams
```bash
make reverse-uml
```