much-data/kwork-api
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
127e5927bc
kwork-api/docs/index.md
root 127e5927bc docs: переход на MkDocs + mkdocstrings для HTML документации 
Рефакторинг:
- OtherAPI упразднён — все методы перемещены в KworkClient
- Методы client.get_wants(), get_kworks_status() и др. теперь напрямую в клиенте
- Удалён property client.other

Документация:
- MkDocs + mkdocstrings + Material theme для HTML сайта
- Навигация, поиск, форматирование кода
- docs/index.md — quick start guide
- docs/api/*.md — API reference с автогенерацией из docstrings
- Pre-commit hook для автогенерации HTML

Зависимости:
- Добавлены: mkdocs, mkdocs-material, mkdocstrings, mkdocstrings-python
- Убран pydoc-markdown (не нужен)

Команды:
- mkdocs build — сборка HTML
- mkdocs serve — локальный просмотр
2026-03-23 04:35:58 +00:00

2.0 KiB
Raw Blame History

Kwork API — Python Client

Unofficial Python client for Kwork.ru API.

Installation

pip install kwork-api

Or with UV:

uv add kwork-api

Quick Start

Login with credentials

from kwork_api import KworkClient

# Authenticate
client = await KworkClient.login("username", "password")

# Get catalog
catalog = await client.catalog.get_list(page=1)

# Get projects
projects = await client.projects.get_list(page=1)

# Close when done
await client.close()

Using context manager

async with await KworkClient.login("username", "password") as client:
    catalog = await client.catalog.get_list(page=1)
    # Client automatically closes

Restore from token

# Save token after login
token = client._token

# Later, restore session
client = KworkClient(token=token)
user_info = await client.user.get_info()

API Overview

Catalog API

  • client.catalog.get_list() — Get kworks catalog
  • client.catalog.get_details(kwork_id) — Get kwork details

Projects API

  • client.projects.get_list() — Get freelance projects
  • client.projects.get_payer_orders() — Your orders as customer
  • client.projects.get_worker_orders() — Your orders as performer

User API

  • client.user.get_info() — Get user profile
  • client.user.get_reviews() — Get user reviews
  • client.user.get_favorite_kworks() — Get favorite kworks

Settings & Preferences

  • client.get_wants() — User preferences
  • client.get_kworks_status() — Kworks status
  • client.update_settings() — Update settings
  • client.go_offline() — Set offline status

See API Reference for full documentation.

Error Handling

from kwork_api import KworkError, KworkAuthError, KworkApiError

try:
    await client.catalog.get_list()
except KworkAuthError:
    print("Invalid credentials")
except KworkApiError as e:
    print(f"API error: {e.status_code}")
except KworkError as e:
    print(f"General error: {e.message}")