/python-stack-spec

Specifications, standards, guides and conventions related to Python

Before writing any Python code

Python Style Guides

PEP 8 -- Style Guide for Python Code PEP 3000 -- Python 3000

Naming

There is a good article on how to name variable names. Good variable names

Documentation

Write documentation only if you think other developers may have problems with understanding functions, methods, classes, modules or packages.

Do not describe obvious things in documentation like:

#BAD! never do it!

def add(x, y):
    """Returns sum of x and y"""
    return x + y

Docstring style - Google Style Python Docstrings

Commit checklist