Skip to content

4.3.6 — 2026-03-13

← 4.4.0 | 4.3.5 → | ↑ 4.x series

Added

Helpers - Chore

  • Documentation Cursor Rule - Added a dedicated Cursor rule for documentation standards under docs/**/*.md.
    • Enforces Google-style docstrings, snake_case filenames, required page structure, and code example conventions across all documentation files

Fixed

Chore - CI

  • Docs Deploy Trigger on Source Changes - Extended the deploy-docs.yml workflow to also trigger on changes to archipy/** source files, not only docs/**.
    • Ensures the published documentation is rebuilt whenever adapter or helper code changes
  • ReadTheDocs Build Configuration - Repaired the .readthedocs.yaml configuration to restore a functional ReadTheDocs build.
    • Simplified configuration to match current ReadTheDocs requirements and removed stale options

Changed

Adapters - SQLAlchemy

  • Filter Value Type Union Expansion - Broadened the value parameter type union in SQLAlchemyFilterMixin._apply_filter and _validate_list_operation.
    • Added int, Decimal, datetime, date, and Enum to the accepted type union alongside the existing str | float | bool | list | UUID | None
    • Allows filtering on numeric, temporal, and enum-typed columns without requiring a cast at the call site

Chore

Docs - Documentation Overhaul

  • API Reference Restructure - Split the monolithic api_reference.md into per-module subdirectories (adapters/, helpers/) with individual pages for each adapter and helper module.
  • Adapter Example Pages - Revamped all adapter example pages with complete runnable snippets and standardised sections (Installation, Configuration, Basic Usage, See Also).
    • Added Elasticsearch example guide and expanded PostgreSQL and configs examples
    • Consolidated payment gateway documentation into a single page
  • New Example Pages - Added dependency_injection.md and error_handling.md example guides.
  • Getting Started - Overhauled the quickstart guide and complete user example to reflect manage.py integration; updated project structure documentation with enhanced run command options.
  • Navigation - Restructured and expanded mkdocs.yml navigation; added 404.md and CODE_OF_CONDUCT.md pages.
  • Architecture & Concepts - Updated architecture and concepts documentation; split the large concepts.md into focused topic pages.
  • Installation Guide - Created a dedicated installation guide and streamlined the prerequisites section.
  • Changelog - Added Cursor rules for changelog standards and restructured changelog organisation and navigation.