f7ab02d3cf
- 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
37 lines
652 B
Markdown
37 lines
652 B
Markdown
# KworkClient
|
|
|
|
Kwork.ru API client.
|
|
|
|
Usage:
|
|
# Login with credentials
|
|
client = await KworkClient.login("username", "password")
|
|
|
|
# Or restore from token
|
|
client = KworkClient(token="your_web_auth_token")
|
|
|
|
# Make requests
|
|
catalog = await client.catalog.get_list(page=1)
|
|
|
|
## Methods
|
|
|
|
### `login(username: str, password: str, timeout: float = 30.0)`
|
|
|
|
Login with username and password.
|
|
|
|
Args:
|
|
username: Kwork username or email
|
|
password: Kwork password
|
|
timeout: Request timeout
|
|
|
|
Returns:
|
|
Authenticated KworkClient instance
|
|
|
|
Raises:
|
|
KworkAuthError: If login fails
|
|
|
|
|
|
### `close()`
|
|
|
|
Close HTTP client.
|
|
|