Add project foundation: configuration, package skeleton, Doxyfile, CI and ADRs

Task: MIL-001#1
Refs #2
Refs #3
Refs #4
Refs #5
Refs #6

src/nato_alphabet/__init__.py

@@ -0,0 +1 @@
+"""@brief Console tool that spells a word with the NATO phonetic alphabet."""

src/nato_alphabet/constants.py

@@ -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:"

src/nato_alphabet/data/nato_phonetic_alphabet.csv

@@ -0,0 +1,27 @@
+letter,code
+A,Alfa
+B,Bravo
+C,Charlie
+D,Delta
+E,Echo
+F,Foxtrot
+G,Golf
+H,Hotel
+I,India
+J,Juliet
+K,Kilo
+L,Lima
+M,Mike
+N,November
+O,Oscar
+P,Papa
+Q,Quebec
+R,Romeo
+S,Sierra
+T,Tango
+U,Uniform
+V,Victor
+W,Whiskey
+X,X-ray
+Y,Yankee
+Z,Zulu