-
Notifications
You must be signed in to change notification settings - Fork 226
coding guidelines
Jörg Stucke edited this page May 7, 2018
·
3 revisions
- Do not use features above Python 3.5
-
PEP8 code style shall be used.
- Exception: Lines may be as long as needed (--ignore=E501)
- We use pytest for testing. Please use the following pytest config:
[pytest]
addopts = --pep8 -v --cov=./
pep8ignore =
*.py E501
- Test coverage should be as high as possible (at least 95%).
- Do not mix quotation: Use ' single quotes ' at all time.
-
(__main__)
programs must have a return value: use sys.exit() -
(__main__)
programs shall provide --version (-v) and --help (-h) command line options: use argparse - Dates should be formated according to ISO 8601: YYYY-MM-DD
- Type Hints (in accordance with PEP 484) are encouraged (in places where they are helpful) but will not be enforced