Self-contained, skip-friendly lab starting points (#103)
Co-authored-by: claude <claude@jpaul.io> Co-committed-by: claude <claude@jpaul.io>
This commit was merged in pull request #103.
This commit is contained in:
@@ -205,6 +205,18 @@ the more you need a reviewer that checks behavior instead of believing the diff.
|
||||
|
||||
## Hands-on lab
|
||||
|
||||
|
||||
> **Starting point (this lab is skip-friendly).** You do not need to have done the earlier labs.
|
||||
> To begin from a clean, known state, copy this module's snapshot into a fresh `tasks-app` and
|
||||
> make the first commit:
|
||||
>
|
||||
> ```bash
|
||||
> mkdir -p ~/ai-workflow-course/tasks-app
|
||||
> cp -r ~/ai-workflow-course/modules/14-continuous-integration/lab/start/. ~/ai-workflow-course/tasks-app/
|
||||
> cd ~/ai-workflow-course/tasks-app && git init -b main && git add -A && git commit -m "start: module 14"
|
||||
> ```
|
||||
>
|
||||
> Already carrying your `tasks-app` from earlier modules? Keep using it and ignore this box.
|
||||
**Lab language:** YAML (the CI config) plus the Python `tasks-app` and shell commands. You direct
|
||||
the agent to place files, commit, and recover; you commit a starter workflow, watch it pass, then
|
||||
break it on purpose and watch CI catch it.
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# Demo app: `tasks`
|
||||
|
||||
A deliberately tiny command-line task tracker. It exists to be *changed by an AI*, so it's small
|
||||
enough to read in a minute but real enough to have more than one file, which is exactly where the
|
||||
copy-paste workflow starts to hurt.
|
||||
|
||||
This is the running example for **Module 1** (where you feel the copy-paste problem) and **Module 2**
|
||||
(where you put it under version control).
|
||||
|
||||
## Files
|
||||
|
||||
- `tasks.py`: the core logic (`Task`, `TaskList`).
|
||||
- `cli.py`: the command-line front end. Reads/writes `tasks.json`.
|
||||
|
||||
## Run it
|
||||
|
||||
```bash
|
||||
python cli.py add "read module 1"
|
||||
python cli.py add "set up my editor"
|
||||
python cli.py list
|
||||
python cli.py done 0
|
||||
python cli.py list
|
||||
```
|
||||
|
||||
Requires Python 3.10+ (it uses `list[Task]` style type hints). No third-party packages.
|
||||
@@ -0,0 +1,62 @@
|
||||
"""Tiny command-line front end for the demo task app.
|
||||
|
||||
Run it:
|
||||
python cli.py add "write the lesson"
|
||||
python cli.py list
|
||||
|
||||
State is kept in tasks.json next to this file. It's intentionally minimal; the point of this app
|
||||
is to be a realistic-but-small thing you change with an AI, not a product.
|
||||
"""
|
||||
|
||||
import json
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from tasks import Task, TaskList
|
||||
|
||||
STATE = Path(__file__).parent / "tasks.json"
|
||||
|
||||
|
||||
def load() -> TaskList:
|
||||
if not STATE.exists():
|
||||
return TaskList()
|
||||
raw = json.loads(STATE.read_text())
|
||||
return TaskList(tasks=[Task(**t) for t in raw])
|
||||
|
||||
|
||||
def save(tlist: TaskList) -> None:
|
||||
STATE.write_text(json.dumps([t.__dict__ for t in tlist.tasks], indent=2))
|
||||
|
||||
|
||||
def main(argv: list[str]) -> int:
|
||||
tlist = load()
|
||||
if not argv:
|
||||
print("usage: python cli.py [add <title> | list | done <index> | count | delete <index>]")
|
||||
return 1
|
||||
|
||||
command = argv[0]
|
||||
if command == "add":
|
||||
title = " ".join(argv[1:])
|
||||
tlist.add(title)
|
||||
save(tlist)
|
||||
print(f"added: {title}")
|
||||
elif command == "list":
|
||||
print(tlist.render())
|
||||
elif command == "done":
|
||||
tlist.complete(int(argv[1]))
|
||||
save(tlist)
|
||||
print("updated")
|
||||
elif command == "count":
|
||||
print(f"{len(tlist.pending())} pending")
|
||||
elif command == "delete":
|
||||
tlist.remove(int(argv[1]))
|
||||
save(tlist)
|
||||
print("deleted")
|
||||
else:
|
||||
print(f"unknown command: {command}")
|
||||
return 1
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main(sys.argv[1:]))
|
||||
@@ -0,0 +1,42 @@
|
||||
"""Core task logic for the demo app.
|
||||
|
||||
Deliberately small and deliberately split across two files (this and cli.py) so that the
|
||||
copy-paste workflow has more than one place to go wrong. This is the running example used in
|
||||
Modules 1 and 2.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
|
||||
|
||||
@dataclass
|
||||
class Task:
|
||||
title: str
|
||||
done: bool = False
|
||||
|
||||
|
||||
@dataclass
|
||||
class TaskList:
|
||||
tasks: list[Task] = field(default_factory=list)
|
||||
|
||||
def add(self, title: str) -> Task:
|
||||
task = Task(title=title)
|
||||
self.tasks.append(task)
|
||||
return task
|
||||
|
||||
def complete(self, index: int) -> None:
|
||||
self.tasks[index].done = True
|
||||
|
||||
def remove(self, index: int) -> None:
|
||||
del self.tasks[index]
|
||||
|
||||
def pending(self) -> list[Task]:
|
||||
return [t for t in self.tasks if not t.done]
|
||||
|
||||
def render(self) -> str:
|
||||
if not self.tasks:
|
||||
return "(no tasks yet)"
|
||||
lines = []
|
||||
for i, task in enumerate(self.tasks):
|
||||
box = "[x]" if task.done else "[ ]"
|
||||
lines.append(f"{i}. {box} {task.title}")
|
||||
return "\n".join(lines)
|
||||
Reference in New Issue
Block a user