Commit Graph

4 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
bdd44dd990 docs: 100% покрытие docstrings — все классы и методы задокументированы
Полная документация всей кодовой базы:

client.py:
- KworkClient — основной класс, аутентификация, примеры
- CatalogAPI — каталог кворков (get_list, get_details, get_details_extra)
- ProjectsAPI — биржа проектов (get_list, get_payer_orders, get_worker_orders)
- UserAPI — пользователь (get_info, get_reviews, get_favorite_kworks)
- ReferenceAPI — справочники (cities, countries, timezones, features, badges)
- NotificationsAPI — уведомления (get_list, fetch, get_dialogs, get_blocked_dialogs)
- OtherAPI — прочее (wants, settings, offline, и т.д.)
- Все property accessor'ы

models.py:
- KworkUser, KworkCategory, Kwork, KworkDetails
- PaginationInfo, CatalogResponse
- Project, ProjectsResponse
- Review, ReviewsResponse
- Notification, NotificationsResponse, Dialog
- AuthResponse, ErrorDetail, APIErrorResponse
- City, Country, TimeZone, Feature, Badge
- DataResponse

errors.py:
- KworkError (базовое)
- KworkAuthError, KworkApiError
- KworkNotFoundError, KworkRateLimitError
- KworkValidationError, KworkNetworkError

Все docstrings на русском языке с примерами использования.
2026-03-23 04:30:10 +00:00
root
86149e0196 Setup mkdocstrings inline documentation
- Remove custom generate_docs.py script
- Use mkdocstrings inline ::: syntax in markdown files
- docs/api-reference.md: Main API reference with inline docs
- docs/api/*.md: Category pages with inline injections
- Pre-commit: Build mkdocs on commit

Documentation now uses standard mkdocstrings approach.
2026-03-23 03:54:54 +00:00