Files
026-nato-alphabet/wiki/Development.md
Tirsvad d932c7fa4f
CI / Test on Python 3.13 (push) Successful in 55s
Add README, screenshots and wiki in English, Danish and Bahasa Malaysia
Task: MIL-003#1
Task: MIL-003#2
Refs #14
Refs #15
Refs #16
Refs #17
Refs #18
2026-10-13 16:45:01 +08:00

1.2 KiB

Development

🌐 English · Dansk · Bahasa Melayu

Set up the project first (Install). The dev extra installs pytest, ruff, mypy and import-linter.

Run the tests

python -m pytest

Run the checks that CI runs

python -m ruff check .
python -m mypy
lint-imports

Build the source documentation

doxygen Doxyfile

Open build/html/index.html. Install Doxygen from doxygen.nl or your package manager.

Code layout

Folder Content
src/nato_alphabet/domain/ The spelling rule, with no input or output
src/nato_alphabet/application/ The use case and its ports
src/nato_alphabet/adapters/ The CSV reader and the console
src/nato_alphabet/constants.py Every literal of the program
tests/ pytest tests, mirroring src/

Dependencies point inward: adapters know the application, the application knows the domain. import-linter enforces it.

Pull requests

One branch and one pull request per milestone; CI must be green. The project follows the SQA and QC framework in framework/; see docs/ for the plan and the review records.