my eye

Python

A readable, hackable, high-level, open-source, general-purpose programming language.

PEP 8 – Style Guide for Python Code

peps.python.org/pep-0008

  • "code is read much more often than it is written"

  • "use blank lines in functions, sparingly, to indicate logical sections"

PEP 20 – the Zen of Python

peps.python.org/pep-0020

Zen of Python

>>> import this
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than right now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea – let's do more of those!

PEP 257 – Docstring Conventions

peps.python.org/pep-0257

Beyond PEP 8

youtu.be/wf-BqAjZb8M

black/isort

"Black defaults to 88 characters per line, which happens to be 10% over 80. This number was found to produce significantly shorter files than sticking with 80 (the most popular), or even 79 (used by the standard library). In general, 90-ish seems like the wise choice."

radon

pyright

pytest

Doctests

Verifiable console sessions in your documentation strings.

docs.pytest.org/en/7.1.x/how-to/doctest.html

Poetry