much-data/kwork-api
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
0c22b31e1c
kwork-api/CHANGELOG.md
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

1.9 KiB
Raw Blame History

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Planned

  • Full CI/CD pipeline with Gitea Actions
  • Automatic publishing to Gitea Package Registry
  • Database support for caching (optional)
  • Rate limiting utilities

[0.1.0] - 2026-03-23

Added

  • Initial release
  • Complete Kwork.ru API client with 45+ endpoints
  • Pydantic models for all API responses
  • Comprehensive error handling (7 exception types)
  • 100% docstring coverage (Russian language)
  • MkDocs documentation with mkdocstrings
  • Unit tests with 92% coverage
  • UV package manager support
  • Gitea Actions CI/CD pipeline

Models

  • KworkUser, KworkCategory, Kwork, KworkDetails
  • PaginationInfo, CatalogResponse
  • Project, ProjectsResponse
  • Review, ReviewsResponse
  • Notification, NotificationsResponse, Dialog
  • AuthResponse, ErrorDetail, APIErrorResponse
  • City, Country, TimeZone, Feature, Badge
  • DataResponse

API Groups

  • CatalogAPI — каталог кворков
  • ProjectsAPI — биржа проектов
  • UserAPI — пользовательские данные
  • ReferenceAPI — справочные данные
  • NotificationsAPI — уведомления
  • OtherAPI — дополнительные эндпоинты

Security

  • Two-step authentication (cookies + web_auth_token)
  • Session management
  • Token-based authentication

Documentation

  • Full API reference (MkDocs + mkdocstrings)
  • Usage examples in all docstrings
  • RELEASE.md guide
  • ARCHITECTURE.md

Technical

  • Python 3.10+ support
  • httpx with HTTP/2 support
  • structlog for structured logging
  • Ruff linter configuration
  • Pytest with coverage

[0.0.1] - 2026-03-22

Added

  • Project initialization
  • Basic project structure
  • First API endpoints implementation