Skip to content

Commit d65d8e8

Browse files
refactoring
1 parent d25eec9 commit d65d8e8

15 files changed

Lines changed: 1830 additions & 27 deletions

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ Generated on 2026-03-29 using [openrouter/qwen/qwen3-coder-next](https://openrou
6464
- 🤖 **LLM-Powered**: AI-driven bug reports and auto-fix capabilities
6565
- 📊 **Progress Tracking**: Review strategy execution with detailed metrics
6666
- 🚀 **CLI Tool**: Easy-to-use command-line interface for applying and reviewing strategies
67+
- 🐍 **Python Library**: Use planfile programmatically in your Python applications
68+
- 🌐 **REST API**: Run as FastAPI server for HTTP access and integrations
6769
- 🎨 **Rich Output**: Beautiful terminal output with progress bars and tables
6870
- 🐳 **Docker Support**: Containerized deployment with Ollama integration
6971
- 🔧 **Extensible**: Easy to add new backends and custom integrations
@@ -166,7 +168,43 @@ planfile strategy review \
166168
--backend github
167169
```
168170

169-
### 4. Using Makefile
171+
### 4. Using Python Library
172+
173+
```python
174+
from planfile import Planfile, quick_ticket
175+
176+
# Auto-discover .planfile/ in your project
177+
pf = Planfile.auto_discover(".")
178+
179+
# Create tickets programmatically
180+
ticket = pf.create_ticket(
181+
title="Fix authentication bug",
182+
description="Users cannot login with OAuth",
183+
priority="high",
184+
labels=["bug", "backend"]
185+
)
186+
187+
# List and filter tickets
188+
tickets = pf.list_tickets(sprint="current", status="open")
189+
190+
# Quick one-liner for tools
191+
ticket = quick_ticket("Production alert", tool="monitoring", priority="critical")
192+
```
193+
194+
### 5. Using REST API
195+
196+
```bash
197+
# Start the FastAPI server
198+
uvicorn planfile.api.server:app --reload --port 8000
199+
200+
# Use the API
201+
curl "http://localhost:8000/tickets?sprint=current"
202+
curl -X POST "http://localhost:8000/tickets" \
203+
-H "Content-Type: application/json" \
204+
-d '{"title": "API fix", "priority": "high"}'
205+
```
206+
207+
### 6. Using Makefile
170208

171209
```bash
172210
# Run CI loop with strategy

0 commit comments

Comments
 (0)