much-data/kwork-api
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
7 Commits 2 Branches 0 Tags 1,010 KiB
86149e0196
Commit Graph

7 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
root
86149e0196 Setup mkdocstrings inline documentation 
- Remove custom generate_docs.py script
- Use mkdocstrings inline ::: syntax in markdown files
- docs/api-reference.md: Main API reference with inline docs
- docs/api/*.md: Category pages with inline injections
- Pre-commit: Build mkdocs on commit

Documentation now uses standard mkdocstrings approach.
 2026-03-23 03:54:54 +00:00
root
f7ab02d3cf Generate markdown API docs with griffe 
- scripts/generate_docs.py: Generate .md files from docstrings
- docs/api/*.md: Auto-generated API documentation
- Pre-commit hook: Auto-generate markdown on commit
- Uses griffe AST parser (no code execution)

Generated files:
- docs/api/index.md
- docs/api/kworkclient.md
- docs/api/client/*.md
- docs/api/models/*.md
- docs/api/errors/*.md
 2026-03-23 03:52:07 +00:00
root
080e5ddc72 Update WIP.md with documentation status 2026-03-23 03:46:30 +00:00
root
104aedbcf4 Update WIP.md with endpoint analysis 2026-03-23 03:26:21 +00:00
root
70fbc7a035 Update WIP.md with endpoint analysis 2026-03-23 03:17:30 +00:00
Claw
fae04b0896 Add WIP.md with project status 2026-03-23 03:01:02 +00:00
root
ccc670b79c Initial commit: kwork-api v0.1.0 
Features:
- Full API coverage (45 endpoints from HAR analysis)
- Async/await support with httpx
- Pydantic models for all responses
- Clear error handling (KworkAuthError, KworkApiError, etc.)
- Session management (cookies + web_auth_token)
- Unit tests with respx mocks
- Integration tests template
- JSON logging support via structlog

Endpoints implemented:
- Authentication: signIn, getWebAuthToken
- Catalog: catalogMainv2, getKworkDetails, getKworkDetailsExtra
- Projects: projects, payerOrders, workerOrders
- User: user, userReviews, favoriteKworks
- Reference: cities, countries, timezones, features, badges
- Notifications: notifications, notificationsFetch, dialogs
- Other: 30+ additional endpoints

Tests: 13 passed, 79% coverage
 2026-03-23 02:48:44 +00:00