- 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
25 lines
531 B
Markdown
25 lines
531 B
Markdown
# kwork_api
|
|
|
|
Kwork.ru API Client
|
|
|
|
Unofficial Python client for Kwork.ru API.
|
|
|
|
Example:
|
|
from kwork_api import KworkClient
|
|
|
|
# Login with credentials
|
|
client = await KworkClient.login("username", "password")
|
|
|
|
# Or restore from token
|
|
client = KworkClient(token="your_web_auth_token")
|
|
|
|
# Get catalog
|
|
catalog = await client.catalog.get_list(page=1)
|
|
|
|
## Classes
|
|
|
|
- [KworkClient](kworkclient.md)
|
|
- [KworkError](kworkerror.md)
|
|
- [KworkAuthError](kworkautherror.md)
|
|
- [KworkApiError](kworkapierror.md)
|