kwork-api

much-data/kwork-api

Fork 0

Commit Graph

Author	SHA1	Message	Date
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

Author

SHA1

Message

Date

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

2 Commits