CHANGELOG¶

v10.0.0 (2026-07-31)¶

Chores¶

• Drop Python 3.10 support (ae9c7eb)

Breaking Changes¶

• The minimum supported Python version is now 3.11.

v9.2.0 (2026-07-26)¶

Features¶

• auth: Add configurable auth retry options (#312, 5c3296d)

v9.1.2 (2026-07-12)¶

Bug Fixes¶

• semantic_release: Update changelog exclusion patterns (#288, fbe32d2)

v9.1.1 (2026-07-09)¶

Bug Fixes¶

• logging: Improve error logging details on session closure (#280, 39812ba)

v9.1.0 (2026-06-16)¶

Bug Fixes¶

• uv: Update aioresponses source to specific revision (#234, 4a5e11d)

Features¶

• event: Add private attributes for sub-models (#234, 4a5e11d)

v9.0.2 (2026-05-30)¶

Bug Fixes¶

• models: Handle None in allowed_types check (#212, d19069b)

v9.0.1 (2026-05-19)¶

Bug Fixes¶

• makefile: Simplify requirements-check command (#175, 9a97ef0)

v9.0.0 (2026-05-18)¶

Features¶

• Switch to URL-based Events API configuration (#167, 93c7e80)

• pre-commit: Add docstrfmt for formatting RST files (#167, 93c7e80)

v8.1.3 (2026-05-14)¶

Bug Fixes¶

• ci: Simplify build metadata handling (#164, d90974e)

v8.1.2 (2026-05-13)¶

Bug Fixes¶

• ci: Change permissions for release job and persist bot credentials (#163, f04bb2b)

v8.1.1 (2026-05-12)¶

Bug Fixes¶

• deps: Add requirements.txt for pip-audit scanning (#161, bd07145)

• deps: Widen supported dependency versions (#161, bd07145)

• pre-commit: Update requirements-sync entry to use bash (#161, bd07145)

• renovate: Update runtime scope and disable automerge for vulnerability alerts (#161, bd07145)

v8.1.0 (2026-05-10)¶

Features¶

• pyproject: Remove refactor pattern from commit exclusions (#160, bad9d6d)

v8.0.10 (2026-05-10)¶

Bug Fixes¶

• Update permissions and author for release process (#159, 8556b42)

• ci: Update permissions and author for release process (#159, 8556b42)

v8.0.9 (2026-05-08)¶

Bug Fixes¶

• client: Enforce HTTPS scheme for nextUrl validation (#154, a2463b9)

v8.0.8 (2026-05-05)¶

Bug Fixes¶

• Add pip to constraint-dependencies (#151, 75fa17c)

v8.0.7 (2026-04-27)¶

Bug Fixes¶

• deps: Add GitPython constraint (#141, 28ee76c)

• runtime: Update dependency pydantic to >=2.13.3 (#141, 28ee76c)

v8.0.6 (2026-04-25)¶

Bug Fixes¶

• runtime: Update dependency pydantic to >=2.13.2 (#139, 10d5fdb)

v8.0.5 (2026-04-24)¶

Bug Fixes¶

• runtime: Update dependency pydantic to >=2.13.1 (#129, 174d46b)

v8.0.4 (2026-04-21)¶

Bug Fixes¶

• runtime: Update dependency stamina to v26 (1734acc)

v8.0.3 (2026-04-21)¶

Bug Fixes¶

• runtime: Update dependency pydantic to >=2.13.0 (9a48ce8)

v8.0.2 (2026-04-20)¶

Bug Fixes¶

• semantic_release: Update commit patterns for changelog (5b0c8e1)

v8.0.1 (2026-04-18)¶

Bug Fixes¶

• models: Improve handling of empty string subgender (#115, f1f0ece)

v8.0.0 (2026-04-18)¶

Refactoring¶

• Removed option to extend additional URLs (#114, a9534fb)

Breaking Changes¶

• next_url_allowed_hosts has been removed and hosts are now limited to only the main API and testbed endpoints

v7.1.2 (2026-04-13)¶

Bug Fixes¶

• security: Update dependency pytest to v9.0.3 [security] (#104, 0fc4480)

v7.1.1 (2026-04-13)¶

Bug Fixes¶

• Update admonitions pattern (#102, 51eac6c)

• pyproject: Update admonitions pattern (#102, 51eac6c)

v7.1.0 (2026-04-11)¶

Features¶

• Convert next_url_allowed_hosts to tuple and reorganize constants (#100, 57ea719)

v7.0.1 (2026-04-09)¶

Bug Fixes¶

• Handle status_code check for None (#93, b02019e)

• exceptions: Handle status_code check for None (#93, b02019e)

v7.0.0 (2026-04-08)¶

Refactoring¶

• config: Change strict_validation default to false (#92, eb3ab1c)

v6.3.1 (2026-04-01)¶

Bug Fixes¶

• deps: Update aiohttp to v3.13.5 and adjust settings (#78, 425d141)

v6.3.0 (2026-03-30)¶

Features¶

• Expand support to cover Python 3.10+ (#71, ddaace2)

• Update supported Python versions (#71, ddaace2)

v6.2.0 (2026-03-26)¶

Bug Fixes¶

• docs: Update error handling example for async usage (#68, adb2241)

Features¶

• docs: Add additional doc pages for config and installation (#68, adb2241)

v6.1.4 (2026-03-22)¶

Bug Fixes¶

• ci: Add GPG signing to publish steps in CI/CD (#64, 056ec1c)

v6.1.3 (2026-03-21)¶

Bug Fixes¶

• ci: Update GitHub Actions to use GH_PAT for token (#63, 599dece)

• client: Improve error handling and logging in EventClient (#62, 79f9248)

v6.1.2 (2026-03-20)¶

Bug Fixes¶

• semantic-release: Update commit author for GitHub Actions (6a93c8a)

v6.1.1 (2026-03-20)¶

Bug Fixes¶

• semantic-release: Add commit author for GitHub Actions (717c94c)

v6.1.0 (2026-03-20)¶

Features¶

• pre-commit: Add gitleaks secret scan hook (#61, 10d5651)

• pre-commit: Add redact argument to gitleaks hook (#61, 10d5651)

v6.0.0 (2026-03-15)¶

Chores¶

• dependencies: Replace tenacity with stamina for retry logic (#56, 7f260c1)

Features¶

• dependencies: Replace tenacity with stamina for retry logic (#56, 7f260c1)

v5.9.1 (2026-02-19)¶

Bug Fixes¶

• deps: Update dependency tenacity to v9.1.4 (#52, 1296a3b)

v5.9.0 (2026-01-14)¶

Bug Fixes¶

• models: Change extra field behavior to ignore unknown fields (7216b19)

Features¶

• client: Recreate retry logic with tenacity (34437e3)

v5.8.2 (2026-01-07)¶

Bug Fixes¶

• python-runtime: Update dependency aiohttp to v3.13.3 (#49, 17ce240)

v5.8.1 (2025-12-26)¶

Bug Fixes¶

• docs: Update html_theme_options type to include bool (9c9a3a8)

v5.8.0 (2025-12-13)¶

Features¶

• client: Add response snippet and host entry sanitization (a18825b)

v5.7.0 (2025-12-09)¶

Features¶

• client: Enhance nextUrl validation and add jitter to retry delay (122e289)

v5.6.5 (2025-12-03)¶

Bug Fixes¶

• router: Handle asyncio.CancelledError separately (8fb30bd)

v5.6.4 (2025-11-30)¶

Bug Fixes¶

• runtime: Update dependency pydantic to v2.12.5 (#35, fec4603)

v5.6.3 (2025-11-29)¶

Bug Fixes¶

• client: Prevent redirects in session requests (80f7305)

v5.6.2 (2025-11-22)¶

Bug Fixes¶

• deps: Add examples group for python-dotenv and rich (07a4bfe)

• Dockerfile: Update Python base image to 3.14 (f36f456)

• Dockerfile: Update uv dependency to version 0.9.11 (14cfa07)

v5.6.1 (2025-11-16)¶

Bug Fixes¶

• tests: Update coverage options to include src and omit tests (d370837)

v5.6.0 (2025-11-15)¶

Features¶

• config: Add next_url_allowed_hosts to ClientConfig (acf3f4c)

v5.5.1 (2025-11-15)¶

Bug Fixes¶

• test: Disable coverage for end-to-end tests (d760ef6)

v5.5.0 (2025-11-13)¶

Features¶

• models: Improve media purchase event handling (dc5b44b)

v5.4.0 (2025-11-12)¶

Features¶

• tests: Add live testbed polling test with env credentials (e66a7ba)

v5.3.0 (2025-11-10)¶

Features¶

• ci: Add grouping for GitHub Actions workflows (37646d6)

v5.2.2 (2025-11-10)¶

Bug Fixes¶

• renovate: Update package name matching patterns (a4735c5)

v5.2.1 (2025-11-09)¶

Bug Fixes¶

• deps: Update dependency pydantic to v2.12.4 (64c7750)

v5.2.0 (2025-11-08)¶

Bug Fixes¶

• config: Enforce minimum value for retry_attempts (4711e7f)

Features¶

• client: Add validation for nextUrl in API responses (1b7e9cb)

v5.1.1 (2025-11-06)¶

Bug Fixes¶

• client: Handle event ID extraction for non-mapping items (96f3945)

v5.1.0 (2025-11-05)¶

Bug Fixes¶

• auth: Improve error messages for username and token validation (a6ea8e7)

Features¶

• router: Enhance async handler registration and error handling (35dbe52)

v5.0.0 (2025-11-05)¶

Refactoring¶

• docs: Update README and example to use ClientConfig and Router (f9b59d3)

v4.10.1 (2025-11-04)¶

Bug Fixes¶

• router: Improve handler registration and error logging in event dispatching (e42fa37)

• router: Log exceptions with handler names during event dispatching (9e37659)

v4.10.0 (2025-11-03)¶

Bug Fixes¶

• README: Update event streaming method in examples and improve retry attempts description (028d287)

Features¶

• Add utility functions for masking secrets and formatting validation errors (4e7d88e)

• Implement event batch processing utilities with validation (de985e1)

v4.9.2 (2025-11-02)¶

Bug Fixes¶

• docs: Add new template for Python type documentation (1d34bd5)

v4.9.1 (2025-11-02)¶

Bug Fixes¶

• deps: Update dependency aiohttp to v3.13.2 (b88e635)

v4.9.0 (2025-11-02)¶

Bug Fixes¶

• init: Handle PackageNotFoundError when retrieving package version (b247e14)

Features¶

• tests: Reorganize suites with typed fixtures (1ab68fd)

v4.8.0 (2025-11-01)¶

Bug Fixes¶

• client: Improve error handling for API requests (9799bc6)

Features¶

• models: Implement caching for event data retrieval (1e9ccaa)

v4.7.1 (2025-10-31)¶

Bug Fixes¶

• docs: Clarify behavior of event properties and update version import (35df062)

• models: Enhance error handling for data validation (d24bd84)

v4.7.0 (2025-10-31)¶

Features¶

• validation: Introduce strict validation for event data and update error handling (ef2fe99)

v4.6.1 (2025-10-30)¶

Bug Fixes¶

• constants: Correct initialization of CLOUDFLARE_ERROR_CODES set (3120e80)

• event: Handle ValidationError when retrieving user, tip, message, and room subject data (27a1c9d)

• router: Correct type hint for _handlers in EventRouter initialization (0e6dcc5)

v4.6.0 (2025-10-30)¶

Bug Fixes¶

• docs: Exclude autoapi templates from doc8 rst check (f1b423e)

Features¶

• docs: Add autoapi template for class documentation and update Sphinx configuration (21422fb)

v4.5.2 (2025-10-28)¶

Bug Fixes¶

• client: Ensure polling lock is initialized and handle uninitialized state (7216340)

• coverage: Remove omitted files from coverage report (646e481)

v4.5.1 (2025-10-28)¶

Bug Fixes¶

• pyproject: Update documentation URL to point to Read the Docs (8d2a5bc)

v4.5.0 (2025-10-28)¶

Features¶

• pyproject: Add fancy-pypi-readme metadata hooks for README processing (50da09d)

v4.4.3 (2025-10-28)¶

Bug Fixes¶

• Dockerfile: Update uv package version to 0.9.5 (b9bb24d)

v4.4.2 (2025-10-27)¶

Bug Fixes¶

• client: Add thread safety with asyncio lock for polling method (212b8d1)

• config: Update validation method for retry delays in EventClientConfig (e9bbe8d)

v4.4.1 (2025-10-26)¶

Bug Fixes¶

• docs: Update links and titles for consistency (623fb25)

v4.4.0 (2025-10-26)¶

Bug Fixes¶

• docs: Update description in README and pyproject.toml for consistency (03fc31d)

Features¶

• docs: Add html_extra_path to include LICENSE and pyproject.toml in build output (8da1ac6)

v4.3.0 (2025-10-26)¶

Bug Fixes¶

• client: Raise EventsError on session initialization failure (449e1e8)

Features¶

• exceptions: Add detailed repr methods for EventsError and RouterError (3852ccd)

v4.2.1 (2025-10-26)¶

Bug Fixes¶

• router: Log exceptions in event handlers to improve error tracking (8c1aa7a)

v4.2.0 (2025-10-26)¶

Features¶

• client: Remove global rate limiter and use instance-based limiter (b20b42c)

v4.1.1 (2025-10-22)¶

Bug Fixes¶

• deps: Update runtime (38d51aa)

v4.1.0 (2025-10-21)¶

Bug Fixes¶

• client: Mask authentication token in logs and adjust session timeout (108b033)

• exceptions: Remove redundant message attribute documentation from exception classes (3a99235)

Features¶

• constants: Add SESSION_TIMEOUT_BUFFER (e124271)

v4.0.4 (2025-10-21)¶

Bug Fixes¶

• Enhance error messages for empty and whitespace credentials in EventClient (2a3544b)

• Update all declaration to use type hinting (3814db5)

v4.0.3 (2025-10-20)¶

Bug Fixes¶

• Change ValueError to AuthError for empty username and token in EventClient (d159944)

• docs: Improve error handling for authentication in README and index (527846c)

v4.0.2 (2025-10-20)¶

Bug Fixes¶

• docs: Update linked files in README and index (41e111c)

v4.0.1 (2025-10-18)¶

Bug Fixes¶

• deps: Update dependency pydantic to v2.12.2 (a9c1ad3)

v4.0.0 (2025-10-18)¶

Refactoring¶

• python-version: Update minimum python version to 3.12 (45a344e)

v3.1.2 (2025-10-17)¶

Bug Fixes¶

• client: Improve error handling in _parse_response_data method to raise JSONDecodeError on invalid JSON (1679a78)

• router: Enhance dispatch method error handling with context for RouterError (e74e5c5)

v3.1.1 (2025-10-17)¶

Bug Fixes¶

• models: Ensure user, tip, and message data checks are explicit for None (81830c9)

• router: Simplify exception handling in dispatch method documentation (47a302f)

v3.1.0 (2025-10-14)¶

Features¶

• Add Codecov test results action to CI workflow (915386d)

v3.0.5 (2025-10-14)¶

Bug Fixes¶

• deps: Update dependency pydantic to v2.12.0 (#24, f8e50e7)

v3.0.4 (2025-10-13)¶

Bug Fixes¶

• deps: Update dependency aiohttp to v3.13.0 (e035676)

v3.0.3 (2025-10-12)¶

Bug Fixes¶

• deps: Update dependency pydantic to v2.11.10 (e436274)

v3.0.2 (2025-10-11)¶

Bug Fixes¶

• client: Improve JSON parsing error handling in EventClient (2f4572e)

v3.0.1 (2025-10-10)¶

Bug Fixes¶

• docs: Corrected event handling examples and descriptions (82c148f)

v3.0.0 (2025-10-09)¶

Bug Fixes¶

• config: Add validation for retry max delay against retry backoff (58bd2b2)

Refactoring¶

• router: Unify handler registry and improve event dispatching logic (64386cf)

v2.5.0 (2025-10-08)¶

Features¶

• Add error handling modes and RouterError for event dispatching (e1999cc)

v2.4.3 (2025-10-07)¶

Bug Fixes¶

• docs: Suppress duplicate object warnings in AutoAPI configuration (65c5978)

v2.4.2 (2025-10-07)¶

Bug Fixes¶

• docs: Update build command to allow AutoAPI duplicate warnings (caf9c15)

v2.4.1 (2025-10-07)¶

Bug Fixes¶

• client: Improve resource cleanup in close method with locking mechanism (ff71761)

• pylint: Increase max attributes limit from 10 to 12 (f26817e)

v2.4.0 (2025-10-05)¶

Features¶

• ci-cd: Add attestations permissions and step for build provenance (e3a58c0)

v2.3.7 (2025-10-04)¶

Bug Fixes¶

• docs: Update license links to use absolute URLs (d1da265)

v2.3.6 (2025-10-03)¶

Bug Fixes¶

• Update project URLs to reflect the correct repository name (d45d2e9)

v2.3.5 (2025-10-03)¶

Bug Fixes¶

• ci/cd: Update SARIF upload action to a newer version (5fd1e0a)

v2.3.4 (2025-10-03)¶

Bug Fixes¶

• ci/cd: Remove unnecessary setup and conditions (c5df60b)

• ci/cd: Update SARIF upload action and improve artifact handling (7706b3b)

v2.3.3 (2025-10-03)¶

Bug Fixes¶

• ci/cd: Remove environment variables for package and wheel names in deployment steps (f95180d)

v2.3.2 (2025-10-03)¶

Bug Fixes¶

• ci/cd: Use environment variables for package and wheel names in install and deploy steps (ab2a7b4)

v2.3.1 (2025-10-03)¶

Bug Fixes¶

• ci/cd: Add read permission for actions in security scan job (07b5cd0)

v2.3.0 (2025-10-03)¶

Bug Fixes¶

• ci/cd: Consolidate permissions for security events and contents in CI/CD workflow (96e5f4e)

• ci/cd: Update permissions and enhance security scanning steps in CI/CD workflow (000ad71)

• ci/cd: Update permissions to allow write access for contents and security events (3f88370)

Features¶

• security: Add Trivy vulnerability scanning to CI/CD pipeline and Makefile (d36299d)

• security: Integrate Bandit for security scanning and upload SARIF results (0d9a319)

v2.2.0 (2025-10-02)¶

Features¶

• security: Add bandit for security scanning (67ac009)

v2.1.0 (2025-10-02)¶

Features¶

• deps: Add pylint-pydantic for enhanced linting support (93daedb)

v2.0.0 (2025-10-02)¶

Refactoring¶

• client: Improve error handling in EventClient response processing (ee104ab)

v1.13.0 (2025-09-29)¶

Features¶

• router: Add logging for event dispatching (47754e9)

v1.12.0 (2025-09-29)¶

Features¶

• models: Add is_private property to determine message type (ae04d36)

v1.11.1 (2025-09-28)¶

Bug Fixes¶

• Update references from 'chaturbate-events' to 'cb-events' (bdcb541)

• semantic-release: Add patterns for docs and initial commit to exclude commit patterns (859dd31)

v1.11.0 (2025-09-27)¶

Bug Fixes¶

• Dockerfile: Add '-u' flag to python entrypoint for unbuffered output (8984894)

Features¶

• config: Add example environment file for Chaturbate API credentials (c607eda)

v1.10.0 (2025-09-26)¶

Features¶

• Add Cloudflare error handling and retry tests in EventClient (4025f06)

• Introduce EventClientConfig for improved configuration management (d72090f)

• Refactor EventClient initialization to use EventClientConfig for improved configuration management (6047035)

v1.9.0 (2025-09-24)¶

Bug Fixes¶

• Update uv dependency to version 0.8.22 in Dockerfile (b7356c0)

Features¶

• Add Dockerfile and .dockerignore for containerization (60b691b)

• Add python-version configuration for pyrefly tool (6abab23)

v1.8.0 (2025-09-22)¶

Features¶

• Enhance EventClient with configurable retry logic for network errors (bcd4b38)

v1.7.0 (2025-09-20)¶

Bug Fixes¶

• Update CI/CD workflow and Makefile to use 'make test-e2e' for end-to-end tests (f5e3379)

Features¶

• Refactor EventClient and introduce constants for improved configuration and error handling (0c6576d)

v1.6.1 (2025-09-20)¶

Bug Fixes¶

• deps: Update dependency pydantic to v2.11.9 (#13, 87459bd)

v1.6.0 (2025-09-16)¶

Bug Fixes¶

• Reorganize imports for consistency across test files (f0fd75c)

• docs: Update deployment environment name to match GitHub Pages convention (c3709c6)

Features¶

• docs: Added sphinx auto-doc pipeline (da2ddf4)

v1.5.0 (2025-09-13)¶

Features¶

• pyproject: Update project metadata with additional keywords and URLs (daa2dbb)

v1.4.1 (2025-09-13)¶

Bug Fixes¶

• pyproject: Add additional classifiers for improved package metadata (2cebae1)

v1.4.0 (2025-09-13)¶

Features¶

• pyproject: Add classifiers and project URLs for better package metadata (fed8e20)

v1.3.2 (2025-09-11)¶

Bug Fixes¶

• renovate: Update minimum release age from 14 days to 7 days (7923a7d)

v1.3.1 (2025-09-09)¶

Bug Fixes¶

• client: Correct syntax for aiohttp.ClientSession and logging error message (62b92d7)

• example: Add type hints to event handler functions (0429c45)

v1.3.0 (2025-09-09)¶

Features¶

• vscode: Add extensions.json for recommended VS Code extensions (80ae65c)

v1.2.0 (2025-09-07)¶

Bug Fixes¶

• example: Add credential validation in main function (a387849)

Features¶

• client: Enhance error logging and handling for authentication and JSON response (4725aab)

v1.1.4 (2025-09-04)¶

Bug Fixes¶

• lint: Add new ignore patterns for examples and tests (0efaa4f)

v1.1.3 (2025-09-04)¶

Bug Fixes¶

• ci: Ensure 'build' job is a dependency for 'deploy to PyPI' (0aa98c5)

v1.1.2 (2025-09-04)¶

Bug Fixes¶

• ci: Enhance CI/CD workflow structure and naming conventions (177c65b)

v1.1.1 (2025-09-04)¶

Bug Fixes¶

• ci: Update artifact download path for PyPI publishing (330c1ba)

v1.1.0 (2025-09-04)¶

Features¶

• client: Enhance logging and token masking in EventClient (ba225ed)

v1.0.3 (2025-08-27)¶

Bug Fixes¶

• renovate: Format schedule and managerFilePatterns for consistency (33568cd)

v1.0.2 (2025-08-27)¶

Bug Fixes¶

• example: Add mypy override to ignore errors in example module (c74cc44)

v1.0.1 (2025-08-27)¶

Bug Fixes¶

• example: Replace logging with print statements and add PEP 723 inline deps (ab90396)

v1.0.0 (2025-08-26)¶

• Initial Release