Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Note, these are guidelines used by the SCD Cloud Operations Group. They are being presented externally as they may be useful for those developing their own software, they are not being provided with the intention of the Cloud Team reviewing your code - unless you are contributing to one of our repositories.

Style guides refer to a set of standards for writing and formatting code. Having a consistent style guide makes it much easier to understand a large codebase. We recommend using the following style guides.

Python

Python code should follow Generic coding conventions as specified in the Style Guide for Python Code (PEP 8).

...

Black is an opinionated code formatter, it can take your Python code and automatically reformat it to adhere to a strict set of style guidelines. Its a good idea to run black just before you commit and push your code to githubGitHub.