README.md

PythonTemplate

Python GitHub Template

A sample repository with some of my preferred settings baked in, for convenience.

---

Sections

• VS Code
• Overview
  • Usage Guide
• Design and Implementation
  • Library Dependencies
  • Top Level Algorithm
  • Classes
• Error Handling
  • Points of Failiure
  • Input Validation
• Unit Testing
  • Unit Testing Usage Guide
  • Tests

VS Code

Two launch configurations, current file and main.py.

The editor formats automatically on save (using black). Pytest enabled and searching the folder "tests" linting enabled using pylint.

Pytest

configured to target the tests folder and scripts inside it
pytest.ini exists with some basic config. It's also got a sample "ignore" thing targetting the imaginary folder lib

Pylint

in the .pylintrc file, at the top is the list of things to ignore.

---

Readme outline

Executive Summary

• Overview
• Environment setup
• Deployment