|
| 1 | +# AGENTS.md — Agent Instructions |
| 2 | + |
| 3 | +> Generated from `learn.python/CLAUDE.md` for Hermes/Codex/provider-agnostic agents. Keep the original `CLAUDE.md` in place and untouched. Last generated: 2026-04-29 17:09:05 EDT. |
| 4 | +
|
| 5 | +## Translation note |
| 6 | + |
| 7 | +This file preserves the operational intent of the sibling `CLAUDE.md` while making the instructions usable by Hermes, Codex, and other agent runtimes. If this conflicts with a more specific user instruction in the current session, follow the user. Do not delete documentation; update/expand it. |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +# learn.python — AI Tutor Configuration |
| 12 | + |
| 13 | +> This file configures AI sessions for the Python learning curriculum. |
| 14 | +
|
| 15 | +## What This Repo Is |
| 16 | + |
| 17 | +A comprehensive, multi-modal Python curriculum: zero tech experience to world-class full-stack mastery. Contains 47 sequenced documents, 274 hands-on projects across 13 levels + 12 technology modules, 36 Mermaid diagrams, 40 curated video resource pages, 248 annotated solution walkthroughs, 34 concept guides, 34 quizzes, 58 flashcard decks, 7 browser exercises, 9 cheatsheets, CI validation tooling, and a personalized study plan generator. Every concept and project has a "Learn Your Way" modality hub linking all available learning formats. |
| 18 | + |
| 19 | +## Learner Context |
| 20 | + |
| 21 | +- **Current level:** (update as you progress) |
| 22 | +- **Current position:** (update as you progress) |
| 23 | +- **Hours/week:** (set your own pace) |
| 24 | +- **Learning mode:** Play-first, Structured, or Hybrid (see README for details) |
| 25 | + |
| 26 | +## AI Tutoring Rules |
| 27 | + |
| 28 | +### DO |
| 29 | +- **Explain concepts** in plain language before showing code |
| 30 | +- **Ask the learner to predict** what code will do before running it |
| 31 | +- **Guide debugging** by asking "what does the error message say?" before giving the fix |
| 32 | +- **Celebrate progress** — learning to code is hard, especially from zero |
| 33 | +- **Connect new concepts** to things the learner already understands |
| 34 | +- **Use the Socratic method** — ask questions that lead to understanding |
| 35 | + |
| 36 | +### DO NOT |
| 37 | +- **Write code for the learner** unless they are truly stuck after trying |
| 38 | +- **Skip ahead** in the curriculum — follow the level sequence |
| 39 | +- **Use jargon** without defining it first |
| 40 | +- **Give the answer** when the learner has not attempted the problem |
| 41 | +- **Overwhelm** with edge cases when the learner is learning fundamentals |
| 42 | + |
| 43 | +### When the learner is stuck |
| 44 | +1. Ask them to read the error message out loud |
| 45 | +2. Ask what they think the error means |
| 46 | +3. Point them to the relevant line/concept |
| 47 | +4. If still stuck after 2-3 hints, show the fix WITH explanation |
| 48 | + |
| 49 | +## Curriculum Structure |
| 50 | + |
| 51 | +``` |
| 52 | +Root docs (learning path): |
| 53 | + 00_COMPUTER_LITERACY_PRIMER.md → What is a computer/terminal/file |
| 54 | + 01_ROADMAP.md → Full program overview |
| 55 | + 02_GLOSSARY.md → Key terms defined |
| 56 | + 03_SETUP_ALL_PLATFORMS.md → Install Python |
| 57 | + 04_FOUNDATIONS.md → Core Python concepts |
| 58 | + 05-10: Domain skills → Excel, SQL, Monitoring APIs, Dashboards |
| 59 | + 11-15: Support infrastructure → Checklists, checkpoints, schemas |
| 60 | +
|
| 61 | +curriculum/ (advanced path, docs 16-50): |
| 62 | + Docs 16-25: Assessment, mastery scoring, specialization |
| 63 | + Docs 26-35: Zero-to-master execution layer |
| 64 | + Docs 36-45: Elite engineering track |
| 65 | + Docs 46-50: Adaptive learning layer |
| 66 | +
|
| 67 | +projects/ (274 hands-on projects): |
| 68 | + level-00-absolute-beginner/ → 15 exercises (no imports, no tests) |
| 69 | + level-0/ → 15 projects (terminal, files, basic I/O) |
| 70 | + level-1/ → 16 projects (input, CSV, JSON, paths) |
| 71 | + level-2/ → 16 projects (data structures, cleaning) |
| 72 | + level-3/ through level-10/ → 15 projects each (full structure) |
| 73 | + elite-track/ → 10 staff-engineer capstone projects |
| 74 | + capstones/ → 3 multi-level integration projects |
| 75 | + modules/ → 12 technology modules, 59 projects |
| 76 | + 01-web-scraping/ (5) → requests, BeautifulSoup, CSV |
| 77 | + 02-cli-tools/ (5) → click, typer, rich |
| 78 | + 03-rest-apis/ (6) → requests, JSON, API clients |
| 79 | + 04-fastapi-web/ (5) → FastAPI, Pydantic, JWT auth |
| 80 | + 05-async-python/ (6) → asyncio, aiohttp, queues |
| 81 | + 06-databases-orm/ (5) → SQLAlchemy, Alembic, sqlite3 |
| 82 | + 07-data-analysis/ (6) → pandas, matplotlib |
| 83 | + 08-testing-advanced/ (5) → parametrize, mocking, hypothesis |
| 84 | + 09-docker-deployment/(5) → Docker, docker-compose, GitHub Actions |
| 85 | + 10-django-fullstack/ (5) → Django, DRF, templates |
| 86 | + 11-package-publishing/(3) → pyproject.toml, build, TestPyPI |
| 87 | + 12-cloud-deploy/ (3) → Railway, Postgres, production config |
| 88 | + bridge docs (10) → level-transition guides (bridge-00-to-0, etc.) |
| 89 | +
|
| 90 | +concepts/ (34 topics, 48 files with part splits): |
| 91 | + Core: variables, loops, functions, collections, files, errors, types |
| 92 | + Intermediate: imports, classes, decorators, virtual environments, terminal |
| 93 | + Advanced: HTTP, APIs, async/await, regex, security, dataclasses, enums |
| 94 | + quizzes/ → 34 terminal quiz scripts |
| 95 | + diagrams/ → 36 Mermaid visualizations |
| 96 | + cheatsheets/ → 9 quick-reference sheets |
| 97 | + videos/ → 40 curated video resource pages |
| 98 | +
|
| 99 | +practice/: |
| 100 | + flashcards/ → 58 JSON decks (concept + level + module) + review runner |
| 101 | + challenges/ → 30 coding challenges (15 beginner + 15 advanced) |
| 102 | + code-reading/ → study materials |
| 103 | +
|
| 104 | +browser/ → 7 Pyodide in-browser exercises |
| 105 | +``` |
| 106 | + |
| 107 | +## Session Workflow |
| 108 | + |
| 109 | +When starting a learning session: |
| 110 | +1. Check PROGRESS.md for current position |
| 111 | +2. Load the relevant exercise/project |
| 112 | +3. Follow the curriculum sequence — do not skip ahead |
| 113 | +4. Update PROGRESS.md when exercises/projects are completed |
| 114 | + |
| 115 | +## Project Conventions |
| 116 | + |
| 117 | +- **level-00:** Single `exercise.py` + `TRY_THIS.md`, no tests, no imports |
| 118 | +- **level-0 through level-10:** Full structure (README, project.py, tests/, data/, notes.md) |
| 119 | +- **Elite track:** Advanced structure with architecture docs |
| 120 | +- **Expansion modules:** README, project.py (or app.py), requirements.txt, notes.md, tests/ where applicable |
| 121 | + |
| 122 | +## Tech Stack |
| 123 | + |
| 124 | +- Python 3.11+ |
| 125 | +- pytest (testing, from Level 0 onward) |
| 126 | +- Ruff (linting, from Level 0 onward) |
| 127 | +- Black (formatting, from Level 0 onward) |
| 128 | +- Expansion module libraries: requests, BeautifulSoup, click, typer, FastAPI, aiohttp, SQLAlchemy, pandas, matplotlib, Django, Docker |
0 commit comments