much-data/kwork-api
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 100% покрытие docstrings — все классы и методы задокументированы

Browse Source 
Полная документация всей кодовой базы:

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 на русском языке с примерами использования.
This commit is contained in:
root 2026-03-23 04:30:10 +00:00
parent a6cb7c1f35
commit bdd44dd990
2 changed files with 1 additions and 2561 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1 +1,2 @@
site/
api_reference.md

2561
api_reference.md
View File

File diff suppressed because it is too large Load Diff