Internally, we use a
Python3.7 development environment on
Names that are visible to the user as public parts of the API should follow conventions that reflect usage rather than implementation.
||methods, functions, and modules|
Tabs or Spaces
Always use spaces instead of tabs.
Each indention should be 4 spaces.
Maximum Line Length
The maximum 120 characters.
|Number of Blank Lines After||Language Internals|
Other Styling Stuff
In general, follow PEP-8 guidelines outlined here.
Use a tool like flake8 to improve readability.
- All methods and functions should document their parameters and return types.
- Google Style
- Type-hints should be added to all method and function parameters.
We love open-source software, but a poorly maintained project merged into the
main branch can create
technical debt down the line. If you have a third party dependency make sure it is well maintained.