diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7f8a072 --- /dev/null +++ b/.gitignore @@ -0,0 +1,30 @@ +# Python +__pycache__/ +*.py[cod] +*.egg-info/ +build/ +dist/ +.pytest_cache/ +.coverage +htmlcov/ + +# Virtual environments +.venv/ +venv/ +env/ + +# Local secrets (personal tooling only, never part of the project) +.env +.env.* + +# Generated documentation +docs/doxygen/ + +# AI prompt log (the repository is public) +/docs/ai-prompts/ + +# Editors and OS +.idea/ +.vscode/ +.DS_Store +Thumbs.db diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..7a8550e --- /dev/null +++ b/Doxyfile @@ -0,0 +1,374 @@ +# Doxyfile 1.15.0 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = "Flask Day 54" +PROJECT_NUMBER = +PROJECT_BRIEF = "100 Days of Code: Flask basics, command line, __main__, first-class functions, decorators" +PROJECT_LOGO = +PROJECT_ICON = +OUTPUT_DIRECTORY = docs/doxygen +CREATE_SUBDIRS = NO +CREATE_SUBDIRS_LEVEL = 8 +ALLOW_UNICODE_NAMES = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +JAVADOC_BANNER = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +PYTHON_DOCSTRING = YES +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 4 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = YES +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +OPTIMIZE_OUTPUT_SLICE = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +MARKDOWN_STRICT = YES +TOC_INCLUDE_HEADINGS = 6 +MARKDOWN_ID_STYLE = DOXYGEN +AUTOLINK_SUPPORT = YES +AUTOLINK_IGNORE_WORDS = +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +GROUP_NESTED_COMPOUNDS = NO +SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = NO +TYPEDEF_HIDES_STRUCT = NO +LOOKUP_CACHE_SIZE = 0 +NUM_PROC_THREADS = 1 +TIMESTAMP = NO +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_PRIV_VIRTUAL = NO +EXTRACT_PACKAGE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO +RESOLVE_UNNAMED_PARAMS = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_UNDOC_NAMESPACES = YES +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = SYSTEM +HIDE_SCOPE_NAMES = NO +HIDE_COMPOUND_REFERENCE= NO +SHOW_HEADERFILE = YES +SHOW_INCLUDE_FILES = YES +SHOW_GROUPED_MEMB_INC = NO +FORCE_LOCAL_INCLUDES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = +EXTERNAL_TOOL_PATH = +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_IF_INCOMPLETE_DOC = YES +WARN_NO_PARAMDOC = NO +WARN_IF_UNDOC_ENUM_VAL = NO +WARN_LAYOUT_FILE = YES +WARN_AS_ERROR = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LINE_FORMAT = "at line $line of file $file" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = src +INPUT_ENCODING = UTF-8 +INPUT_FILE_ENCODING = +FILE_PATTERNS = *.py +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +USE_MDFILE_AS_MAINPAGE = +IMPLICIT_DIR_DOCS = YES +FORTRAN_COMMENT_AFTER = 72 +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +SOURCE_TOOLTIPS = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +CLANG_ASSISTED_PARSING = NO +CLANG_ADD_INC_PATHS = YES +CLANG_OPTIONS = +CLANG_DATABASE_PATH = +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE = AUTO_LIGHT +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = NO +HTML_CODE_FOLDING = YES +HTML_COPY_CLIPBOARD = YES +HTML_PROJECT_COOKIE = +HTML_INDEX_NUM_ENTRIES = 100 +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_FEEDURL = +DOCSET_BUNDLE_ID = org.doxygen.Project +DOCSET_PUBLISHER_ID = org.doxygen.Publisher +DOCSET_PUBLISHER_NAME = Publisher +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +SITEMAP_URL = +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.doxygen.Project +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = +GENERATE_ECLIPSEHELP = NO +ECLIPSE_DOC_ID = org.doxygen.Project +DISABLE_INDEX = NO +GENERATE_TREEVIEW = YES +PAGE_OUTLINE_PANEL = YES +FULL_SIDEBAR = NO +ENUM_VALUES_PER_LINE = 4 +SHOW_ENUM_VALUES = NO +TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = NO +OBFUSCATE_EMAILS = YES +HTML_FORMULA_FORMAT = png +FORMULA_FONTSIZE = 10 +FORMULA_MACROFILE = +USE_MATHJAX = NO +MATHJAX_VERSION = MathJax_2 +MATHJAX_FORMAT = HTML-CSS +MATHJAX_RELPATH = +MATHJAX_EXTENSIONS = +MATHJAX_CODEFILE = +SEARCHENGINE = YES +SERVER_BASED_SEARCH = NO +EXTERNAL_SEARCH = NO +SEARCHENGINE_URL = +SEARCHDATA_FILE = searchdata.xml +EXTERNAL_SEARCH_ID = +EXTRA_SEARCH_MAPPINGS = +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = +MAKEINDEX_CMD_NAME = makeindex +LATEX_MAKEINDEX_CMD = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4 +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = +LATEX_EXTRA_STYLESHEET = +LATEX_EXTRA_FILES = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +LATEX_BIB_STYLE = plainnat +LATEX_EMOJI_DIRECTORY = +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +RTF_EXTRA_FILES = +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_SUBDIR = +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_PROGRAMLISTING = YES +XML_NS_MEMB_FILE_SCOPE = NO +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- +GENERATE_DOCBOOK = NO +DOCBOOK_OUTPUT = docbook +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to Sqlite3 output +#--------------------------------------------------------------------------- +GENERATE_SQLITE3 = NO +SQLITE3_OUTPUT = sqlite3 +SQLITE3_RECREATE_DB = YES +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +EXTERNAL_PAGES = YES +#--------------------------------------------------------------------------- +# Configuration options related to diagram generator tools +#--------------------------------------------------------------------------- +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = NO +DOT_NUM_THREADS = 0 +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +UML_LIMIT_NUM_FIELDS = 10 +UML_MAX_EDGE_LABELS = 10 +DOT_UML_DETAILS = NO +DOT_WRAP_THRESHOLD = 17 +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DIR_GRAPH_MAX_DEPTH = 1 +DOT_IMAGE_FORMAT = png +INTERACTIVE_SVG = NO +DOT_PATH = +DOTFILE_DIRS = +DIA_PATH = +DIAFILE_DIRS = +PLANTUML_JAR_PATH = +PLANTUML_CFG_FILE = +PLANTUML_INCLUDE_PATH = +PLANTUMLFILE_DIRS = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +MSCGEN_TOOL = +MSCFILE_DIRS = diff --git a/README.md b/README.md index ea9597a..98b9cf9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,124 @@ -# 054-flask - +# ๐Ÿš€ Flask Day 54: 100 Days of Code + +Runnable, tested solutions for Day 54 of Udemy's "100 Days of Code: The Complete Python Pro Bootcamp": a first Flask server, the command line, `__name__` and `__main__`, functions as first-class objects, and decorators. It is written for fellow course participants and for visitors who want a readable example. + +## ๐Ÿ“š Table of Contents + +- [Overview](#-overview) +- [Requirements](#-requirements) +- [Setup](#-setup) +- [Run](#-run) +- [Tests](#-tests) +- [License](#-license) +- [Links](#-links) +- [Appendix: Project documents](#-appendix-project-documents) + +## ๐Ÿงญ Overview + +The repository holds one small module per lecture step. + +| Folder | What it holds | +| --- | --- | +| `src/flask_day_54/` | The lecture code in four layers: `domain`, `application`, `infrastructure`, `presentation` (see ADR-0001); each layer keeps its constants in `constants.py` | +| `tests/` | pytest tests: `unit/` for `domain` and `application`, `e2e/` for the Flask application | +| `docs/` | Project documents, the screenshots in `docs/images/` and the wiki sources in `docs/wiki/` | + +Doxygen comments in the source describe every public name; `Doxyfile` builds them into `docs/doxygen/`. + +## ๐Ÿ“‹ Requirements + +- Python 3.13 or newer, because the project sets `requires-python = ">=3.13"` in `pyproject.toml`. +- `venv`, which is part of Python, to keep the packages in a local `.venv`. +- Flask (the optional `web` extra) only for the web lectures. The pure-Python lectures need no package. +- pytest (the `dev` extra) to run the tests. +- Doxygen, optional, to build the API documentation. + +## ๐Ÿ› ๏ธ Setup + +Create and use a local `.venv`, then upgrade pip and install the project in editable mode. + +Windows (PowerShell): + +```powershell +python -m venv .venv +.\.venv\Scripts\Activate.ps1 +python -m pip install --upgrade pip +python -m pip install -e ".[dev]" +``` + +macOS and Linux: + +```bash +python3 -m venv .venv +source .venv/bin/activate +python -m pip install --upgrade pip +python -m pip install -e ".[dev]" +``` + +Leave the environment with `deactivate`. The `.venv` folder is ignored by git. Install only `.[web]` if you do not need pytest. + +## โ–ถ๏ธ Run + +The lecture code is added milestone by milestone. Once the Flask application exists, start the server with either: + +```bash +flask --app flask_day_54.presentation.hello run +python -m flask_day_54.presentation.hello +``` + +Then open `http://127.0.0.1:5000/`. Stop the server with `Ctrl+C`. + +## ๐Ÿงช Tests + +```bash +python -m pytest +``` + +Optional style checks (the `dev` extra installs ruff): + +```bash +python -m ruff format --check src tests +python -m ruff check src tests +``` + +## ๐Ÿ“„ License + +GNU Affero General Public License v3.0, see [LICENSE][license]. + +## ๐Ÿ”— Links + +- [Repository][repository] +- [Documentation][documentation] +- [Issue tracker][issues] + +## ๐Ÿ“Ž Appendix: Project documents + +| Document | What it tells you | +| --- | --- | +| [AGENTS.md][agents] | The rules AI agents follow in this repository | +| [Business Case][BC-001] | Why the project exists, its scope and success criteria | +| [Stakeholder Analysis][SA-001] | Who is involved; the stakeholder IDs used for owners and reviewers | +| [Project Plan][PP-001] | The gateways and their schedule | +| [Milestones][milestones] | One document per gateway: Go/No-Go criteria and tasks | +| [Artifact registry][registry] | Where each artifact type lives, the next version, the PO language and domain | +| [Domain dictionary][DICT-001] | The PO terms and the IT terms | +| [Traceability matrix][TM-001] | How the artifacts link and when each was last reviewed | +| [Framework README][framework-readme] | The framework this project uses | +| [Framework changelog][framework-changelog] | What changed in each framework release | + +--- + +[license]: ./LICENSE +[repository]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask +[documentation]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/wiki +[issues]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/issues +[agents]: ./AGENTS.md +[BC-001]: ./docs/business-case.md +[SA-001]: ./docs/stakeholder-analysis.md +[PP-001]: ./docs/project-plan.md +[milestones]: ./docs/milestones/ +[registry]: ./docs/artifact-registry.md +[DICT-001]: ./docs/dictionary.md +[TM-001]: ./docs/sqa/traceability-matrix.md +[framework-readme]: ./framework/README.md +[framework-changelog]: ./framework/CHANGELOG.md diff --git a/docs/adr/adr-0001-layered-package-layout.md b/docs/adr/adr-0001-layered-package-layout.md new file mode 100644 index 0000000..1c90a49 --- /dev/null +++ b/docs/adr/adr-0001-layered-package-layout.md @@ -0,0 +1,61 @@ +# ADR-0001 Layered package layout under src/flask_day_54 + +## Metadata +| Key | Value | +| --- | --- | +| ID | ADR-0001 | +| CrossReference | [BC-001], [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [0f4e36b] | + +Allowed Status values: `Proposed`, `Accepted`, `Rejected`, `Deprecated`, `Superseded by ADR-NNNN`. + +--- + +## Context + +The Python quality checklist (QC-PY-001, criterion 17) and the `clean-architecture` skill ask for source in the layers `domain`, `application`, `infrastructure` and `presentation`, and tests in `unit`, `integration` and `e2e`. The lectures are small, and the first plan named flat modules such as `src/hello.py`. Forces: the checklist is mandatory; the lecture names (`hello.py`, `calculate`) must stay visible to course participants (S02); the repository should stay easy to read (S03); `domain` must import no framework. + +Options: + +1. Flat modules in `src/`, with an ADR that merges all layers. The checklist forbids merging `domain` with code that does input or output, and a flat layout hides the idea of the dependency rule. +2. Layered package `src/flask_day_54//`, one module per lecture topic, tests in `tests/unit` and `tests/e2e`. + +## Decision + +Use option 2: the package `flask_day_54` with the layers `domain`, `application`, `infrastructure` and `presentation`. The pure lecture code (`first_class_functions`, `decorators`, `name_demo`, `cli_basics`) is in `domain`, the greeting use case in `application`, the server settings in `infrastructure`, and the Flask application `hello.py` in `presentation`. Each layer that needs constants has its own `constants.py`. `tests/unit` tests `domain` and `application`; `tests/e2e` tests the Flask application through its test client; `tests/integration` is created only when a test needs it. + +## Consequences + +**Positive:** + +- The code meets QC-PY-001 criterion 17 without a merged layer. +- `domain` is importable and testable with no package installed (no Flask), which serves S03. +- The lecture module names are kept inside their layers. + +**Negative:** + +- Longer import and run paths: `flask --app flask_day_54.presentation.hello run` instead of `flask run` in a folder with `hello.py`. +- More folders than a lecture of this size strictly needs. + +## Affected Artifacts + +- [MIL-001] โ€” paths and `constants.py` locations change +- [MIL-002] โ€” `hello.py` lives in `presentation` +- [MIL-003] โ€” the `__main__` start command and `name_demo` / `cli_basics` locations change +- [MIL-004] โ€” the lecture modules live in `domain` +- [BC-001] โ€” scope and constraints unchanged +- [PP-001] โ€” gateways and dates unchanged + +--- + +[BC-001]: ../business-case.md +[PP-001]: ../project-plan.md +[MIL-001]: ../milestones/mil-001-foundation.md +[MIL-002]: ../milestones/mil-002-hello-flask.md +[MIL-003]: ../milestones/mil-003-cli-and-main.md +[MIL-004]: ../milestones/mil-004-functions-decorators.md +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/artifact-registry.md b/docs/artifact-registry.md index 0d753eb..ab689fb 100644 --- a/docs/artifact-registry.md +++ b/docs/artifact-registry.md @@ -15,9 +15,10 @@ document of a type. `Primary File` may contain a glob (e.g. | SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 | | PP | Project Plan | docs/project-plan.md | 002 | | MIL | Milestone / Gateway | docs/milestones/mil-*.md | 006 | +| ADR | Architecture Decision Record | docs/adr/adr-NNNN-*.md | 0002 | | DICT | Domain Dictionary | docs/dictionary.md | 002 | | TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 | -| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 010 | +| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 016 | ## Languages diff --git a/docs/milestones/mil-001-foundation.md b/docs/milestones/mil-001-foundation.md index a01415e..56356a4 100644 --- a/docs/milestones/mil-001-foundation.md +++ b/docs/milestones/mil-001-foundation.md @@ -4,14 +4,15 @@ | Key | Value | | --- | --- | | ID | MIL-001 | -| CrossReference | [BC-001] | +| CrossReference | [BC-001], [ADR-0001] | | Language | en | | Domain | it | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [73a5a95] | +| 2026-11-06 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [73a5a95] | +| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | S01 | Paths follow the layered layout of ADR-0001 | [0f4e36b] | --- @@ -21,7 +22,7 @@ Decide whether the project skeleton (configuration, tooling, documentation basel ## Deliverable -A repository with `pyproject.toml`, `.gitignore`, `src/constants.py`, a Doxyfile, a README with `.venv` instructions, the repository description and topics, and a passing (empty-but-collecting) pytest run. +A repository with `pyproject.toml`, `.gitignore`, `constants.py` files in the `domain` and `infrastructure` layers of `src/flask_day_54/`, a Doxyfile, a README with `.venv` instructions, the repository description and topics, and a passing (empty-but-collecting) pytest run. ## Go / No-Go Criteria @@ -64,8 +65,8 @@ A repository with `pyproject.toml`, `.gitignore`, `src/constants.py`, a Doxyfile | --- | --- | --- | --- | --- | | 1 | Add pyproject.toml | Configure the project with requires-python >=3.13, the optional extras `web` (Flask) and `dev` (pytest), and pytest settings so tests import modules from `src/`. Keeps the pure-Python lectures free of runtime dependencies (SA-001 CN-006). | No | | | 2 | Add Python .gitignore | Ignore virtual environments, caches, build output, Doxygen output and the personal `.env` file so no token can be committed. | No | | -| 3 | Add constants.py and package layout | Create `src/constants.py` for all constants (greeting, host, port, command names) and the empty `tests/` folder, as the constraints require constants in one place. | No | | -| 4 | Add Doxyfile | Generate a Doxyfile that reads `src/`, writes to `docs/doxygen/` (ignored by git) and extracts documentation from Doxygen comments. | No | | +| 3 | Add constants.py and package layout | Create `constants.py` files in the `domain` and `infrastructure` layers of `src/flask_day_54/` for all constants (greeting, host, port, command names) and the empty `tests/` folder, as the constraints require constants in one place. | No | | +| 4 | Add Doxyfile | Generate a Doxyfile that reads `src/` (the `flask_day_54` package), writes to `docs/doxygen/` (ignored by git) and extracts documentation from Doxygen comments. | No | | | 5 | Write README from the framework template | Use the framework README template; describe creating and activating a local `.venv`, running `python -m pip install --upgrade pip`, installing extras, running the app and running pytest. | No | | | 6 | Set repository description and topics | Use the Gitea REST API with the token from the author's environment (never stored in the repository) to set a description and topics so visitors (S03) can find and understand the repository. | No | | | 7 | Record the AI prompt log | Add `docs/ai-prompts/session-001/` as `framework/process/ai-prompt-log.md` requires. | No | | @@ -73,4 +74,6 @@ A repository with `pyproject.toml`, `.gitignore`, `src/constants.py`, a Doxyfile --- [BC-001]: ../business-case.md +[ADR-0001]: ../adr/adr-0001-layered-package-layout.md [73a5a95]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/73a5a95d28db041e4f27342cc552e18f7d386410 +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/milestones/mil-002-hello-flask.md b/docs/milestones/mil-002-hello-flask.md index 5be5b2d..38526c8 100644 --- a/docs/milestones/mil-002-hello-flask.md +++ b/docs/milestones/mil-002-hello-flask.md @@ -4,14 +4,15 @@ | Key | Value | | --- | --- | | ID | MIL-002 | -| CrossReference | [BC-001] | +| CrossReference | [BC-001], [ADR-0001] | | Language | en | | Domain | it | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [73a5a95] | +| 2026-11-06 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [73a5a95] | +| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | S01 | Paths follow the layered layout of ADR-0001 | [0f4e36b] | --- @@ -21,13 +22,13 @@ Decide whether lectures 1 and 2 (frontend versus backend, and the first Flask se ## Deliverable -`src/hello.py` with a Flask `app` and a home route returning the greeting, tests of that route, a screenshot for lecture 1 (client, server, database and the request-response cycle) and for lecture 2 (the browser showing the greeting), and README text for both. +`src/flask_day_54/presentation/hello.py` with a Flask `app` and a home route returning the greeting, tests of that route, a screenshot for lecture 1 (client, server, database and the request-response cycle) and for lecture 2 (the browser showing the greeting), and README text for both. ## Go / No-Go Criteria | # | Criterion (objectively checkable) | Go | No-Go | | --- | --- | --- | --- | -| 1 | `flask --app hello run` serves the greeting on the configured port | Met | Not met | +| 1 | `flask --app flask_day_54.presentation.hello run` serves the greeting on the configured port | Met | Not met | | 2 | A pytest test requests `/` with the Flask test client and gets status 200 and the greeting | Met | Not met | | 3 | Screenshots `lecture-01.png` and `lecture-02.png` exist in `docs/images/` and are shown in the README | Met | Not met | | 4 | Doxygen comments exist on every public name in `hello.py` | Met | Not met | @@ -69,4 +70,6 @@ Decide whether lectures 1 and 2 (frontend versus backend, and the first Flask se --- [BC-001]: ../business-case.md +[ADR-0001]: ../adr/adr-0001-layered-package-layout.md [73a5a95]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/73a5a95d28db041e4f27342cc552e18f7d386410 +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/milestones/mil-003-cli-and-main.md b/docs/milestones/mil-003-cli-and-main.md index a4c008e..73377f0 100644 --- a/docs/milestones/mil-003-cli-and-main.md +++ b/docs/milestones/mil-003-cli-and-main.md @@ -4,14 +4,15 @@ | Key | Value | | --- | --- | | ID | MIL-003 | -| CrossReference | [BC-001] | +| CrossReference | [BC-001], [ADR-0001] | | Language | en | | Domain | it | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [73a5a95] | +| 2026-11-06 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [73a5a95] | +| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | S01 | Paths follow the layered layout of ADR-0001 | [0f4e36b] | --- @@ -21,13 +22,13 @@ Decide whether lectures 3 and 4 (the command line and the `__name__` / `__main__ ## Deliverable -`hello.py` starts through `python src/hello.py` guarded by `if __name__ == "__main__"`, `src/cli_basics.py` and `src/name_demo.py` with tests, and screenshots for lectures 3 and 4. +`hello.py` starts through `python -m flask_day_54.presentation.hello` guarded by `if __name__ == "__main__"`, `src/flask_day_54/domain/cli_basics.py` and `src/flask_day_54/domain/name_demo.py` with tests, and screenshots for lectures 3 and 4. ## Go / No-Go Criteria | # | Criterion (objectively checkable) | Go | No-Go | | --- | --- | --- | --- | -| 1 | `python src/hello.py` starts the server; importing `hello` does not start it (tested) | Met | Not met | +| 1 | `python -m flask_day_54.presentation.hello` starts the server; importing `flask_day_54.presentation.hello` does not start it (tested) | Met | Not met | | 2 | `name_demo` reports the main program versus an imported module (tested) | Met | Not met | | 3 | `cli_basics` lists the lecture's commands with their Windows and macOS/Linux forms (tested) | Met | Not met | | 4 | Screenshots `lecture-03.png` and `lecture-04.png` exist in `docs/images/` and are shown in the README | Met | Not met | @@ -64,10 +65,12 @@ Decide whether lectures 3 and 4 (the command line and the `__name__` / `__main__ | 2 | Add name_demo module | Add a function that explains whether a module name means the file is the main program or an import, mirroring lecture 4, with tests. | No | | | 3 | Add cli_basics module | Add the lecture's commands (pwd, ls, cd, mkdir, touch, rm) with Windows and macOS/Linux equivalents and a warning for destructive ones, with tests. | No | | | 4 | Screenshot lecture 3: command line | Run the lecture's commands in a temporary folder, render the real transcript and capture it headlessly. | No | | -| 5 | Screenshot lecture 4: __main__ and app.run | Capture the real output of `python src/name_demo.py` and of the server start from `python src/hello.py`. | No | | -| 6 | README section for lectures 3 and 4 | Add the two screenshots and the two ways to start the server (`flask run` versus `python src/hello.py`). | No | | +| 5 | Screenshot lecture 4: __main__ and app.run | Capture the real output of `python -m flask_day_54.domain.name_demo` and of the server start from `python -m flask_day_54.presentation.hello`. | No | | +| 6 | README section for lectures 3 and 4 | Add the two screenshots and the two ways to start the server (`flask run` versus `python -m flask_day_54.presentation.hello`). | No | | --- [BC-001]: ../business-case.md +[ADR-0001]: ../adr/adr-0001-layered-package-layout.md [73a5a95]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/73a5a95d28db041e4f27342cc552e18f7d386410 +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/milestones/mil-004-functions-decorators.md b/docs/milestones/mil-004-functions-decorators.md index 18d613c..695982c 100644 --- a/docs/milestones/mil-004-functions-decorators.md +++ b/docs/milestones/mil-004-functions-decorators.md @@ -4,14 +4,15 @@ | Key | Value | | --- | --- | | ID | MIL-004 | -| CrossReference | [BC-001] | +| CrossReference | [BC-001], [ADR-0001] | | Language | en | | Domain | it | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [73a5a95] | +| 2026-11-06 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [73a5a95] | +| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | S01 | Paths follow the layered layout of ADR-0001 | [0f4e36b] | --- @@ -21,7 +22,7 @@ Decide whether lectures 5 and 6 (functions as first-class objects, nested and re ## Deliverable -`src/first_class_functions.py` (`add`, `subtract`, `calculate`, nested and returned functions) and `src/decorators.py` (the @ syntax) with tests, and screenshots for lectures 5 and 6. +`src/flask_day_54/domain/first_class_functions.py` (`add`, `subtract`, `calculate`, nested and returned functions) and `src/flask_day_54/domain/decorators.py` (the @ syntax) with tests, and screenshots for lectures 5 and 6. ## Go / No-Go Criteria @@ -70,4 +71,6 @@ Decide whether lectures 5 and 6 (functions as first-class objects, nested and re --- [BC-001]: ../business-case.md +[ADR-0001]: ../adr/adr-0001-layered-package-layout.md [73a5a95]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/73a5a95d28db041e4f27342cc552e18f7d386410 +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/sqa/reviews/rc-010-adr-0001.md b/docs/sqa/reviews/rc-010-adr-0001.md new file mode 100644 index 0000000..2592a8a --- /dev/null +++ b/docs/sqa/reviews/rc-010-adr-0001.md @@ -0,0 +1,55 @@ +# Review of ADR-0001 + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-010 | +| CrossReference | [ADR-0001], [QC-ADR-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-11-06 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [0f4e36b] | + +--- + +## Artifact Under Review + +- Instance reviewed: [ADR-0001] +- Checklist used: [QC-ADR-001] +- Scope: full review +- Language and domain: n/a +- Language reviewer: none (the reviewer reads English and knows the IT domain) +- Mode: autonomous, not independent (AI as stand-in for S01) + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | The ID (`ADR-NNNN`, 4-digit) matches the filename number and is unique and sequential | Pass | ADR-0001 matches adr-0001-layered-package-layout.md; first ADR. | +| 2 | Context states the problem, the forces (cost, risk, constraints) and the options evaluated | Pass | Context gives the forces and two options. | +| 3 | At least two options were considered, or the absence of alternatives is justified | Pass | Two options evaluated. | +| 4 | Decision is stated in one or two unhedged sentences and matches one of the evaluated options | Pass | Decision is two sentences and equals option 2. | +| 5 | Consequences list both Positive and Negative outcomes | Pass | Positive and Negative lists present. | +| 6 | Quality-attribute impacts (performance, security, portability, etc.) are named where the decision affects them | Pass | Flexibility and portability of domain code named. | +| 7 | Affected Artifacts are listed as links, and each is also in CrossReference | Pass | Affected artifacts are links and all are in CrossReference. | +| 8 | Status changes are recorded as new Version History rows with a Change summary and Commit link; retained rows are never rewritten | Pass | Version History row with change summary; commit link resolved after commit. | +| 9 | A superseded or deprecated ADR names its successor, and the successor links back | N-A | Nothing superseded. | +| 10 | Written in business or technical language of the domain, with no unexplained abbreviations | Pass | Technical English, no unexplained abbreviations. | +| 11 | Status is one of `Proposed`, `Accepted`, `Rejected`, `Deprecated` or `Superseded by ADR-NNNN`, and every Version History row uses only these | Pass | Status values valid. | + +## Overall Verdict + +Go โ€” All criteria pass. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | S01 | - | + +--- + +[ADR-0001]: ../../adr/adr-0001-layered-package-layout.md +[QC-ADR-001]: ../../../framework/qc/artifacts/qc-adr.md +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/sqa/reviews/rc-011-mil-001-foundation-delta.md b/docs/sqa/reviews/rc-011-mil-001-foundation-delta.md new file mode 100644 index 0000000..c27e441 --- /dev/null +++ b/docs/sqa/reviews/rc-011-mil-001-foundation-delta.md @@ -0,0 +1,66 @@ +# Review of MIL-001 + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-011 | +| CrossReference | [MIL-001], [QC-MIL-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-11-06 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [0f4e36b] | + +--- + +## Artifact Under Review + +- Instance reviewed: [MIL-001] +- Checklist used: [QC-MIL-001] +- Scope: full review (re-review after the change) +- Language and domain: en / it +- Language reviewer: none (the reviewer reads English and knows the IT domain) +- Mode: autonomous, not independent (AI as stand-in for S01) + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | A concrete deliverable is defined for every gate | Pass | Deliverable now names the layered paths of ADR-0001. | +| 2 | Explicit Go/No-Go criteria are stated for each gate | Pass | Go/No-Go criteria updated to the new start commands and remain checkable. | +| 3 | Dependencies on other milestones are explicitly mapped | Pass | Dependencies unchanged. | +| 4 | Each milestone is traceable to a Business Case objective or KPI | Pass | Traceability unchanged. | +| 5 | Milestone owner and approving reviewer are identified | Pass | S01. | +| 6 | Milestone has a defined target date consistent with project constraints | Pass | Date unchanged and inside the plan window. | + +## Language and Domain Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | The Metadata table has a `Language` row and a `Domain` row, and neither is a placeholder | Pass | Checked against the document and the registry. | +| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list | Pass | Checked against the document and the registry. | +| 3 | The content (prose and table cells) is written in the stated language | Pass | All prose and table cells are English, the PO language (registry `PO language` = en). | +| 4 | The register matches the one the registry gives for the artifact type | Pass | Register: IT Executive English for BC/PP/MIL, IT Professional English for SA/DICT; no implementation detail in the executive documents beyond file names. | +| 5 | Domain terms are the PO terms of the domain's dictionary, with no synonyms | Pass | Terms follow `docs/dictionary.md` (DICT-001): greeting, home page, lecture step, local environment, wrapper. | +| 6 | Metadata keys, section headings, IDs and statuses are in English | Pass | Checked against the document and the registry. | +| 7 | No translated twin (`..md`) exists beside the document | Pass | No `*.en.md` or other translated twin exists. | +| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again | Pass | First version; no earlier language to compare. | +| 9 | A reviewer competent in the domain, and in the language, has confirmed that the domain terms are used correctly | Pass | Reviewer S01 reads English and works in the IT domain (stand-in, not independent). | +| 10 | Abbreviations are spelled out on first use, in the stated language | Pass | FURPS+, BC, SA etc. are defined by the framework; ISO/IEC 25010 named in full. | + +## Overall Verdict + +Go โ€” Re-review of the whole checklist after paths changed per ADR-0001 (RC-010); all criteria pass. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | S01 | - | + +--- + +[MIL-001]: ../../milestones/mil-001-foundation.md +[QC-MIL-001]: ../../../framework/qc/artifacts/qc-milestones-gateways.md +[QC-LANG-001]: ../../../framework/qc/artifacts/qc-language-domain.md +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/sqa/reviews/rc-012-mil-002-hello-flask-delta.md b/docs/sqa/reviews/rc-012-mil-002-hello-flask-delta.md new file mode 100644 index 0000000..b6947d1 --- /dev/null +++ b/docs/sqa/reviews/rc-012-mil-002-hello-flask-delta.md @@ -0,0 +1,66 @@ +# Review of MIL-002 + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-012 | +| CrossReference | [MIL-002], [QC-MIL-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-11-06 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [0f4e36b] | + +--- + +## Artifact Under Review + +- Instance reviewed: [MIL-002] +- Checklist used: [QC-MIL-001] +- Scope: full review (re-review after the change) +- Language and domain: en / it +- Language reviewer: none (the reviewer reads English and knows the IT domain) +- Mode: autonomous, not independent (AI as stand-in for S01) + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | A concrete deliverable is defined for every gate | Pass | Deliverable now names the layered paths of ADR-0001. | +| 2 | Explicit Go/No-Go criteria are stated for each gate | Pass | Go/No-Go criteria updated to the new start commands and remain checkable. | +| 3 | Dependencies on other milestones are explicitly mapped | Pass | Dependencies unchanged. | +| 4 | Each milestone is traceable to a Business Case objective or KPI | Pass | Traceability unchanged. | +| 5 | Milestone owner and approving reviewer are identified | Pass | S01. | +| 6 | Milestone has a defined target date consistent with project constraints | Pass | Date unchanged and inside the plan window. | + +## Language and Domain Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | The Metadata table has a `Language` row and a `Domain` row, and neither is a placeholder | Pass | Checked against the document and the registry. | +| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list | Pass | Checked against the document and the registry. | +| 3 | The content (prose and table cells) is written in the stated language | Pass | All prose and table cells are English, the PO language (registry `PO language` = en). | +| 4 | The register matches the one the registry gives for the artifact type | Pass | Register: IT Executive English for BC/PP/MIL, IT Professional English for SA/DICT; no implementation detail in the executive documents beyond file names. | +| 5 | Domain terms are the PO terms of the domain's dictionary, with no synonyms | Pass | Terms follow `docs/dictionary.md` (DICT-001): greeting, home page, lecture step, local environment, wrapper. | +| 6 | Metadata keys, section headings, IDs and statuses are in English | Pass | Checked against the document and the registry. | +| 7 | No translated twin (`..md`) exists beside the document | Pass | No `*.en.md` or other translated twin exists. | +| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again | Pass | First version; no earlier language to compare. | +| 9 | A reviewer competent in the domain, and in the language, has confirmed that the domain terms are used correctly | Pass | Reviewer S01 reads English and works in the IT domain (stand-in, not independent). | +| 10 | Abbreviations are spelled out on first use, in the stated language | Pass | FURPS+, BC, SA etc. are defined by the framework; ISO/IEC 25010 named in full. | + +## Overall Verdict + +Go โ€” Re-review of the whole checklist after paths changed per ADR-0001 (RC-010); all criteria pass. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | S01 | - | + +--- + +[MIL-002]: ../../milestones/mil-002-hello-flask.md +[QC-MIL-001]: ../../../framework/qc/artifacts/qc-milestones-gateways.md +[QC-LANG-001]: ../../../framework/qc/artifacts/qc-language-domain.md +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/sqa/reviews/rc-013-mil-003-cli-and-main-delta.md b/docs/sqa/reviews/rc-013-mil-003-cli-and-main-delta.md new file mode 100644 index 0000000..f92d3c7 --- /dev/null +++ b/docs/sqa/reviews/rc-013-mil-003-cli-and-main-delta.md @@ -0,0 +1,66 @@ +# Review of MIL-003 + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-013 | +| CrossReference | [MIL-003], [QC-MIL-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-11-06 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [0f4e36b] | + +--- + +## Artifact Under Review + +- Instance reviewed: [MIL-003] +- Checklist used: [QC-MIL-001] +- Scope: full review (re-review after the change) +- Language and domain: en / it +- Language reviewer: none (the reviewer reads English and knows the IT domain) +- Mode: autonomous, not independent (AI as stand-in for S01) + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | A concrete deliverable is defined for every gate | Pass | Deliverable now names the layered paths of ADR-0001. | +| 2 | Explicit Go/No-Go criteria are stated for each gate | Pass | Go/No-Go criteria updated to the new start commands and remain checkable. | +| 3 | Dependencies on other milestones are explicitly mapped | Pass | Dependencies unchanged. | +| 4 | Each milestone is traceable to a Business Case objective or KPI | Pass | Traceability unchanged. | +| 5 | Milestone owner and approving reviewer are identified | Pass | S01. | +| 6 | Milestone has a defined target date consistent with project constraints | Pass | Date unchanged and inside the plan window. | + +## Language and Domain Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | The Metadata table has a `Language` row and a `Domain` row, and neither is a placeholder | Pass | Checked against the document and the registry. | +| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list | Pass | Checked against the document and the registry. | +| 3 | The content (prose and table cells) is written in the stated language | Pass | All prose and table cells are English, the PO language (registry `PO language` = en). | +| 4 | The register matches the one the registry gives for the artifact type | Pass | Register: IT Executive English for BC/PP/MIL, IT Professional English for SA/DICT; no implementation detail in the executive documents beyond file names. | +| 5 | Domain terms are the PO terms of the domain's dictionary, with no synonyms | Pass | Terms follow `docs/dictionary.md` (DICT-001): greeting, home page, lecture step, local environment, wrapper. | +| 6 | Metadata keys, section headings, IDs and statuses are in English | Pass | Checked against the document and the registry. | +| 7 | No translated twin (`..md`) exists beside the document | Pass | No `*.en.md` or other translated twin exists. | +| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again | Pass | First version; no earlier language to compare. | +| 9 | A reviewer competent in the domain, and in the language, has confirmed that the domain terms are used correctly | Pass | Reviewer S01 reads English and works in the IT domain (stand-in, not independent). | +| 10 | Abbreviations are spelled out on first use, in the stated language | Pass | FURPS+, BC, SA etc. are defined by the framework; ISO/IEC 25010 named in full. | + +## Overall Verdict + +Go โ€” Re-review of the whole checklist after paths changed per ADR-0001 (RC-010); all criteria pass. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | S01 | - | + +--- + +[MIL-003]: ../../milestones/mil-003-cli-and-main.md +[QC-MIL-001]: ../../../framework/qc/artifacts/qc-milestones-gateways.md +[QC-LANG-001]: ../../../framework/qc/artifacts/qc-language-domain.md +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/sqa/reviews/rc-014-mil-004-functions-decorators-delta.md b/docs/sqa/reviews/rc-014-mil-004-functions-decorators-delta.md new file mode 100644 index 0000000..fddd0e5 --- /dev/null +++ b/docs/sqa/reviews/rc-014-mil-004-functions-decorators-delta.md @@ -0,0 +1,66 @@ +# Review of MIL-004 + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-014 | +| CrossReference | [MIL-004], [QC-MIL-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-11-06 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [0f4e36b] | + +--- + +## Artifact Under Review + +- Instance reviewed: [MIL-004] +- Checklist used: [QC-MIL-001] +- Scope: full review (re-review after the change) +- Language and domain: en / it +- Language reviewer: none (the reviewer reads English and knows the IT domain) +- Mode: autonomous, not independent (AI as stand-in for S01) + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | A concrete deliverable is defined for every gate | Pass | Deliverable now names the layered paths of ADR-0001. | +| 2 | Explicit Go/No-Go criteria are stated for each gate | Pass | Go/No-Go criteria updated to the new start commands and remain checkable. | +| 3 | Dependencies on other milestones are explicitly mapped | Pass | Dependencies unchanged. | +| 4 | Each milestone is traceable to a Business Case objective or KPI | Pass | Traceability unchanged. | +| 5 | Milestone owner and approving reviewer are identified | Pass | S01. | +| 6 | Milestone has a defined target date consistent with project constraints | Pass | Date unchanged and inside the plan window. | + +## Language and Domain Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | The Metadata table has a `Language` row and a `Domain` row, and neither is a placeholder | Pass | Checked against the document and the registry. | +| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list | Pass | Checked against the document and the registry. | +| 3 | The content (prose and table cells) is written in the stated language | Pass | All prose and table cells are English, the PO language (registry `PO language` = en). | +| 4 | The register matches the one the registry gives for the artifact type | Pass | Register: IT Executive English for BC/PP/MIL, IT Professional English for SA/DICT; no implementation detail in the executive documents beyond file names. | +| 5 | Domain terms are the PO terms of the domain's dictionary, with no synonyms | Pass | Terms follow `docs/dictionary.md` (DICT-001): greeting, home page, lecture step, local environment, wrapper. | +| 6 | Metadata keys, section headings, IDs and statuses are in English | Pass | Checked against the document and the registry. | +| 7 | No translated twin (`..md`) exists beside the document | Pass | No `*.en.md` or other translated twin exists. | +| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again | Pass | First version; no earlier language to compare. | +| 9 | A reviewer competent in the domain, and in the language, has confirmed that the domain terms are used correctly | Pass | Reviewer S01 reads English and works in the IT domain (stand-in, not independent). | +| 10 | Abbreviations are spelled out on first use, in the stated language | Pass | FURPS+, BC, SA etc. are defined by the framework; ISO/IEC 25010 named in full. | + +## Overall Verdict + +Go โ€” Re-review of the whole checklist after paths changed per ADR-0001 (RC-010); all criteria pass. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | S01 | - | + +--- + +[MIL-004]: ../../milestones/mil-004-functions-decorators.md +[QC-MIL-001]: ../../../framework/qc/artifacts/qc-milestones-gateways.md +[QC-LANG-001]: ../../../framework/qc/artifacts/qc-language-domain.md +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/sqa/reviews/rc-015-code-mil-001-foundation.md b/docs/sqa/reviews/rc-015-code-mil-001-foundation.md new file mode 100644 index 0000000..27e9d1f --- /dev/null +++ b/docs/sqa/reviews/rc-015-code-mil-001-foundation.md @@ -0,0 +1,62 @@ +# Review of MIL-001 + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-015 | +| CrossReference | [MIL-001], [QC-PY-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-11-06 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [0f4e36b] | + +--- + +## Artifact Under Review + +- Instance reviewed: [MIL-001] +- Checklist used: [QC-PY-001] +- Scope: full review of the source and tests delivered by MIL-001 (src/, tests/) +- Language and domain: n/a +- Language reviewer: none (the reviewer reads English and knows the IT domain) +- Mode: autonomous, not independent (AI as stand-in for S01) + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | Packages, modules, functions, variables, classes and constants follow PEP 8 casing (`snake_case`, `PascalCase`, `UPPER_SNAKE`) | Pass | Modules, functions and constants use snake_case / UPPER_SNAKE; classes none or PascalCase. | +| 2 | Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes | Pass | Names follow the lecture and the domain dictionary. | +| 3 | Code is produced by the project's formatter and passes its linter with no unexplained suppressions | Pass | `ruff format` leaves files unchanged and `ruff check` (E, F, I, B, UP) passes; configured in pyproject.toml. | +| 4 | Every function and method signature is type-annotated, including `-> None` | Pass | Every function signature is annotated, including `-> None`. | +| 5 | No bare `except:`, no swallowed exceptions; specific exceptions are raised and the cause is kept (`raise ... from`) | Pass | No bare except and no swallowed exception. | +| 6 | No mutable default arguments and no shadowed builtins | Pass | No mutable defaults; no builtin shadowed. | +| 7 | Files, locks and connections are managed with context managers | N-A | No file, lock or connection is opened. | +| 8 | Public modules, classes and functions have docstrings that say what, not how | Pass | Module and public names carry docstrings plus Doxygen comments. | +| 9 | Logging uses `logging`, not `print`; no secrets or personal data in log output | N-A | The code writes nothing to a log; no secrets handled. | +| 10 | Classes and operations trace to the Design Class Diagram they implement; deviations are recorded | N-A | No DCD exists in this project; the layered layout is recorded in ADR-0001. | +| 11 | Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network | Pass | pytest tests named for behaviour; no order or network dependence. | +| 12 | Type checker runs in strict mode without errors; `Any` is justified in a comment | N-A | No type checker is configured (optional criterion). | +| 13 | Dependencies are declared and pinned in the project's dependency file, none unused | Pass | Dependencies are declared in pyproject.toml; none unused (Flask is the optional `web` extra). | +| 14 | Each piece of knowledge (a business rule, constant, format, validation or query) is defined in one place; code is merged only where it expresses the same knowledge, not where it merely looks alike | Pass | Each constant is defined once in the constants.py of its layer. | +| 15 | Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles | Pass | `domain` imports no framework or outer layer; imports point inward; no cycles. | +| 16 | SOLID holds: a class or module has one reason to change; new behaviour is added by extension, not by editing a type test in several places; subclasses honour the contract of their base; protocols are narrow; high-level code depends on protocols or abstract types and receives its implementations | Pass | Small modules with one reason to change; no type tests or subclass hierarchies. | +| 17 | Source is laid out in the layers and folders of the clean architecture folder structure (`domain`, `application`, `infrastructure`, `presentation` packages under `src/`, and `unit`, `integration` and `e2e` under `tests/`), in `snake_case`, and imports between the layers point inward | Pass | Layers domain, application, infrastructure, presentation under src/flask_day_54; tests in unit and e2e (ADR-0001); no layer merged. | +| 18 | File and folder names are English, contain no space and no character outside letters, digits, `-`, `_` and `.`, and follow the casing of the language for files | Pass | English snake_case file names without spaces. | + +## Overall Verdict + +Go โ€” All applicable mandatory criteria pass. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | S01 | - | + +--- + +[MIL-001]: ../../milestones/mil-001-foundation.md +[QC-PY-001]: ../../../framework/qc/code/qc-programming-python.md +[0f4e36b]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/0f4e36b68282be23a71aa6684af01ca85a1e9473 diff --git a/docs/sqa/traceability-matrix.md b/docs/sqa/traceability-matrix.md index 2515a64..3f51887 100644 --- a/docs/sqa/traceability-matrix.md +++ b/docs/sqa/traceability-matrix.md @@ -26,11 +26,12 @@ updated whenever an artifact instance is created or reviewed. | [BC-001] | BC | en | it | - | [SA-001], [PP-001] | [RC-001] | | [SA-001] | SA | en | it | [BC-001] | [BC-001] | [RC-002] | | [PP-001] | PP | en | it | [BC-001], [SA-001] | [MIL-001] to [MIL-005] | [RC-003] | +| [ADR-0001] | ADR | - | - | [BC-001], [PP-001] | [MIL-001] to [MIL-004] | [RC-010] | | [DICT-001] | DICT | en | it | [BC-001], [SA-001] | - | [RC-004] | -| [MIL-001] | MIL | en | it | [BC-001], [PP-001] | - | [RC-005] | -| [MIL-002] | MIL | en | it | [BC-001], [PP-001] | - | [RC-006] | -| [MIL-003] | MIL | en | it | [BC-001], [PP-001] | - | [RC-007] | -| [MIL-004] | MIL | en | it | [BC-001], [PP-001] | - | [RC-008] | +| [MIL-001] | MIL | en | it | [BC-001], [PP-001], [ADR-0001] | - | [RC-011] | +| [MIL-002] | MIL | en | it | [BC-001], [PP-001], [ADR-0001] | - | [RC-012] | +| [MIL-003] | MIL | en | it | [BC-001], [PP-001], [ADR-0001] | - | [RC-013] | +| [MIL-004] | MIL | en | it | [BC-001], [PP-001], [ADR-0001] | - | [RC-014] | | [MIL-005] | MIL | en | it | [BC-001], [PP-001] | - | [RC-009] | ## Concern Coverage @@ -53,10 +54,13 @@ updated whenever an artifact instance is created or reviewed. --- +--- + [BC-001]: ../business-case.md [SA-001]: ../stakeholder-analysis.md [PP-001]: ../project-plan.md [DICT-001]: ../dictionary.md +[ADR-0001]: ../adr/adr-0001-layered-package-layout.md [MIL-001]: ../milestones/mil-001-foundation.md [MIL-002]: ../milestones/mil-002-hello-flask.md [MIL-003]: ../milestones/mil-003-cli-and-main.md @@ -71,4 +75,8 @@ updated whenever an artifact instance is created or reviewed. [RC-007]: ./reviews/rc-007-mil-003-cli-and-main.md [RC-008]: ./reviews/rc-008-mil-004-functions-decorators.md [RC-009]: ./reviews/rc-009-mil-005-docs-wiki.md -[73a5a95]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/054-flask/commit/73a5a95d28db041e4f27342cc552e18f7d386410 +[RC-010]: ./reviews/rc-010-adr-0001.md +[RC-011]: ./reviews/rc-011-mil-001-foundation-delta.md +[RC-012]: ./reviews/rc-012-mil-002-hello-flask-delta.md +[RC-013]: ./reviews/rc-013-mil-003-cli-and-main-delta.md +[RC-014]: ./reviews/rc-014-mil-004-functions-decorators-delta.md diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..7ee545d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,34 @@ +[build-system] +requires = ["setuptools>=68"] +build-backend = "setuptools.build_meta" + +[project] +name = "flask-day-54" +version = "0.1.0" +description = "Udemy 100 Days of Code, Day 54: Flask basics, command line, __main__, first-class functions and decorators." +readme = "README.md" +requires-python = ">=3.13" +license = "AGPL-3.0-only" +authors = [{ name = "Jens Tirsvad Nielsen" }] +# No mandatory runtime dependency: the pure-Python lectures need nothing installed. +dependencies = [] + +[project.optional-dependencies] +web = ["flask>=3.0"] +dev = ["pytest>=8.0", "flask>=3.0", "ruff>=0.6"] + +[tool.setuptools.packages.find] +where = ["src"] + +[tool.pytest.ini_options] +pythonpath = ["src"] +testpaths = ["tests"] +addopts = "-ra" + +[tool.ruff] +line-length = 88 +target-version = "py313" +src = ["src", "tests"] + +[tool.ruff.lint] +select = ["E", "F", "I", "B", "UP"] diff --git a/src/flask_day_54/__init__.py b/src/flask_day_54/__init__.py new file mode 100644 index 0000000..4f28e8a --- /dev/null +++ b/src/flask_day_54/__init__.py @@ -0,0 +1,3 @@ +## @file __init__.py +# @brief Root package of the Day 54 Flask lecture project. +"""Day 54 Flask lecture project, organised in layers.""" diff --git a/src/flask_day_54/application/__init__.py b/src/flask_day_54/application/__init__.py new file mode 100644 index 0000000..2ed1c4d --- /dev/null +++ b/src/flask_day_54/application/__init__.py @@ -0,0 +1,3 @@ +## @file __init__.py +# @brief Application layer: use cases and the ports they need. +"""Application layer: use cases and ports.""" diff --git a/src/flask_day_54/domain/__init__.py b/src/flask_day_54/domain/__init__.py new file mode 100644 index 0000000..38785b3 --- /dev/null +++ b/src/flask_day_54/domain/__init__.py @@ -0,0 +1,3 @@ +## @file __init__.py +# @brief Domain layer: pure rules, no input or output, no framework. +"""Domain layer: pure rules with no framework and no input or output.""" diff --git a/src/flask_day_54/domain/constants.py b/src/flask_day_54/domain/constants.py new file mode 100644 index 0000000..fdaae9a --- /dev/null +++ b/src/flask_day_54/domain/constants.py @@ -0,0 +1,8 @@ +## @file constants.py +# @brief Constants of the domain layer. +"""Constants of the domain layer.""" + +from typing import Final + +## @brief The greeting shown by the first Flask route. +GREETING: Final[str] = "Hello, World!" diff --git a/src/flask_day_54/infrastructure/__init__.py b/src/flask_day_54/infrastructure/__init__.py new file mode 100644 index 0000000..2367657 --- /dev/null +++ b/src/flask_day_54/infrastructure/__init__.py @@ -0,0 +1,3 @@ +## @file __init__.py +# @brief Infrastructure layer: server settings and configuration. +"""Infrastructure layer: server settings and configuration.""" diff --git a/src/flask_day_54/infrastructure/constants.py b/src/flask_day_54/infrastructure/constants.py new file mode 100644 index 0000000..9386fa9 --- /dev/null +++ b/src/flask_day_54/infrastructure/constants.py @@ -0,0 +1,20 @@ +## @file constants.py +# @brief Constants of the infrastructure layer (server settings). +"""Server settings used by the entry point.""" + +from typing import Final + +## @brief Interface the development server binds to. +HOST: Final[str] = "127.0.0.1" + +## @brief TCP port of the development server. +PORT: Final[int] = 5000 + +## @brief Whether the development server runs in debug mode. +DEBUG: Final[bool] = True + +## @brief Dotted module path of the Flask application. +APP_MODULE: Final[str] = "flask_day_54.presentation.hello" + +## @brief Name of the environment variable Flask reads to find the application. +FLASK_APP_ENV_VAR: Final[str] = "FLASK_APP" diff --git a/src/flask_day_54/presentation/__init__.py b/src/flask_day_54/presentation/__init__.py new file mode 100644 index 0000000..82c2f0e --- /dev/null +++ b/src/flask_day_54/presentation/__init__.py @@ -0,0 +1,3 @@ +## @file __init__.py +# @brief Presentation layer: entry points, the Flask application. +"""Presentation layer: entry points and the Flask application.""" diff --git a/tests/unit/test_domain_constants.py b/tests/unit/test_domain_constants.py new file mode 100644 index 0000000..3b9e45c --- /dev/null +++ b/tests/unit/test_domain_constants.py @@ -0,0 +1,13 @@ +## @file test_domain_constants.py +# @brief Unit tests for the domain constants. +"""Unit tests for the domain constants.""" + +from flask_day_54.domain import constants + + +def test_greeting_has_expected_value() -> None: + assert constants.GREETING == "Hello, World!" + + +def test_greeting_is_not_empty() -> None: + assert constants.GREETING.strip() != "" diff --git a/tests/unit/test_infrastructure_constants.py b/tests/unit/test_infrastructure_constants.py new file mode 100644 index 0000000..d046e41 --- /dev/null +++ b/tests/unit/test_infrastructure_constants.py @@ -0,0 +1,30 @@ +## @file test_infrastructure_constants.py +# @brief Unit tests for the infrastructure constants. +"""Unit tests for the infrastructure constants.""" + +from flask_day_54.infrastructure import constants + + +def test_host_is_loopback() -> None: + assert constants.HOST == "127.0.0.1" + + +def test_port_is_int_in_unprivileged_range() -> None: + assert isinstance(constants.PORT, int) + assert 1024 <= constants.PORT <= 65535 + + +def test_port_has_expected_value() -> None: + assert constants.PORT == 5000 + + +def test_debug_is_enabled() -> None: + assert constants.DEBUG is True + + +def test_app_module_points_to_presentation_hello() -> None: + assert constants.APP_MODULE == "flask_day_54.presentation.hello" + + +def test_flask_app_env_var_name() -> None: + assert constants.FLASK_APP_ENV_VAR == "FLASK_APP"