kwork-api/docs/index.md
root 309556c1a0 docs: simplify documentation structure
- Remove manual API docs (mkdocstrings generates automatically)
- Remove internal docs (ARCHITECTURE, GITEA_PAGES, RELEASE, SEMANTIC_RELEASE)
- Add usage.md with examples
- Simplify index.md
- Update mkdocs.yml (minimal config)
- Remove api_reference.md duplicate
2026-03-29 00:56:45 +00:00

1.0 KiB

Kwork API

Unofficial Python client for Kwork.ru API.

Features

  • Complete async API client (45+ endpoints)
  • Pydantic models for all responses
  • Two-step authentication (cookies + web_auth_token)
  • Comprehensive error handling
  • HTTP/2 support

Installation

uv add kwork-api
# or
pip install kwork-api

Quick Start

from kwork_api import KworkClient

# Login with credentials
async with await KworkClient.login("username", "password") as client:
    # Get catalog
    catalog = await client.catalog.get_list(page=1)
    
    # Get projects
    projects = await client.projects.get_list()
    
    # Get user info
    user = await client.user.get_info()

Documentation