rekipedia 0.13.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -60,6 +60,40 @@ brew install rekipedia
|
|
|
60
60
|
|
|
61
61
|
---
|
|
62
62
|
|
|
63
|
+
## Python API
|
|
64
|
+
|
|
65
|
+
Use rekipedia programmatically inside Jupyter notebooks, CI pipelines, or any Python application:
|
|
66
|
+
|
|
67
|
+
```python
|
|
68
|
+
import rekipedia
|
|
69
|
+
|
|
70
|
+
# Scan a local repo
|
|
71
|
+
result = rekipedia.scan("/path/to/repo")
|
|
72
|
+
print(result.page_count) # number of wiki pages generated
|
|
73
|
+
print(result.symbol_count) # number of code symbols extracted
|
|
74
|
+
print(result.token_count) # estimated token count of the wiki
|
|
75
|
+
|
|
76
|
+
# Ask a question — grounded answer with file:line citations
|
|
77
|
+
answer = rekipedia.ask("/path/to/repo", "How does the auth flow work?")
|
|
78
|
+
print(answer.text)
|
|
79
|
+
for citation in answer.citations:
|
|
80
|
+
print(f" {citation.file}:{citation.line}")
|
|
81
|
+
|
|
82
|
+
# Async variants (Jupyter-friendly)
|
|
83
|
+
result = await rekipedia.scan_async("/path/to/repo")
|
|
84
|
+
answer = await rekipedia.ask_async("/path/to/repo", "What is the entry point?")
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
**Return types:**
|
|
88
|
+
|
|
89
|
+
| Type | Key fields |
|
|
90
|
+
|---|---|
|
|
91
|
+
| `ScanResult` | `page_count`, `symbol_count`, `token_count`, `wiki_pages`, `db_path`, `wiki_dir` |
|
|
92
|
+
| `AskResult` | `text`, `citations: list[Citation]`, `model_used` |
|
|
93
|
+
| `Citation` | `file`, `line`, `snippet` |
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
63
97
|
## Commands
|
|
64
98
|
|
|
65
99
|
| Command | Description |
|
package/package.json
CHANGED