Style Guide

TODO

https://google.github.io/styleguide/pyguide.html

Checklist

1

Notes

More brackets rarely affect readability, less brackets can cause undefined behaviour.

Reference

  • Maintains a familar make/makefile structure.
  • Portable across operating systems.
  • Provides command line interface tool.

Checklist

  • Shebang directive (#!/usr/bin/env python)
  • File encoding (# -*- coding: utf-8 -*-)
  • Module docstring.
  • Import statements.
  • Class docstrings.
  • Variable casting to expected type.

codecov? code climate?