# thomasitoborbon/ift383-course architecture

> Architecture diagram of the GitHub repository thomasitoborbon/ift383-course, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/thomasitoborbon/ift383-course
- Repository: https://github.com/thomasitoborbon/ift383-course

## Overview

This is a private IFT 383 course workspace: students complete seven labs and a final project, run local checks, then package committed work for Canvas. Its main runtime workflow is setup → check → submit → validated ZIP; README documentation says these tools work locally and do not contact Canvas. The repository also includes a standalone inventory CLI for scanning files and producing table or JSON reports, with optional configuration and logging. The lab and project directories are represented as assignment areas; their internal behavior was not sampled.

Main entry points: [`inventory-tool/inventory_tool/cli.py`](https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/cli.py) (Command boundary), [`tools/submit.py`](https://github.com/thomasitoborbon/ift383-course/blob/main/tools/submit.py) (Submission packager), [`tools/setup.py`](https://github.com/thomasitoborbon/ift383-course/blob/main/tools/setup.py) (Local setup), [`tools/ift383lib/common.py`](https://github.com/thomasitoborbon/ift383-course/blob/main/tools/ift383lib/common.py) (Course helpers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_coursework["Coursework"]
  node_labs["Labs 1–7"]
  node_project["Final project"]
end

subgraph group_submission["Submission tools"]
  node_setup["Local setup<br/>[setup.py]"]
  node_common["Course helpers<br/>[common.py]"]
  node_checks["Visible checks<br/>[check.py]"]
  node_receipt["Receipt helpers<br/>[receipt.py]"]
  node_submit["Submission packager<br/>[submit.py]"]
  node_zip["Canvas ZIP"]
end

subgraph group_inventory["Inventory tool"]
  node_launcher["CLI launcher<br/>[inventory.py]"]
  node_cli["Command boundary<br/>[cli.py]"]
  node_config["Config reader<br/>[scan.py]"]
  node_scanner["Directory scanner<br/>[scan.py]"]
  node_formatter["Report formatter<br/>[report.py]"]
  node_report_output["Report output"]
end

node_student(("Student"))
node_canvas(("Canvas"))
node_inventory_user(("Inventory user"))

node_student -->|"completes"| node_labs
node_student -->|"completes"| node_project
node_student -->|"runs setup"| node_setup
node_setup -->|"saves identity"| node_common
node_setup -->|"creates secret"| node_receipt
node_student -->|"runs checks"| node_checks
node_checks -->|"runs checks"| node_common
node_student -->|"requests package"| node_submit
node_submit -->|"uses helpers"| node_common
node_submit -->|"uses receipt"| node_receipt
node_submit -->|"creates and validates"| node_zip
node_student -->|"uploads ZIP"| node_canvas
node_inventory_user -->|"runs"| node_launcher
node_launcher -->|"dispatches"| node_cli
node_cli -->|"loads config"| node_config
node_cli -->|"scans directory"| node_scanner
node_cli -->|"formats records"| node_formatter
node_cli -->|"writes report"| node_report_output

click node_labs "https://github.com/thomasitoborbon/ift383-course/tree/main/labs"
click node_project "https://github.com/thomasitoborbon/ift383-course/tree/main/final-project"
click node_setup "https://github.com/thomasitoborbon/ift383-course/blob/main/tools/setup.py"
click node_common "https://github.com/thomasitoborbon/ift383-course/blob/main/tools/ift383lib/common.py"
click node_checks "https://github.com/thomasitoborbon/ift383-course/blob/main/tools/check.py"
click node_receipt "https://github.com/thomasitoborbon/ift383-course/blob/main/tools/ift383lib/receipt.py"
click node_submit "https://github.com/thomasitoborbon/ift383-course/blob/main/tools/submit.py"
click node_launcher "https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory.py"
click node_cli "https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/cli.py"
click node_config "https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/scan.py"
click node_scanner "https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/scan.py"
click node_formatter "https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/report.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_labs,node_project,node_inventory_user toneBlue
class node_setup,node_common,node_checks,node_receipt,node_submit,node_zip toneAmber
class node_launcher,node_cli,node_config,node_scanner,node_formatter,node_report_output toneMint
class node_student,node_canvas toneIndigo
```

## Components

### Coursework

- [Labs 1–7](https://github.com/thomasitoborbon/ift383-course/tree/main/labs): `labs`
- [Final project](https://github.com/thomasitoborbon/ift383-course/tree/main/final-project): `final-project`

### Submission tools

- [Local setup](https://github.com/thomasitoborbon/ift383-course/blob/main/tools/setup.py): `tools/setup.py`
- [Course helpers](https://github.com/thomasitoborbon/ift383-course/blob/main/tools/ift383lib/common.py): `tools/ift383lib/common.py`
- [Visible checks](https://github.com/thomasitoborbon/ift383-course/blob/main/tools/check.py): `tools/check.py`
- [Receipt helpers](https://github.com/thomasitoborbon/ift383-course/blob/main/tools/ift383lib/receipt.py): `tools/ift383lib/receipt.py`
- [Submission packager](https://github.com/thomasitoborbon/ift383-course/blob/main/tools/submit.py): `tools/submit.py`
- **Canvas ZIP**

### Inventory tool

- [CLI launcher](https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory.py): `inventory-tool/inventory.py`
- [Command boundary](https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/cli.py): `inventory-tool/inventory_tool/cli.py`
- [Config reader](https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/scan.py): `inventory-tool/inventory_tool/scan.py`
- [Directory scanner](https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/scan.py): `inventory-tool/inventory_tool/scan.py`
- [Report formatter](https://github.com/thomasitoborbon/ift383-course/blob/main/inventory-tool/inventory_tool/report.py): `inventory-tool/inventory_tool/report.py`
- **Report output**

### Other components

- **Student**
- **Canvas**
- **Inventory user**

## Connections

- Student → Labs 1–7: completes (evidence: `README.md`)
- Student → Final project: completes (evidence: `README.md`)
- Student → Local setup: runs setup (evidence: `README.md`)
- Local setup → Course helpers: saves identity (evidence: `tools/setup.py`)
- Local setup → Receipt helpers: creates secret (evidence: `tools/setup.py`)
- Student → Visible checks: runs checks (evidence: `README.md`)
- Visible checks → Course helpers: runs checks (evidence: `tools/check.py`)
- Student → Submission packager: requests package (evidence: `README.md`)
- Submission packager → Course helpers: uses helpers (evidence: `tools/submit.py`)
- Submission packager → Receipt helpers: uses receipt (evidence: `tools/submit.py`)
- Submission packager → Canvas ZIP: creates and validates (evidence: `tools/submit.py`)
- Student → Canvas: uploads ZIP (evidence: `README.md`)
- Inventory user → CLI launcher: runs (evidence: `inventory-tool/inventory.py`)
- CLI launcher → Command boundary: dispatches (evidence: `inventory-tool/inventory.py`)
- Command boundary → Config reader: loads config (evidence: `inventory-tool/inventory_tool/cli.py`)
- Command boundary → Directory scanner: scans directory (evidence: `inventory-tool/inventory_tool/cli.py`)
- Command boundary → Report formatter: formats records (evidence: `inventory-tool/inventory_tool/cli.py`)
- Command boundary → Report output: writes report (evidence: `inventory-tool/inventory_tool/cli.py`)
