3 Commits
Author SHA1 Message Date
Tirsvad c90e5afb7c Merge pull request 'MIL-001: Add project scaffold' (#30) from mil-001-project-scaffold into main
TirSystem/github-action: Sync GitHub mirror metadata / sync-metadata (push) Successful in 4s
Reviewed-on: #30
2026-10-04 14:42:25 +02:00
Tirsvad 1237f41840 Add project scaffold: pyproject, Doxyfile and package layout
MIL-001 Project scaffold.

- Add pyproject.toml: Python 3.13 or newer, no runtime dependencies,

  pytest as the dev extra

- Add src/calc/ package and tests/ folder

- Add Doxyfile writing API docs to docs/doxygen/

- Ignore docs/doxygen/ in .gitignore

Closes #15

Closes #16

Closes #17

Closes #18

Task: MIL-001#1

Task: MIL-001#2

Task: MIL-001#3

Task: MIL-001#4
2026-10-04 20:38:26 +08:00
Tirsvad 6809db7930 Merge pull request 'Add project plan, milestones, business case and stakeholder analysis' (#29) from planning into main
TirSystem/github-action: Sync GitHub mirror metadata / sync-metadata (push) Successful in 6s
Reviewed-on: #29
2026-10-04 14:26:42 +02:00
5 changed files with 45 additions and 0 deletions
+3
View File
@@ -173,3 +173,6 @@ cython_debug/
# PyPI configuration file
.pypirc
# Doxygen output
docs/doxygen/
+16
View File
@@ -0,0 +1,16 @@
# Doxygen configuration for the console calculator.
# Generate the API documentation with: doxygen Doxyfile
PROJECT_NAME = "Calculator"
PROJECT_BRIEF = "Console calculator (Udemy 100 Days of Code, day 10)"
OUTPUT_DIRECTORY = docs/doxygen
INPUT = src
FILE_PATTERNS = *.py
RECURSIVE = YES
OPTIMIZE_OUTPUT_JAVA = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
GENERATE_HTML = YES
GENERATE_LATEX = NO
QUIET = YES
WARN_IF_UNDOCUMENTED = YES
WARN_NO_PARAMDOC = YES
+22
View File
@@ -0,0 +1,22 @@
[build-system]
requires = ["setuptools>=69"]
build-backend = "setuptools.build_meta"
[project]
name = "calc"
version = "0.1.0"
description = "A console calculator (Udemy 100 Days of Code, day 10)."
readme = "README.md"
requires-python = ">=3.13"
license = { text = "AGPL-3.0-or-later" }
dependencies = []
[project.optional-dependencies]
dev = ["pytest>=8"]
[tool.setuptools.packages.find]
where = ["src"]
[tool.pytest.ini_options]
testpaths = ["tests"]
pythonpath = ["src"]
+4
View File
@@ -0,0 +1,4 @@
"""!
@file __init__.py
@brief Console calculator package (Udemy 100 Days of Code, day 10).
"""
View File