template-project/ARCH.md

ARCH - [project name]

Architectural decisions and their reasoning. What components are used, how will they communicate, what libraries are to be used...

Overview

Short description of structure. Diagrams and pictures are helpful.

Tech stack

Brief description of technologies to be used.

For example:

• Pyton, 3.11+, Async support required
• Pytest, 8.x, Testing

Most important architectural decisions.

Examples:

Polling vs events

• Decision: Polling every 10s
• Options: Using interrupts
• Why?: More simple to implement.

File structure

src/ main.py config.py

tests/ tests.py