Code standard - GideonJagen/auto-budget GitHub Wiki

The general coding standard for this project follows the Python official coding standard.

variable names

  • Lists: ends with "list", ex. cost_center_list
  • Dictionaries: ends with "dict", ex. cost_center_dict
  • Indexes: ends with "index", ex. column_index
  • Style variables are using caps letters

Formatting

Black and Flake8 are used for automatic formatting.

Code parts

Style dataclass

Contains all style settings for workbook cells stored in variables

AutoBudget class

Code for importing data and building the new workbook. The functions are divided in 3 main parts: Import data, Write data and Style.