Skip to content

Commit d047956

Browse files
committed
Create AGENTS.md
1 parent 20c7289 commit d047956

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# PROJECT KNOWLEDGE BASE
2+
3+
**Generated:** 2026-01-13
4+
5+
## OVERVIEW
6+
Python 3.8+ library for Capsolver service API. Supports both synchronous (`requests`) and asynchronous (`aiohttp`) operations. Uses `msgspec` for high-performance JSON serialization.
7+
8+
## STRUCTURE
9+
```
10+
./
11+
├── src/python3_capsolver/ # Main library package
12+
│ ├── core/ # Base classes, serializers, instruments
13+
│ └── *.py # Service-specific implementations (ReCaptcha, Cloudflare, etc.)
14+
├── tests/ # Pytest suite
15+
└── docs/ # Sphinx documentation
16+
```
17+
18+
## WHERE TO LOOK
19+
| Task | Location | Notes |
20+
|------|----------|-------|
21+
| **Base Logic** | `src/python3_capsolver/core/` | `base.py`, `serializer.py`, `enum.py` |
22+
| **Service Implementations** | `src/python3_capsolver/*.py` | `recaptcha.py`, `cloudflare.py`, etc. |
23+
| **Tests** | `tests/` | Matches source structure |
24+
| **Configuration** | `pyproject.toml` | Build, dependency, tool config |
25+
26+
## CONVENTIONS
27+
- **Formatter**: `black` (line-length 120), `isort` (profile "black").
28+
- **Serialization**: `msgspec` preferred over `json` for performance.
29+
- **Concurrency**: Dual support (Sync/Async) required for all instruments.
30+
- **Retries**: `tenacity` library used for resilience.
31+
32+
## COMMANDS
33+
```bash
34+
make tests # Run test suite
35+
pip install . # Install package locally
36+
```
37+
38+
## NOTES
39+
- Dependencies: `requests`, `aiohttp`, `msgspec`, `tenacity`.
40+
- Requires `API_KEY` in environment for tests.
41+

0 commit comments

Comments
 (0)