Metadata-Version: 2.4
Name: clawed
Version: 4.3.2026.5
Summary: Your AI co-teacher. Generate lessons, games, slides, and assessments from your terminal. Learns your teaching voice, aligns to your state standards, and works with any LLM provider.
Project-URL: Homepage, https://sirhanmacx.github.io/Claw-ED
Project-URL: Documentation, https://github.com/SirhanMacx/Claw-ED#readme
Project-URL: Repository, https://github.com/SirhanMacx/Claw-ED
Project-URL: Bug Tracker, https://github.com/SirhanMacx/Claw-ED/issues
Project-URL: Changelog, https://github.com/SirhanMacx/Claw-ED/blob/main/CHANGELOG.md
Project-URL: PyPI, https://pypi.org/project/clawed/
Author: Jon Maccarello & Claw-ED contributors
License-Expression: MIT
License-File: LICENSE
Keywords: ai,ai-for-teachers,claw-ed,clawed,curriculum,edtech,education,hermes-agent,k12,lesson-plan-generator,lesson-planner,lesson-planning,lesson-plans,open-source-education,pedagogy,teacher-tools,teachers,teaching,teaching-assistant
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Education
Classifier: Topic :: Education :: Computer Aided Instruction (CAI)
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Requires-Dist: anthropic>=0.39.0
Requires-Dist: apscheduler<4.0,>=3.10.0
Requires-Dist: fastapi<1.0,>=0.110.0
Requires-Dist: gtts>=2.5.0
Requires-Dist: httpx<1.0,>=0.25.0
Requires-Dist: jinja2>=3.1.0
Requires-Dist: json-repair>=0.30.0
Requires-Dist: lxml>=4.9.0
Requires-Dist: mcp>=1.0.0
Requires-Dist: openai>=1.50.0
Requires-Dist: pydantic<3.0,>=2.0.0
Requires-Dist: pymupdf>=1.23.0
Requires-Dist: python-docx>=1.0.0
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: python-pptx>=0.6.21
Requires-Dist: pyyaml<7.0,>=6.0
Requires-Dist: reportlab>=4.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: sse-starlette>=1.6.0
Requires-Dist: typer<1.0,>=0.9.0
Requires-Dist: uvicorn[standard]>=0.27.0
Provides-Extra: all
Requires-Dist: faster-whisper>=0.10.0; extra == 'all'
Requires-Dist: keyring>=24.0.0; extra == 'all'
Requires-Dist: onnxruntime>=1.16.0; extra == 'all'
Requires-Dist: qrcode[pil]>=7.0; extra == 'all'
Requires-Dist: textual>=0.56.0; extra == 'all'
Requires-Dist: uvicorn[standard]>=0.27.0; extra == 'all'
Provides-Extra: dev
Requires-Dist: apscheduler<4.0,>=3.10.0; extra == 'dev'
Requires-Dist: faster-whisper>=0.10.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Provides-Extra: google
Requires-Dist: google-api-python-client>=2.0.0; extra == 'google'
Requires-Dist: google-auth-oauthlib>=1.0.0; extra == 'google'
Provides-Extra: keyring
Requires-Dist: keyring>=24.0.0; extra == 'keyring'
Provides-Extra: memory
Requires-Dist: onnxruntime>=1.16.0; extra == 'memory'
Provides-Extra: pdf
Requires-Dist: weasyprint>=60.0; extra == 'pdf'
Provides-Extra: qr
Requires-Dist: qrcode[pil]>=7.0; extra == 'qr'
Provides-Extra: tui
Requires-Dist: textual>=0.56.0; extra == 'tui'
Provides-Extra: voice
Requires-Dist: faster-whisper>=0.10.0; extra == 'voice'
Description-Content-Type: text/markdown

# Claw-ED

**Your AI co-teacher. Feed it your files, get lessons in your voice.**

  Ed — the Claw-ED mascot

---

```bash
pip install clawed
clawed
```

That's it. Claw-ED detects your setup, walks you through picking an AI provider, and starts learning your teaching style. No config files, no environment variables, no developer knowledge needed.

---

## What It Does

Claw-ED reads your existing lesson plans, handouts, slideshows, and assessments. It extracts your pedagogical fingerprint — how you structure a Do Now, what graphic organizers you use, how you scaffold for ELL and IEP students, your questioning patterns, your signature teaching moves.

Then it generates new lessons that actually match. Same structure, same voice, same scaffolding.

```bash
clawed ingest ~/Documents/Lessons/        # Teach it your style
clawed lesson "The Missouri Compromise" -g 8 -s "US History"
```

**What you get:**

- Complete daily lesson plans in your format (DOCX, PPTX, PDF)
- Unit plans with essential questions and pacing
- Assessments aligned to your state standards (50 states supported)
- Differentiated materials for ELL, IEP, and gifted students
- Interactive HTML games and simulations
- Homework, rubrics, sub plans, parent communications
- A compiled curriculum wiki you can query
- Morning prep that runs before you wake up

---

## First-Run Experience

When you run `clawed` for the first time, you see a guided setup:

1. Pick your AI provider (Google Gemini free tier, Ollama Cloud, Claude, GPT, or local Ollama)
2. Paste your API key
3. Choose terminal chat or Telegram bot
4. Optionally point it at your curriculum folder

