Commit Graph

6 Commits

Author SHA1 Message Date
root
6ac9c533fa feat: add /api/validation/checktext endpoint with tests
- Add ValidationResponse and ValidationIssue models
- Add client.other.validate_text() method
- Add 3 unit tests for validation endpoint
- Update CI/CD workflow for real test runs
- Update .gitignore for Python projects
- Update documentation and WIP.md
2026-03-28 23:15:16 +00:00
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
root
706dfde40e docs: убран скрипт gen_docs.py, только pre-commit hook
- Удалена директория scripts/
- Убран gen-docs из pyproject.toml
- Документация генерируется только через pre-commit hook
2026-03-23 04:21:12 +00:00
root
a5a1ec5970 docs: полная миграция на pydoc-markdown (убран MkDocs)
- Удалён mkdocs.yml и вся сгенерированная site/ директория
- pydoc-markdown.yml теперь использует markdown renderer напрямую
- Скрипт gen_docs.py генерирует docs/api_reference.md без MkDocs
- Обновлён pre-commit hook для использования pydoc-markdown
- Убраны зависимости MkDocs из конфигурации

Теперь документация генерируется только через pydoc-markdown.
2026-03-23 04:19:09 +00:00
root
8d0e504aea docs: переключение на pydoc-markdown для генерации API документации
- Добавлен pydoc-markdown.yml для конфигурации генерации
- Обновлён mkdocs.yml (убран mkdocstrings, упрощена конфигурация)
- Добавлен скрипт scripts/gen_docs.py для автоматической генерации
- Обновлены зависимости в pyproject.toml (dependency-groups вместо dev-dependencies)
- Сгенерирована новая документация в docs/api_reference.md
2026-03-23 04:17:50 +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