Files

T

CI / check (pull_request) Successful in 7s

Details

Use python3 as the canonical command name course-wide (#104 )

Most current systems (default Debian/Ubuntu, recent macOS) install Python
only as `python3`, with no bare `python` on PATH, so learners who copied
`python cli.py ...` into their host shell hit "command not found".

Convert host-shell `python <cmd>` -> `python3 <cmd>` across module/lab
READMEs, lab `.py` docstrings & usage strings, blog posts, lab prompt and
instruction files, the M04 verify.sh message, and the M10/M24 lab patches.
Module 01's convention note (and its blog/02 mirror) is rewritten so
`python3` is canonical and `python` is the documented fallback.

Stop-lines respected: Docker image tags (`python:3.12-slim`), `.venv/.../python`
and `...\.venv\Scripts\python.exe` paths, the M20 `"command": "python"`
teaching example and surrounding venv prose, container-internal invocations
(M16/M18 Dockerfiles, M16 README `docker run` examples), and CI-workflow
`run:` steps fed by `actions/setup-python` / `image: python:3.12` are left
as `python` on purpose.

pip was left out of scope: most occurrences are prose or CI/container-internal,
and `pip3` does not fix the PEP 668 externally-managed-environment refusal that
the course already addresses with venvs. The M01 note is worded to stay
consistent with bare `pip` (use whichever pip pairs with your Python).

Build (tools/build_wiki.py) and tools/check.sh both pass.

Closes #104

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GAEzanEoGJT5o1VizQar47

2026-06-23 20:18:04 -04:00

2.4 KiB

Raw Blame History

Instructions for AI agents working on tasks-app

A tiny command-line task tracker. The point of this project is to be small enough to read in a minute but real enough to have more than one file. Keep it that way; don't grow it into a product.

Project layout

tasks.py: core logic (Task, TaskList). New behavior that isn't about the command line goes here.
cli.py: the command-line front end. Argument parsing and printing only; it calls into tasks.py. Reads and writes tasks.json.
tasks.json: generated state. See "Don't touch" below.

Build and test commands

Run the app: python3 cli.py <command> (e.g. python3 cli.py list).
Run the tests: python3 -m unittest
Do not claim a change works until you have actually run it. If tests exist, they must pass first.

Coding standards

Python 3.10+ . Standard library only; no third-party packages without being asked.
Type-hint public functions and methods. Match the existing dataclass style in tasks.py.
Handle bad input gracefully (e.g. a non-numeric index) rather than letting a raw traceback escape.

Don't touch

Never edit tasks.json by hand. It is generated by the app; hand-editing it corrupts state. Read it if you need to, but change it only by running the CLI.
Don't reformat or rewrite files you aren't actively changing. Keep diffs small and focused.

House style

Keep functions small and single-purpose. Prefer clarity over cleverness.
Match the surrounding code's style; don't introduce a new pattern for something the project already does one way.
When you add a command, wire it into cli.py's dispatch and update the usage string.

2.4 KiB Raw Blame History