Then you're chatting with your AI co-teacher. No command line knowledge required.

---

## Commands

| Command | What it does |
|---------|-------------|
| `clawed` | Chat with your AI co-teacher |
| `clawed ingest <path>` | Teach it your style from your files |
| `clawed lesson "Topic" -g 8 -s "Subject"` | Generate a daily lesson plan |
| `clawed unit "Topic" -g 9 -w 3` | Plan a 3-week unit |
| `clawed full "Topic" -g 10` | Full package: unit + lessons + materials |
| `clawed materials -l lesson.json` | Generate supporting materials |
| `clawed assess "Topic" --type dbq` | Generate assessments (DBQ, quiz, rubric) |
| `clawed differentiate -l lesson.json` | Create IEP/504/ELL modifications |
| `clawed game create "Topic" -g 8` | Interactive HTML learning game |
| `clawed simulate create "Topic" -g 9` | Interactive HTML simulation |
| `clawed kb compile` | Compile your curriculum into a searchable wiki |
| `clawed kb query "question"` | Ask questions against your wiki |
| `clawed kb lint` | Check your wiki for stale or missing articles |
| `clawed standards list -g 8 -s "Math"` | Browse state standards |
| `clawed gap-analyze` | Find curriculum coverage gaps |
| `clawed score -l lesson.json` | Score lesson quality |
| `clawed bot` | Start Telegram bot (chat from your phone) |
| `clawed serve` | Web dashboard |
| `clawed demo` | Try it without an API key |
| `clawed setup` | Re-run the setup wizard |

---

## Curriculum Wiki

Claw-ED compiles your ingested materials into an organized markdown wiki. Think of it as a personal knowledge base built from your own curriculum.

```bash
clawed ingest ~/Documents/Curriculum/     # Ingest your files
clawed kb compile                          # Compile into wiki articles
clawed kb query "What primary sources do I have on the Civil War?"
clawed kb lint                             # Check for stale or missing articles
```

The wiki is stored as plain markdown files in `~/.eduagent/wiki/` — viewable in any text editor, Obsidian, or VS Code. Incremental compilation means only changed documents get reprocessed.

---

## AI Providers

Claw-ED works with any AI provider. Pick one during setup:

| Provider | Cost | Best for |
|----------|------|----------|
| Google Gemini | Free tier available | Getting started |
| Ollama Cloud | $20/month unlimited | Daily use |
| Ollama Local | Free | Complete privacy |
| OpenRouter | Pay-per-use | Access to any model |
| Anthropic Claude | ~$0.05/lesson | Opus 4.6 / Sonnet 4.6 |
| OpenAI GPT | ~$0.04/lesson | GPT-5.4 |

Run `clawed setup` anytime to switch providers.

---

## Voice Learning

Claw-ED doesn't use a generic "teacher tone." It extracts your specific patterns:

- **Teaching structure:** How you organize lessons (I Do / We Do / You Do, stations, jigsaw)
- **Questioning style:** Your progression from recall to analysis to evaluation
- **Scaffolding moves:** Sentence starters, graphic organizers, writing frames you use
- **Assessment patterns:** Your Do Now format, exit ticket style, essay scaffolds
- **Classroom personality:** Your humor, your catchphrases, your signature moves

---

## Standards Alignment

Built-in support for all 50 US states:

- Common Core (CCSS) — Math and ELA
- Next Generation Science Standards (NGSS)
- C3 Framework — Social Studies
- State-specific frameworks (NY NGLS, TX TEKS, CA CCSS, VA SOL, and more)

---

## Professional Export

- **DOCX** — Print-ready with headers, differentiation callouts, and images
- **PPTX** — Themed slideshows with voice narration (`--narrate`)
- **PDF** — Clean layout for distribution
- **HTML** — Interactive games and simulations

---

## Privacy

- **Local-first.** Your files stay on your machine.
- **API keys in OS keychain.** macOS Keychain, Windows Credential Manager, Linux Secret Service.
- **No telemetry, no data collection, no accounts.**
- **Your choice of provider.** Use free local models for complete privacy, or cloud for quality.

---

## For Developers

```bash
git clone https://github.com/SirhanMacx/Claw-ED.git
cd Claw-ED
pip install -e ".[dev]"
pytest tests/
```

**MCP Server** — Expose Claw-ED tools to Claude Code, VS Code, and other AI editors:

```bash
clawed mcp-server
```

**Python API:**

```python
from clawed.lesson import generate_lesson
from clawed.models import AppConfig

config = AppConfig.load()
lesson = await generate_lesson(
    lesson_number=1, unit=unit_plan,
    persona=persona, config=config,
)
```

---

## Community

Built by a teacher for teachers. 20,000+ installs.

- [GitHub Discussions](https://github.com/SirhanMacx/Claw-ED/discussions) — share, request, ask
- [Report issues](https://github.com/SirhanMacx/Claw-ED/issues)
- [Star the repo](https://github.com/SirhanMacx/Claw-ED)

---

MIT License. Free for personal and commercial use.

[GitHub](https://github.com/SirhanMacx/Claw-ED) | [PyPI](https://pypi.org/project/clawed/) | [Changelog](CHANGELOG.md)
