Styleguide

TL;DR

Read PEP8 and the Google Styleguide for a general orientation. Most rules should be check by our tooling.

Style

Note

This guide is a work in progress, so if you see something which isn’t addressed or should be changed feel free to crate a Issue/PR to start a discussion on the topic.

Attention

Please search the Issues & PR’s beforehand, to make sure that your case is bringing something new to the table.

How to apply style & coding conventions

1. Apply formatters and linters

2. Check if we have defined an explicit rule on this in the styleguide

3. Consult the Google Styleguide

4. Consult PEP 8

Idioms

• Idioms
  • General
  • Strings
  • Looping
  • Dictionaries
  • Separation of Concerns

References & Further Reading

• Google Styleguide

• PEP 8

• Python Idioms

• Python Like You Mean It

• Python Programming Idioms

Talks

• Transform Code into Beautiful, Idiomatic Python

• Stop Writing Classes

• Refactoring Python