Metadata-Version: 2.4
Name: cit-course-tools
Version: 0.3.0b6
Summary: Terminal workbench, model simulator, evidence, and lab-testing tools for CIT classes
Author: Jeffrey Myers II, M.S.
Keywords: CIT,course tools,education,llama.cpp,simulation,testing
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Education
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: jsonschema<5,>=4.23
Requires-Dist: packaging>=24
Requires-Dist: PyYAML<7,>=6.0.2
Requires-Dist: textual<9,>=8.2

# CIT Course Tools

`cit-course-tools` gives students one small terminal interface for preparing a
course workspace, exploring deterministic model scenarios, testing cumulative
Python harnesses, and producing consistent lab evidence. Its Textual TUI offers
the guided everyday workflow, while six explicit CLI commands remain available
for transparency, scripting, and troubleshooting. The package is
course-agnostic: instructor-provided YAML defines what each lab teaches and
tests.

The goal is a simple student experience with rigorous behavior underneath.
The package manages ports, simulator sessions, graph traversal, evidence,
fractional scoring, and current-result reports. It does not download course
scenario files, AI models, llama.cpp, or other external software.

## Install

Python 3.10 or newer is required.

```console
python -m pip install cit-course-tools
```

To update later in the semester:

```console
python -m pip install --upgrade cit-course-tools
```

## Start a course workspace

Navigate to the directory you want to use and initialize it once:

```console
cit-course init .
```

The command creates the submitted orientation lab `labs/lab00` and the regular
`labs/lab01` through `labs/lab12`. Each directory under `labs/` holds its YAML
and, when generated, `labNN-submission.zip`. Matching working files live under
`project/labNN/`: the evaluation, runtime logs, and current test results.
The command preserves student work and refreshes only the package-managed Lab
00 guide when needed.

Version 0.2.6 includes a one-release migration for workspaces created by an
earlier release. During `init`, a non-empty legacy `labs/labNN/submission/`
directory is first copied into a verified `labNN-submission.zip`; its evaluation
is preserved under `project/labNN/evaluation.md`; only then is the old directory
removed. An empty legacy directory is removed directly. This compatibility
bridge is scheduled for removal after students have updated.

Lab 00 contains `interaction-guide.yaml`. Download later labs' YAML files from
the course site and place each one in its matching lab directory. The package
does not generate or download course-specific lab suites.

The scaffold also creates a preserved `project/project_harness.py` starter and
`project/SIM_AGENTS.md`. The latter is a stable, course-agnostic instruction
fixture for simulator tests. Labs that require a harness select the Python file
automatically. It must export `run_harness(context)`.

After initialization, start with:

```console
cit-course specs
```

Review the resulting `specs/hardware_specs.txt` before sharing it.

## Open the student TUI

From anywhere inside the initialized workspace, run:

```console
cit-course
```

The base TUI provides a dashboard, lab selection, the always-available
Interaction Guide, single-terminal Guided Interaction, isolated lab tests,
evidence and specs views, and validated submission packaging. Model Simulator
activity remains separate from User Simulator prompts and responses.

Use `cit-course --help` to see the explicit CLI. The TUI calls the same
workspace, simulator, test, evidence, specs, and packaging services; it is not a
parallel implementation.

## Learn the simulator

The recommended path is to run `cit-course`, choose **Interaction Guide**, and
start Guided Interaction. The TUI runs the separate Model and User Simulator
services together, displays their turns in one chronological conversation, and
keeps Model Simulator activity available as a separate alternate view.

The transparent two-terminal CLI path remains available. Start the Model
Simulator with `labs/lab00/interaction-guide.yaml`; the bare `serve` command
selects it automatically:

```console
cit-course serve
```

Leave it running, then start the User Simulator in a second terminal:

```console
cit-course run
```

The guide introduces the package and its simulator workflow without requiring
a download. Explore its paths because the submitted Lab 00 evaluation asks
questions answered by the guide.

When finished, run the Lab 00 suite and generate its submission files:

```console
cit-course test
```

After completing `project/lab00/evaluation.md`, create its upload-ready ZIP:

```console
cit-course package lab00
```

## Explore a lab scenario

To explore an instructor-supplied lab instead, start its YAML file explicitly:

```console
cit-course serve labs/lab01/lab01.yaml
```

Then run the User Simulator in a second terminal anywhere inside the same
initialized workspace:

```console
cit-course run
```

