Needed and up-to-date tools to develop in Python
Project description
Python Dev Tools
Needed and up-to-date tools to develop in Python (WORK IN PROGRESS)
Documentation
The full documentation can be read at https://python-dev-tools.readthedocs.io.
Installation
Install pipx if not yet installed: https://pipxproject.github.io/pipx/installation/
Then in a terminal, run:
$ pipx install python-dev-toolsThen add the new bin directory to the path. On Linux for instance, run:
$ TOOLS_PATH=$(ls -l ~/.local/bin/whataformatter | sed -e "s/.*-> //" | sed -e "s#/bin.*#/bin#")
$ userpath prepend $TOOLS_PATHFull documentation on installation: https://python-dev-tools.readthedocs.io/en/latest/installation.html
That’s it! Use the provided linter, formatter and precommit hook where applicable.
Upgrade
If not using pipx, follow again the installation procedure.
If using pipx (preferred installation method), run in a terminal:
$ pipx upgrade python-dev-toolsInstallation with Visual Studio Code
Follow the installation procedure for python-dev-tools
Be sure to have the official Python extension installed in VS Code
In VS Code, open settings (F1 key, then type “Open Settings (JSON)”, then enter)
Add in the opened JSON file:
"python.linting.enabled": true,
"python.linting.flake8Enabled": true,
"python.linting.flake8Path": "~/.local/bin/whatalinter",
"python.formatting.provider": "black",
"python.formatting.blackPath": "~/.local/bin/whataformatter",
"python.formatting.blackArgs": [],Adapt the previous path according to your installation.
Features
Integrate features of commonly used tools. This package provides usual dependencies to develop Python software.
Simple linter
whatalinter a_python_file.py lints a_python_file.py
output is compatible with the one of pycodestyle (formerly named pep8) for easy integration in text editors and IDE
based on
pycodestyle: https://github.com/PyCQA/pycodestyle
pyflakes: https://github.com/PyCQA/pyflakes
mccabe: https://github.com/pycqa/mccabe
pydocstyle: https://github.com/PyCQA/pydocstyle
flake8 and plugins: https://gitlab.com/pycqa/flake8
flake8-2020: https://github.com/asottile/flake8-2020
flake8-bandit: https://github.com/tylerwince/flake8-bandit
flake8-broken-line: https://github.com/sobolevn/flake8-broken-line
flake8-bugbear: https://github.com/PyCQA/flake8-bugbear
flake8-builtins: https://github.com/gforcada/flake8-builtins
flake8-comprehensions: https://github.com/adamchainz/flake8-comprehensions
flake8-debugger: https://github.com/JBKahn/flake8-debugger
flake8-fixme: https://github.com/tommilligan/flake8-fixme
flake8-isort: https://github.com/gforcada/flake8-isort
flake8-logging-format: https://github.com/globality-corp/flake8-logging-format
flake8-mutable: https://github.com/ebeweber/flake8-mutable
flake8-variables-names: https://github.com/best-doctor/flake8-variables-names
pep8-naming: https://github.com/PyCQA/pep8-naming
Simple formatter
whataformatter a_python_file.py formats a_python_file.py
based on
autoflake: https://github.com/myint/autoflake
pyupgrade: https://github.com/asottile/pyupgrade
Simple precommit hook
TODO
License
BSD 3-Clause license, feel free to contribute: https://python-dev-tools.readthedocs.io/en/latest/contributing.html.
TODO
documentation
precommit
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
2019.10.22
Add flake8-2020 linter
2019.07.21
Add –quiet and –diff flags to whataformatter for VS Code compatibility
2019.07.20
Add black formatter
Add autoflake formatter
Add pyupgrade formatter
2019.04.08
Add flake8 linter
Add flake8-isort linter
Add pep8-naming linter
Add flake8-comprehensions linter
Add flake8-logging-format linter
Add flake8-bugbear linter
Add flake8-builtins linter
Add flake8-broken-line linter
Add flake8-fixme linter
Add flake8-mutable linter
Add flake8-debugger linter
Add flake8-variables-names linter
Add flake8-bandit linter
2019.03.02
Add pydocstyle linter
2019.03.01
Add McCabe complexity checker
2019.02.26
Add pyflakes linter
Add pycodestyle linter
2019.02.23
First release on PyPI.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file python_dev_tools-2019.11.20.tar.gz.
File metadata
- Download URL: python_dev_tools-2019.11.20.tar.gz
- Upload date:
- Size: 18.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.8.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 95c73610559158d7794a7bed026c510364dc9f1f56e318b47e40480ca2d7647a |
|
| MD5 | a4236275b5c94b939ed8ac713f4fd492 |
|
| BLAKE2b-256 | a189aed6b533adcf0d24621f11744779b2dfe3182170e13f60f389a4c1334fc4 |
File details
Details for the file python_dev_tools-2019.11.20-py2.py3-none-any.whl.
File metadata
- Download URL: python_dev_tools-2019.11.20-py2.py3-none-any.whl
- Upload date:
- Size: 14.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.8.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 11ecf0cda8c9c4a07f9454376dce02594f3c359492694aac821207496314a47e |
|
| MD5 | 34a232b511135b6dbaf6905112f442b7 |
|
| BLAKE2b-256 | 149b2197a37fd89a9b93c322689ac075f8bd37e94be3af3a3ba4204d53239805 |
