Compare commits
11
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Tirsvad
|
d3d2d03cd5 | ||
|
Tirsvad
|
d85cfe5c4b | ||
|
Tirsvad
|
1b217785c6 | ||
|
Tirsvad
|
d2f36bfde3 | ||
|
Tirsvad
|
c4e88c6da6 | ||
|
Tirsvad
|
632fa61b89 | ||
|
Tirsvad
|
d825bef0f1 | ||
|
Tirsvad
|
9e41ae87b9 | ||
|
Tirsvad
|
57e12637f0 | ||
|
Tirsvad
|
b0132498ba | ||
|
Tirsvad
|
933f71eb39 |
@@ -7,10 +7,9 @@ PROJECT_NAME = "Squirrel Census"
|
||||
PROJECT_BRIEF = "Count squirrels by primary fur colour"
|
||||
PROJECT_NUMBER = 0.1.0
|
||||
OUTPUT_DIRECTORY = docs/doxygen
|
||||
INPUT = src README.md
|
||||
FILE_PATTERNS = *.py *.md
|
||||
INPUT = src docs/mainpage.dox
|
||||
FILE_PATTERNS = *.py *.dox
|
||||
RECURSIVE = YES
|
||||
USE_MDFILE_AS_MAINPAGE = README.md
|
||||
OPTIMIZE_OUTPUT_JAVA = YES
|
||||
EXTRACT_ALL = YES
|
||||
GENERATE_HTML = YES
|
||||
|
||||
@@ -112,6 +112,7 @@ docs/ business case, plan, milestones, models, reviews, ADRs
|
||||
docs/images/ screenshots used by this README and the wiki
|
||||
src/squirrel/ the package: census.py, cli.py, constants.py
|
||||
tests/ pytest tests
|
||||
wiki/ wiki pages in English, Danish (.da) and Bahasa Malaysia (.ms)
|
||||
Doxyfile Doxygen configuration
|
||||
pyproject.toml project configuration (Python >=3.13, no runtime dependencies)
|
||||
squirrel_count.csv the result of the assignment
|
||||
|
||||
@@ -16,7 +16,7 @@ document of a type. `Primary File` may contain a glob (e.g.
|
||||
| PP | Project Plan | docs/project-plan.md | 002 |
|
||||
| MIL | Milestone / Gateway | docs/milestones/*.md | 005 |
|
||||
| ADR | Architecture Decision Record | docs/adr/adr-NNNN-*.md | 0002 |
|
||||
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 025 |
|
||||
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 028 |
|
||||
| DICT | Domain Dictionary | docs/dictionary.md | 002 |
|
||||
| TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 |
|
||||
| UCD | Use Case Diagram | docs/use-case-diagram.md | 002 |
|
||||
|
||||
@@ -11,8 +11,8 @@
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 2026-10-13 | Deprecated | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [f1b3c03] |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | CrossReference: added [UCD-001] | [259d017] |
|
||||
| 2026-10-13 | Deprecated | Jens Tirsvad Nielsen | AI as stand-in for S01 | CrossReference: added [UCD-001] | [259d017] |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Corrected the wiki folder `docs/wiki/` to `wiki/` | [d85cfe5] |
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
@@ -91,7 +91,7 @@ The project supports the participant's goal of finishing the 100 Days of Code bo
|
||||
| The lecture uses Pandas but the repository must have no runtime dependencies | The solution differs from the lecture code | Use the standard library `csv` module; record the decision in an architecture decision record (ADR) and keep the lecture's step names as function names |
|
||||
| The census file is large and not part of the repository | Others cannot run the program | Keep the census file under `data/` and let the program accept a path argument |
|
||||
| Tokens in `.env` leak into the repository | Credential exposure | `.env` is git-ignored, never read by the project and never printed |
|
||||
| Wiki push is not available on the host | Wiki pages are not published | Keep the pages in the repository under `docs/wiki/` and report the failure |
|
||||
| Wiki push is not available on the host | Wiki pages are not published | Keep the pages in the repository under `wiki/` and report the failure |
|
||||
| Fur colour spelling differs in the data | Wrong counts | Count exact values `Gray`, `Cinnamon`, `Black` and test with fixture rows |
|
||||
|
||||
## Assumptions
|
||||
@@ -133,6 +133,6 @@ Proceed — the scope is small, the risks are mitigated and the result is direct
|
||||
|
||||
---
|
||||
|
||||
[f1b3c03]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/f1b3c034dc3880b7884646b4a4ed28e5f98fbcd3
|
||||
[UCD-001]: ./use-case-diagram.md
|
||||
[259d017]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/259d017ad257059330eb9a8bdbf940c9d082664e
|
||||
[d85cfe5]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/d85cfe5c4b62b2e1759f1c47b25bdb787ba6fd68
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 2026-10-13 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [f1b3c03] |
|
||||
| 2026-10-13 | Deprecated | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [f1b3c03] |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | CrossReference: added [DM-002] | [259d017] |
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
@mainpage Squirrel Census
|
||||
|
||||
Count the squirrels of the 2018 Central Park Squirrel Census by primary fur colour
|
||||
(Gray, Cinnamon, Black) and export the counts to `squirrel_count.csv`.
|
||||
|
||||
The steps follow the Udemy "100 Days of Code" lecture of day 25: squirrel.census.read_csv,
|
||||
squirrel.census.count_by_fur_color, squirrel.census.build_summary and
|
||||
squirrel.census.write_csv. The command line entry point is squirrel.cli.main, started
|
||||
with `python -m squirrel`. Every literal is defined once in squirrel.constants.
|
||||
|
||||
The package uses only the Python standard library.
|
||||
*/
|
||||
@@ -11,8 +11,8 @@
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 2026-10-13 | Deprecated | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [f1b3c03] |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | CrossReference: added [US-001] | [259d017] |
|
||||
| 2026-10-13 | Deprecated | Jens Tirsvad Nielsen | AI as stand-in for S01 | CrossReference: added [US-001] | [259d017] |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Corrected the wiki folder `docs/wiki/` to `wiki/` | [d85cfe5] |
|
||||
---
|
||||
|
||||
## Purpose
|
||||
@@ -29,7 +29,7 @@ Wiki pages `Home`, `Install`, `Usage` and `Description` in English plus `-da` an
|
||||
| --- | --- | --- | --- |
|
||||
| 1 | Each wiki page exists in English, Danish (`-da`) and Bahasa Malaysia (`-ms`) | All present | Any missing |
|
||||
| 2 | The sidebar links every page in all three languages | All linked | Missing link |
|
||||
| 3 | Wiki pages are on the git host wiki, or kept under `docs/wiki/` with the failure reported | Published or reported | Neither |
|
||||
| 3 | Wiki pages are on the git host wiki, or kept under `wiki/` with the failure reported | Published or reported | Neither |
|
||||
| 4 | Screenshots appear on the wiki pages | Present | Missing |
|
||||
|
||||
## Dependencies
|
||||
@@ -69,6 +69,6 @@ Wiki pages `Home`, `Install`, `Usage` and `Description` in English plus `-da` an
|
||||
---
|
||||
|
||||
[BC-001]: ../business-case.md
|
||||
[f1b3c03]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/f1b3c034dc3880b7884646b4a4ed28e5f98fbcd3
|
||||
[US-001]: ../user-stories.md
|
||||
[259d017]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/259d017ad257059330eb9a8bdbf940c9d082664e
|
||||
[d85cfe5]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/d85cfe5c4b62b2e1759f1c47b25bdb787ba6fd68
|
||||
|
||||
@@ -11,8 +11,8 @@
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | [f1b3c03] |
|
||||
| 2026-10-13 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | CrossReference: added [US-001] | [259d017] |
|
||||
| 2026-10-13 | Deprecated | Jens Tirsvad Nielsen | AI as stand-in for S01 | CrossReference: added [US-001] | [259d017] |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Corrected the wiki folder `docs/wiki/` to `wiki/` | [d85cfe5] |
|
||||
---
|
||||
|
||||
## Purpose
|
||||
@@ -75,7 +75,7 @@ A No-Go at a gateway stops the later gateways; their dates move by the days the
|
||||
| Risk | Impact | Mitigation |
|
||||
| --- | --- | --- |
|
||||
| CI runner is not available on the git host | The CI workflow cannot be shown green | Run the same commands locally and report the missing runner |
|
||||
| Wiki repository cannot be pushed | G4 deliverable is not published | Keep the pages under `docs/wiki/` and report it |
|
||||
| Wiki repository cannot be pushed | G4 deliverable is not published | Keep the pages under `wiki/` and report it |
|
||||
| Doxygen is not installed locally | The documentation build cannot be verified | Report as not verified; document the command |
|
||||
|
||||
## Open Issues
|
||||
@@ -92,10 +92,10 @@ A No-Go at a gateway stops the later gateways; their dates move by the days the
|
||||
[MIL-002]: ./milestones/mil-002-census-analysis.md
|
||||
[MIL-003]: ./milestones/mil-003-documentation.md
|
||||
[MIL-004]: ./milestones/mil-004-wiki-publication.md
|
||||
[f1b3c03]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/f1b3c034dc3880b7884646b4a4ed28e5f98fbcd3
|
||||
[MS-124]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/milestone/124
|
||||
[MS-125]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/milestone/125
|
||||
[MS-126]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/milestone/126
|
||||
[MS-127]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/milestone/127
|
||||
[US-001]: ./user-stories.md
|
||||
[259d017]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/259d017ad257059330eb9a8bdbf940c9d082664e
|
||||
[d85cfe5]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/d85cfe5c4b62b2e1759f1c47b25bdb787ba6fd68
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
# RC Review of ci.yml, delta re-review of criterion 22
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | RC-025 |
|
||||
| CrossReference | [WF-MIL-001], [QC-WF-001] |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Artifact Under Review
|
||||
|
||||
- Instance reviewed: [WF-MIL-001]
|
||||
- Checklist used: [QC-WF-001]
|
||||
- Scope: delta re-review of criterion 22 of QC-WF-001; reason: the condition of RC-010 (run 1012 queued); earlier record RC-010
|
||||
- Language and domain: n/a
|
||||
- Language reviewer: none (the stand-in reviewer reads English and the `it` domain)
|
||||
- Mode: autonomous, not independent (reviewer: AI as stand-in for S01)
|
||||
|
||||
## Checklist Results
|
||||
|
||||
| # | Criterion | Status | Evidence/Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 22 | Every workflow feature used is verified on the instance that runs it, and the host and version are recorded; a feature the target hosts differ on is noted in the header (Mandatory) | Pass | Gitea 1.27.3, runner labels ubuntu-latest. `ci.yml` completed with success on the instance: pull_request runs 1037, 1040 and 1043, and the push run 1044 on main (commit c4e88c6). Header states the host and that only github.* contexts are used. |
|
||||
|
||||
## Overall Verdict
|
||||
|
||||
Go — criterion 22, the only open Mandatory criterion of RC-010, now passes; the other rows of RC-010 still hold, so the workflow is Go. Closes the condition of RC-010.
|
||||
|
||||
## Action Items
|
||||
|
||||
| Action | Owner | Due |
|
||||
| --- | --- | --- |
|
||||
| None | S01 | - |
|
||||
|
||||
---
|
||||
|
||||
[WF-MIL-001]: ../../../.gitea/workflows/ci.yml
|
||||
[QC-WF-001]: ../../../framework/qc/code/qc-workflow.md
|
||||
@@ -0,0 +1,56 @@
|
||||
# RC-026 Review of BC-001
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | RC-026 |
|
||||
| CrossReference | [BC-001], [QC-BC-001], [QC-LANG-001] |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [d85cfe5] |
|
||||
|
||||
---
|
||||
|
||||
## Artifact Under Review
|
||||
|
||||
- Instance reviewed: [BC-001]
|
||||
- Checklist used: [QC-BC-001] and [QC-LANG-001]
|
||||
- Scope: delta re-review of the criterion that covers the changed text and criteria 1, 2, 6, 7, 8 of QC-LANG-001: the path `docs/wiki/` was corrected to `wiki/`
|
||||
- Language and domain: en / it
|
||||
- Language reviewer: none (the stand-in reviewer reads English and the `it` domain)
|
||||
- Mode: autonomous, not independent (reviewer: AI as stand-in for S01)
|
||||
|
||||
## Checklist Results
|
||||
|
||||
| # | Criterion | Status | Evidence/Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2 | Risks are identified with documented impact and mitigation (Mandatory) | Pass | The changed text is a folder path in a risk mitigation or a Go criterion; it is still objectively checkable and has a mitigation. |
|
||||
|
||||
## 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 (Mandatory) | Pass | Language and Domain rows unchanged. |
|
||||
| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list (Mandatory) | Pass | Unchanged. |
|
||||
| 6 | Metadata keys, section headings, IDs and statuses are in English (Mandatory) | Pass | Keys, headings and statuses are English. |
|
||||
| 7 | No translated twin (`<name>.<language>.md`) exists beside the document (Mandatory) | Pass | No translated twin. |
|
||||
| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again (Mandatory) | Pass | Language unchanged. |
|
||||
|
||||
## Overall Verdict
|
||||
|
||||
Go — only a folder path was corrected; the earlier review of the content still holds.
|
||||
|
||||
## Action Items
|
||||
|
||||
| Action | Owner | Due |
|
||||
| --- | --- | --- |
|
||||
| None | S01 | - |
|
||||
|
||||
---
|
||||
|
||||
[BC-001]: ../../business-case.md
|
||||
[QC-BC-001]: ../../../framework/qc/artifacts/qc-business-case.md
|
||||
[QC-LANG-001]: ../../../framework/qc/artifacts/qc-language-domain.md
|
||||
[d85cfe5]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/d85cfe5c4b62b2e1759f1c47b25bdb787ba6fd68
|
||||
@@ -0,0 +1,56 @@
|
||||
# RC-027 Review of MIL-004
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | RC-027 |
|
||||
| CrossReference | [MIL-004], [QC-MIL-001], [QC-LANG-001] |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [d85cfe5] |
|
||||
|
||||
---
|
||||
|
||||
## Artifact Under Review
|
||||
|
||||
- Instance reviewed: [MIL-004]
|
||||
- Checklist used: [QC-MIL-001] and [QC-LANG-001]
|
||||
- Scope: delta re-review of the criterion that covers the changed text and criteria 1, 2, 6, 7, 8 of QC-LANG-001: the path `docs/wiki/` was corrected to `wiki/`
|
||||
- Language and domain: en / it
|
||||
- Language reviewer: none (the stand-in reviewer reads English and the `it` domain)
|
||||
- Mode: autonomous, not independent (reviewer: AI as stand-in for S01)
|
||||
|
||||
## Checklist Results
|
||||
|
||||
| # | Criterion | Status | Evidence/Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2 | Explicit Go/No-Go criteria are stated for each gate (Mandatory) | Pass | The changed text is a folder path in a risk mitigation or a Go criterion; it is still objectively checkable and has a mitigation. |
|
||||
|
||||
## 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 (Mandatory) | Pass | Language and Domain rows unchanged. |
|
||||
| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list (Mandatory) | Pass | Unchanged. |
|
||||
| 6 | Metadata keys, section headings, IDs and statuses are in English (Mandatory) | Pass | Keys, headings and statuses are English. |
|
||||
| 7 | No translated twin (`<name>.<language>.md`) exists beside the document (Mandatory) | Pass | No translated twin. |
|
||||
| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again (Mandatory) | Pass | Language unchanged. |
|
||||
|
||||
## Overall Verdict
|
||||
|
||||
Go — only a folder path was corrected; the earlier review of the content still holds.
|
||||
|
||||
## Action Items
|
||||
|
||||
| Action | Owner | Due |
|
||||
| --- | --- | --- |
|
||||
| None | S01 | - |
|
||||
|
||||
---
|
||||
|
||||
[MIL-004]: ../../milestones/mil-004-wiki-publication.md
|
||||
[QC-MIL-001]: ../../../framework/qc/artifacts/qc-milestones-gateways.md
|
||||
[QC-LANG-001]: ../../../framework/qc/artifacts/qc-language-domain.md
|
||||
[d85cfe5]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel/commit/d85cfe5c4b62b2e1759f1c47b25bdb787ba6fd68
|
||||
@@ -23,13 +23,13 @@ updated whenever an artifact instance is created or reviewed.
|
||||
|
||||
| Artifact Instance | Type | Language | Domain | Upstream (Backward Link) | Downstream (Forward Link) | Last Reviewed (RC-ID) |
|
||||
| --- | --- | --- | --- | --- | --- | --- |
|
||||
| [BC-001] | Business Case | en | it | - | [SA-001], [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] | [RC-001], [RC-019] |
|
||||
| [BC-001] | Business Case | en | it | - | [SA-001], [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] | [RC-001], [RC-019], [RC-026] |
|
||||
| [SA-001] | Stakeholder Analysis | en | it | [BC-001] | [PP-001] | [RC-002] |
|
||||
| [PP-001] | Project Plan | en | it | [BC-001], [SA-001] | [MIL-001], [MIL-002], [MIL-003], [MIL-004] | - (no checklist; accepted by S01 in chat) |
|
||||
| [MIL-001] | Milestone | en | it | [BC-001], [PP-001] | - | [RC-003], [RC-020] |
|
||||
| [MIL-002] | Milestone | en | it | [BC-001], [PP-001], [MIL-001] | - | [RC-004], [RC-021] |
|
||||
| [MIL-003] | Milestone | en | it | [BC-001], [PP-001], [MIL-002] | - | [RC-005], [RC-022] |
|
||||
| [MIL-004] | Milestone | en | it | [BC-001], [PP-001], [MIL-003] | - | [RC-006], [RC-023] |
|
||||
| [MIL-004] | Milestone | en | it | [BC-001], [PP-001], [MIL-003] | - | [RC-006], [RC-023], [RC-027] |
|
||||
| [DICT-001] | Domain Dictionary | en | it | [BC-001], [SA-001] | - | [RC-007], [RC-018] |
|
||||
| [UCD-001] | Use Case Diagram | en | it | [SA-001], [BC-001] | [US-001], [UC-001] | [RC-011] |
|
||||
| [US-001] | User Story | en | it | [UCD-001], [BC-001], [MIL-002] | [UC-001] | [RC-012] |
|
||||
@@ -40,7 +40,7 @@ updated whenever an artifact instance is created or reviewed.
|
||||
| [ADR-0001] | Architecture Decision Record | - | - | [BC-001], [SA-001], [MIL-002] | `src/squirrel/census.py` | [RC-017] |
|
||||
| `src/squirrel/census.py`, `cli.py`, `__main__.py`, `tests/` | Python Source Code | - | - | [UC-001], [SSD-001], [ADR-0001] | - | [RC-024] |
|
||||
| `src/squirrel/constants.py`, `tests/test_constants.py` | Python Source Code | - | - | [MIL-001] | - | [RC-008] |
|
||||
| `.gitea/workflows/ci.yml` | CI Workflow | - | - | [MIL-001] | - | [RC-009], [RC-010] |
|
||||
| `.gitea/workflows/ci.yml` | CI Workflow | - | - | [MIL-001] | - | [RC-009], [RC-010], [RC-025] |
|
||||
|
||||
## Coverage Notes
|
||||
|
||||
@@ -89,3 +89,6 @@ updated whenever an artifact instance is created or reviewed.
|
||||
[RC-022]: ./reviews/rc-022-mil-003-delta.md
|
||||
[RC-023]: ./reviews/rc-023-mil-004-delta.md
|
||||
[RC-024]: ./reviews/rc-024-python-census.md
|
||||
[RC-025]: ./reviews/rc-025-ci-workflow-delta.md
|
||||
[RC-026]: ./reviews/rc-026-business-case-wiki-path.md
|
||||
[RC-027]: ./reviews/rc-027-mil-004-wiki-path.md
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
🌐 [English](Description) · **Dansk** · [Bahasa Melayu](Description.ms)
|
||||
|
||||
# Beskrivelse
|
||||
|
||||
## Hvad programmet gør
|
||||
|
||||
Programmet følger lektionens trin:
|
||||
|
||||
1. `read_csv` læser optællingsfilen.
|
||||
2. `count_by_fur_color` tæller observationerne af Gray, Cinnamon og Black.
|
||||
3. `build_summary` gør tallene til rækkerne i en opsummering.
|
||||
4. `write_csv` skriver opsummeringen til `squirrel_count.csv`.
|
||||
|
||||
På optællingsfilen fra 2018 er resultatet Gray 2473, Cinnamon 392 og Black 103. Observationer uden pelsfarve tælles ikke med i nogen af dem.
|
||||
|
||||
## Hvorfor ikke Pandas
|
||||
|
||||
Lektionen bruger Pandas. Dette projekt bruger kun Pythons standardbibliotek (`csv` og `collections.Counter`), så der ikke er noget at installere for at køre det. Beslutningen er beskrevet som ADR-0001 i repositoryet.
|
||||
|
||||
## Opbygning
|
||||
|
||||
| Sti | Indhold |
|
||||
| --- | --- |
|
||||
| `src/squirrel/census.py` | De fire trin ovenfor |
|
||||
| `src/squirrel/cli.py` | Kommandolinjen, `python -m squirrel` |
|
||||
| `src/squirrel/constants.py` | Alle konstanter, defineret ét sted |
|
||||
| `tests/` | pytest-testene |
|
||||
| `docs/` | Business case, plan, modeller, reviewposter |
|
||||
|
||||
## Kvalitet
|
||||
|
||||
Alle dokumenter og al kode er gennemgået mod tjeklisterne i SQA- og QC-frameworket i autonom tilstand: reviewer er en AI-stedfortræder, så reviewene er ikke uafhængige.
|
||||
@@ -0,0 +1,32 @@
|
||||
🌐 **English** · [Dansk](Description.da) · [Bahasa Melayu](Description.ms)
|
||||
|
||||
# Description
|
||||
|
||||
## What it does
|
||||
|
||||
The program follows the steps of the lecture:
|
||||
|
||||
1. `read_csv` reads the census file.
|
||||
2. `count_by_fur_color` counts the sightings of Gray, Cinnamon and Black.
|
||||
3. `build_summary` turns the counts into the rows of a summary.
|
||||
4. `write_csv` writes the summary to `squirrel_count.csv`.
|
||||
|
||||
On the 2018 census file the result is Gray 2473, Cinnamon 392 and Black 103. Sightings without a fur colour are counted in none of them.
|
||||
|
||||
## Why no Pandas
|
||||
|
||||
The lecture uses Pandas. This project uses only the Python standard library (`csv` and `collections.Counter`) so that there is nothing to install to run it. The decision is recorded as ADR-0001 in the repository.
|
||||
|
||||
## Layout
|
||||
|
||||
| Path | Content |
|
||||
| --- | --- |
|
||||
| `src/squirrel/census.py` | The four steps above |
|
||||
| `src/squirrel/cli.py` | The command line, `python -m squirrel` |
|
||||
| `src/squirrel/constants.py` | Every literal, defined once |
|
||||
| `tests/` | The pytest tests |
|
||||
| `docs/` | Business case, plan, models, review records |
|
||||
|
||||
## Quality
|
||||
|
||||
Every document and every piece of code was reviewed against the checklists of the SQA and QC framework, in autonomous mode: the reviewer is an AI stand-in, so the reviews are not independent.
|
||||
@@ -0,0 +1,32 @@
|
||||
🌐 [English](Description) · [Dansk](Description.da) · **Bahasa Melayu**
|
||||
|
||||
# Penerangan
|
||||
|
||||
## Apa yang dilakukan program
|
||||
|
||||
Program mengikut langkah dalam pelajaran:
|
||||
|
||||
1. `read_csv` membaca fail banci.
|
||||
2. `count_by_fur_color` mengira pemerhatian Gray, Cinnamon dan Black.
|
||||
3. `build_summary` menukar kiraan kepada baris ringkasan.
|
||||
4. `write_csv` menulis ringkasan ke `squirrel_count.csv`.
|
||||
|
||||
Pada fail banci 2018 hasilnya ialah Gray 2473, Cinnamon 392 dan Black 103. Pemerhatian tanpa warna bulu tidak dikira dalam mana-mana satu.
|
||||
|
||||
## Mengapa tidak menggunakan Pandas
|
||||
|
||||
Pelajaran menggunakan Pandas. Projek ini hanya menggunakan pustaka standard Python (`csv` dan `collections.Counter`) supaya tiada apa-apa untuk dipasang bagi menjalankannya. Keputusan itu direkodkan sebagai ADR-0001 dalam repositori.
|
||||
|
||||
## Susun atur
|
||||
|
||||
| Laluan | Kandungan |
|
||||
| --- | --- |
|
||||
| `src/squirrel/census.py` | Empat langkah di atas |
|
||||
| `src/squirrel/cli.py` | Baris perintah, `python -m squirrel` |
|
||||
| `src/squirrel/constants.py` | Semua pemalar, ditakrif sekali |
|
||||
| `tests/` | Ujian pytest |
|
||||
| `docs/` | Kes perniagaan, pelan, model, rekod semakan |
|
||||
|
||||
## Kualiti
|
||||
|
||||
Setiap dokumen dan kod disemak berdasarkan senarai semak rangka kerja SQA dan QC dalam mod autonomi: penyemak ialah pengganti AI, jadi semakan itu tidak bebas.
|
||||
@@ -0,0 +1,15 @@
|
||||
🌐 [English](Home) · **Dansk** · [Bahasa Melayu](Home.ms)
|
||||
|
||||
# Egern-optælling
|
||||
|
||||
Dag 25 i Udemys *100 Days of Code: The Complete Python Pro Bootcamp*: tæl egernene i Central Parks egern-optælling fra 2018 efter primær pelsfarve (grå, kanel, sort) og eksportér tallene til `squirrel_count.csv`.
|
||||
|
||||
|
||||
|
||||
| Side | Læs den, når du vil |
|
||||
| --- | --- |
|
||||
| [Installation](Install.da) | Oprette et `.venv` og installere projektet på Windows PowerShell, Linux Debian eller macOS |
|
||||
| [Brug](Usage.da) | Køre programmet og testene |
|
||||
| [Beskrivelse](Description.da) | Forstå hvordan koden er bygget, og hvorfor den ikke har kørselsafhængigheder |
|
||||
|
||||
Koden, testene og projektdokumenterne ligger i [repositoryet](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel).
|
||||
@@ -0,0 +1,15 @@
|
||||
🌐 **English** · [Dansk](Home.da) · [Bahasa Melayu](Home.ms)
|
||||
|
||||
# Squirrel Census
|
||||
|
||||
Day 25 of Udemy's *100 Days of Code: The Complete Python Pro Bootcamp*: count the squirrels of the 2018 Central Park Squirrel Census by primary fur colour (gray, cinnamon, black) and export the counts to `squirrel_count.csv`.
|
||||
|
||||
|
||||
|
||||
| Page | Read it when you want to |
|
||||
| --- | --- |
|
||||
| [Install](Install) | Create a `.venv` and install the project on Windows PowerShell, Linux Debian or macOS |
|
||||
| [Usage](Usage) | Run the program and the tests |
|
||||
| [Description](Description) | Understand how the code is built and why it has no runtime dependencies |
|
||||
|
||||
The code, the tests and the project documents are in the [repository](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel).
|
||||
@@ -0,0 +1,15 @@
|
||||
🌐 [English](Home) · [Dansk](Home.da) · **Bahasa Melayu**
|
||||
|
||||
# Banci Tupai
|
||||
|
||||
Hari ke-25 dalam *100 Days of Code: The Complete Python Pro Bootcamp* Udemy: kira tupai dalam Banci Tupai Central Park 2018 mengikut warna bulu utama (kelabu, kayu manis, hitam) dan eksport kiraan ke `squirrel_count.csv`.
|
||||
|
||||
|
||||
|
||||
| Halaman | Baca apabila anda mahu |
|
||||
| --- | --- |
|
||||
| [Pemasangan](Install.ms) | Mencipta `.venv` dan memasang projek di Windows PowerShell, Linux Debian atau macOS |
|
||||
| [Penggunaan](Usage.ms) | Menjalankan program dan ujian |
|
||||
| [Penerangan](Description.ms) | Memahami cara kod dibina dan sebab ia tiada kebergantungan masa jalan |
|
||||
|
||||
Kod, ujian dan dokumen projek berada dalam [repositori](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-squirrel).
|
||||
@@ -0,0 +1,35 @@
|
||||
🌐 [English](Install) · **Dansk** · [Bahasa Melayu](Install.ms)
|
||||
|
||||
# Installation
|
||||
|
||||
Projektet kræver **Python 3.13 eller nyere**. Det har ingen kørselsafhængigheder; `pytest`, `ruff` og `mypy` er udviklingsværktøjer.
|
||||
|
||||
## Windows PowerShell
|
||||
|
||||
```powershell
|
||||
python -m venv .venv
|
||||
.\.venv\Scripts\Activate.ps1
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Linux Debian
|
||||
|
||||
```bash
|
||||
sudo apt install python3 python3-venv
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## macOS
|
||||
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
Næste: [Brug](Usage.da).
|
||||
@@ -0,0 +1,35 @@
|
||||
🌐 **English** · [Dansk](Install.da) · [Bahasa Melayu](Install.ms)
|
||||
|
||||
# Install
|
||||
|
||||
The project needs **Python 3.13 or later**. It has no runtime dependencies; `pytest`, `ruff` and `mypy` are development tools.
|
||||
|
||||
## Windows PowerShell
|
||||
|
||||
```powershell
|
||||
python -m venv .venv
|
||||
.\.venv\Scripts\Activate.ps1
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Linux Debian
|
||||
|
||||
```bash
|
||||
sudo apt install python3 python3-venv
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## macOS
|
||||
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
Next: [Usage](Usage).
|
||||
@@ -0,0 +1,35 @@
|
||||
🌐 [English](Install) · [Dansk](Install.da) · **Bahasa Melayu**
|
||||
|
||||
# Pemasangan
|
||||
|
||||
Projek ini memerlukan **Python 3.13 atau lebih baharu**. Ia tiada kebergantungan masa jalan; `pytest`, `ruff` dan `mypy` ialah alat pembangunan.
|
||||
|
||||
## Windows PowerShell
|
||||
|
||||
```powershell
|
||||
python -m venv .venv
|
||||
.\.venv\Scripts\Activate.ps1
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Linux Debian
|
||||
|
||||
```bash
|
||||
sudo apt install python3 python3-venv
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## macOS
|
||||
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
Seterusnya: [Penggunaan](Usage.ms).
|
||||
@@ -0,0 +1,33 @@
|
||||
🌐 [English](Usage) · **Dansk** · [Bahasa Melayu](Usage.ms)
|
||||
|
||||
# Brug
|
||||
|
||||
## Kør programmet
|
||||
|
||||
Med det virtuelle miljø aktivt, fra projektmappen:
|
||||
|
||||
```bash
|
||||
python -m squirrel
|
||||
```
|
||||
|
||||
Programmet læser `data/2018_Central_Park_Squirrel_Census_-_Squirrel_Data.csv`, skriver tallene for hver pelsfarve og gemmer `squirrel_count.csv`.
|
||||
|
||||
|
||||
|
||||
Brug andre filer med `python -m squirrel <optællingsfil> <opsummeringsfil>`. Findes optællingsfilen ikke, skriver programmet `Census file not found` og afslutter med status 2.
|
||||
|
||||
## Kør testene
|
||||
|
||||
```bash
|
||||
python -m pytest
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Byg kildedokumentationen
|
||||
|
||||
```bash
|
||||
doxygen Doxyfile
|
||||
```
|
||||
|
||||
Åbn `docs/doxygen/html/index.html`.
|
||||
@@ -0,0 +1,33 @@
|
||||
🌐 **English** · [Dansk](Usage.da) · [Bahasa Melayu](Usage.ms)
|
||||
|
||||
# Usage
|
||||
|
||||
## Run the program
|
||||
|
||||
With the virtual environment active, from the project folder:
|
||||
|
||||
```bash
|
||||
python -m squirrel
|
||||
```
|
||||
|
||||
The program reads `data/2018_Central_Park_Squirrel_Census_-_Squirrel_Data.csv`, prints the colour counts and writes `squirrel_count.csv`.
|
||||
|
||||
|
||||
|
||||
Use other files with `python -m squirrel <census file> <summary file>`. If the census file does not exist, the program prints `Census file not found` and exits with status 2.
|
||||
|
||||
## Run the tests
|
||||
|
||||
```bash
|
||||
python -m pytest
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Build the source documentation
|
||||
|
||||
```bash
|
||||
doxygen Doxyfile
|
||||
```
|
||||
|
||||
Open `docs/doxygen/html/index.html`.
|
||||
@@ -0,0 +1,33 @@
|
||||
🌐 [English](Usage) · [Dansk](Usage.da) · **Bahasa Melayu**
|
||||
|
||||
# Penggunaan
|
||||
|
||||
## Jalankan program
|
||||
|
||||
Dengan persekitaran maya aktif, dari folder projek:
|
||||
|
||||
```bash
|
||||
python -m squirrel
|
||||
```
|
||||
|
||||
Program membaca `data/2018_Central_Park_Squirrel_Census_-_Squirrel_Data.csv`, mencetak kiraan setiap warna bulu dan menulis `squirrel_count.csv`.
|
||||
|
||||
|
||||
|
||||
Gunakan fail lain dengan `python -m squirrel <fail banci> <fail ringkasan>`. Jika fail banci tidak wujud, program mencetak `Census file not found` dan keluar dengan status 2.
|
||||
|
||||
## Jalankan ujian
|
||||
|
||||
```bash
|
||||
python -m pytest
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Bina dokumentasi sumber
|
||||
|
||||
```bash
|
||||
doxygen Doxyfile
|
||||
```
|
||||
|
||||
Buka `docs/doxygen/html/index.html`.
|
||||
@@ -0,0 +1,24 @@
|
||||
<!-- Generated from wiki; edit the source pages, not the published wiki. -->
|
||||
|
||||
**Squirrel Census**
|
||||
|
||||
**English**
|
||||
|
||||
- [Home](Home)
|
||||
- [Install](Install)
|
||||
- [Usage](Usage)
|
||||
- [Description](Description)
|
||||
|
||||
**Dansk**
|
||||
|
||||
- [Hjem](Home.da)
|
||||
- [Installation](Install.da)
|
||||
- [Brug](Usage.da)
|
||||
- [Beskrivelse](Description.da)
|
||||
|
||||
**Bahasa Melayu**
|
||||
|
||||
- [Utama](Home.ms)
|
||||
- [Pemasangan](Install.ms)
|
||||
- [Penggunaan](Usage.ms)
|
||||
- [Penerangan](Description.ms)
|
||||
Reference in New Issue
Block a user