The package discovers the active lab automatically. The `serve` terminal shows
model-service activity; the `run` terminal stays focused on predefined user
prompts and Model Simulator responses. The Model Simulator uses port 8081 and
the User Simulator uses port 8082 by default.

## Run a lab test suite

Bare `cit-course test` selects Lab 00. Instructor-supplied labs use an explicit
YAML path. When the YAML requires a harness, the default project harness is
selected automatically:

```console
cit-course test labs/lab01/lab01.yaml
```

The Python file must export one function:

```python
def run_harness(context):
    """Run one complete simulator-test or local-model interaction session."""
```

The harness should write persistent runtime artifacts beneath
`context.artifacts_directory`. The context also identifies the active Markdown
instruction file as `context.instructions_path`; a harness can load it and send
its complete text as a system message. When a YAML step declares
`conversation_log: true`, the runner checks records newly appended to the lab's
working `conversation.jsonl`. The JSONL records identify requests, responses,
timestamps, the model, status, and errors without recording credentials.

An alternate Python filename can be selected explicitly with `--harness`.
The full suite runs by default. During implementation, rerun only failed,
errored, and incomplete steps with:

```console
cit-course test labs/lab03/lab03.yaml \
  --continue
```

For an alternate harness file:

```console
cit-course test labs/lab03/lab03.yaml --harness project/my_harness.py
```

Each selectable prompt-response step is worth no more than one point. If three
of five required checks pass, that step earns `0.60 / 1.00`. Infrastructure
errors are reported clearly and excluded from grading.

Every run replaces the current generated report and evidence without touching
the evaluation or another lab:

```text
project/lab03/
├── evaluation.md
├── logs/
│   └── conversation.jsonl  # when required by the YAML
└── results/
    ├── evidence.jsonl
    └── test-summary.md
```

`evaluation.md` is created during initialization and never overwritten.
Students complete it in their own words. The evidence trace and test summary
are regenerated by the package.

## Package a lab for submission

When the evaluation and current test results are ready, run:

```console
cit-course package lab03
```

The command gathers only the required, allow-listed files and atomically
creates or replaces:

```text
labs/lab03/lab03-submission.zip
```

The ZIP includes a generated `submission-manifest.json` with test identity and
file hashes. It never includes the YAML, harness, unrelated logs, an older ZIP,
or the rest of the workspace, and it does not upload anything.

## Run the project harness with a real local model

The same cumulative `run_harness(context)` implementation can run as an
ordinary terminal application against llama-server or another
OpenAI-compatible local service. Start the real model server first, normally at
`http://127.0.0.1:8080`, and then run:

```console
python project/project_harness.py
```

The standalone adapter discovers the served model through `/v1/models`, reads
user prompts from the terminal, and supplies empty simulator-specific headers.
It uses `project/AGENTS.md` when that optional student-authored file exists and
otherwise falls back to `project/SIM_AGENTS.md`. Enter `q` at the User Prompt
to stop. An alternate server root, advertised model ID, or instruction file can
be selected explicitly:

```console
python project/project_harness.py --model-url http://127.0.0.1:9000
python project/project_harness.py --model my-model-alias
python project/project_harness.py --instructions project/AGENTS.md
```

Run `python project/project_harness.py --help` for all standalone options. The
student-authored core remains the same: tests import `run_harness(context)` and
supply deterministic User Simulator prompts, while direct execution supplies
terminal prompts and the real local endpoint.

## Hardware report

Create or refresh the optional, privacy-conscious hardware report from anywhere
inside the workspace:

```console
cit-course specs
```

It is written to `specs/hardware_specs.txt`. Review it before sharing it.

## Commands

```text
cit-course init     Create or repair the course workspace
cit-course specs    Generate the optional hardware report
cit-course serve    Start the Model Simulator with the guide or a lab YAML file
cit-course run      Start the User Simulator for the active lab
cit-course test     Run Lab 00 or an explicit lab suite and replace its report
cit-course package  Create one lab's upload-ready ZIP from required current files
```

Run `cit-course --help` or `cit-course COMMAND --help` for options.

## Instructor and developer references

- `TECHNICAL_SUMMARY.md` provides a concise comprehensive architecture and
  workflow summary.
- `SCENARIO_AUTHORING.md` documents the YAML authoring and scoring contract.
- `TECHNICAL_SPECIFICATION.md` documents components, isolation, evidence, and
  runtime behavior.
- `PUBLISHING.md` contains the release checklist.

Run the complete regression suite with:

```console
python -m unittest discover -s tests -v
```
