Changes
Page history
Include links to example configurations
authored
Mar 03, 2021
by
juga
Show whitespace changes
Inline
Side-by-side
Python-guidelines.md
View page @
d14e5a34
...
...
@@ -16,10 +16,13 @@ Tools to use to automatically test style and/or fix it.
-
[
editorconfig
](
https://editorconfig.org/
)
: helps maintain consistent coding
styles for multiple developers working on the same project across various
editors and IDEs.
editors and IDEs.
[
Example configuration
](
https://gitlab.torproject.org/juga/python_template_minimal/-/blob/main/.editorconfig
)
-
[
Black
](
https://black.readthedocs.io/en/stable/
)
:
mostly follows PEP8, automatic formatter, smallest diffs possible.
Use default configuration except for the maximum number of characters per
line.
[
Example configuration
](
https://gitlab.torproject.org/juga/python_template_minimal/-/blob/main/pyproject.toml
)
-
[
flake8
](
https://flake8.pycqa.org/en/latest/
)
: mostly follows PEP8, linter.
[
Example configuration
](
https://gitlab.torproject.org/juga/python_template_minimal/-/blob/main/.setup.cfg
)
-
[
flake8-docstring
](
https://pypi.org/project/flake8-docstrings/
)
:
follows PEP257.
...
...
@@ -37,9 +40,10 @@ Testing
-
[
pytests
](
https://pytest.org
)
: makes it easy to write small tests.
-
[
tox
](
https://tox.readthedocs.io/
)
: virtualenv-based automation of test
activities.
activities.
[
Example configuration
](
https://gitlab.torproject.org/juga/python_template_minimal/-/blob/main/tox.ini
)
, including testing style and
coverage
-
[
coverage
](
https://coverage.readthedocs.io/
)
: a tool for measuring code
coverage of Python programs.
coverage of Python programs.
[
Example configuration
](
https://gitlab.torproject.org/juga/python_template_minimal/-/blob/main/.coveragerc
)
Packaging
"""""""""
...
...
...
...