Add project foundation: configuration, package skeleton, Doxyfile, CI and ADRs
CI / Test on Python 3.13 (push) Successful in 48s

Task: MIL-001#1
Refs #2
Refs #3
Refs #4
Refs #5
Refs #6
This commit is contained in:
2026-10-13 16:27:37 +08:00
parent b49df1cd33
commit 32a8b848c5
12 changed files with 789 additions and 59 deletions
+29
View File
@@ -0,0 +1,29 @@
"""@brief Constants of the NATO alphabet tool.
Every literal that the program, its messages or its data loading depend on is
defined here once.
"""
## @brief Name of the package that holds the data file.
DATA_PACKAGE: str = "nato_alphabet"
## @brief Folder inside the package that holds the data file.
DATA_DIRECTORY: str = "data"
## @brief Name of the comma-separated values file with the NATO alphabet.
DATA_FILE_NAME: str = "nato_phonetic_alphabet.csv"
## @brief Header of the column with the letter in the data file.
LETTER_COLUMN: str = "letter"
## @brief Header of the column with the code word in the data file.
CODE_COLUMN: str = "code"
## @brief Text shown when the program asks for a word.
PROMPT_TEXT: str = "Enter a word: "
## @brief Text shown when the word holds a character that is not a letter.
INVALID_INPUT_TEXT: str = "Sorry, only the letters A to Z are allowed. Try again."
## @brief Text shown before the code words are printed.
RESULT_TEXT: str = "Phonetic code words:"