Changes
Page history
Add Python guidelines page
authored
Feb 24, 2021
by
user
Closes
#22
Show whitespace changes
Inline
Side-by-side
Python-guidelines.md
0 → 100644
View page @
76d3ef4c
Python guidelines
=================
About code style and which tools to use to automatically test style and/or fix
it.
-
[
PEP 8 -- Style Guide for Python Code
](
https://www.python.org/dev/peps/pep-0008/
)
-
[
PEP 257 -- Docstring Conventions
](
https://www.python.org/dev/peps/pep-0257/
)
-
[
PEP 287 -- reStructuredText Docstring Format
](
https://www.python.org/dev/peps/pep-0287/
)
Tools to check and/or fix style
-------------------------------
-
[
editorconfig
](
https://editorconfig.org/
)
: helps maintain consistent coding
styles for multiple developers working on the same project across various
editors and IDEs.
-
[
Black
](
https://black.readthedocs.io/en/stable/
)
:
mostly follows PEP8, automatic formatter, smallest diffs possible.
-
[
flake8
](
https://flake8.pycqa.org/en/latest/
)
: mostly follows PEP8, linter.
-
[
flake8-docstring
](
https://pypi.org/project/flake8-docstrings/
)
:
follows PEP257.
-
[
isort
](
https://pycqa.github.io/isort/
)
: sort imports alphabetically and
automatically separated into sections and by type.
Other tools: https://realpython.com/python-code-quality/
\ No newline at end of file