Skip to main content

OuEstCharlie Python Toolkit

Shared Python library for building OuEstCharlie photo management agents.

Overview

This toolkit provides four core capabilities:

  1. MCP integration — MCP server lifecycle, tool registration, progress reporting, and logging
  2. Manifest read-edit with consistency — hierarchical manifest traversal, atomic read-modify-write with optimistic concurrency
  3. XMP read-edit with consistency — sidecar read-modify-write with optimistic concurrency and field-level semantics
  4. Image processing — thumbnail AVIF grid assembly and on-demand JPEG preview generation, delegated to ouestcharlie-imageproc

Package Structure

ouestcharlie-toolkit/
├── pyproject.toml
└── src/
    └── ouestcharlie_toolkit/
        ├── schema.py             # Data models, exceptions, constants
        ├── backend.py            # Backend protocol
        ├── backends/
        │   └── local.py          # Local filesystem backend
        ├── manifest.py           # ManifestStore for manifest operations
        ├── xmp.py                # XmpStore for XMP sidecar operations
        ├── thumbnail_builder.py  # Thumbnail generation (delegates to ouestcharlie-imageproc)
        ├── preview_builder.py    # On-demand JPEG preview (delegates to ouestcharlie-imageproc)
        ├── progress.py           # ProgressReporter for MCP progress
        └── server.py             # AgentBase for MCP server lifecycle

Installation

pip install ouestcharlie-toolkit

ouestcharlie-imageproc (the Rust binary) is a separate package pulled in automatically. No Rust toolchain required at install time.

System prerequisites:

  • macOS: brew install inih brotli gettext (required by pyexiv2 at runtime)
  • Linux/Windows: no extra steps

From source (development)

# For macOs on arm64 architecture, the full Python version is required e.g.: cpython-3.14.5-macos-aarch64-none
#  the version string is listed by `uv python list`
uv venv --python 3.13 
uv sync

uv sync uses the [tool.uv.sources] override to install ouestcharlie-imageproc from the adjacent ../outestcharlie-imageproc checkout as an editable install (which compiles the Rust binary). Make sure that repo is checked out alongside this one.

Running Tests

Always use .venv/bin/python -m pytest — do not use .venv/bin/pytest or a system python:

# Unit tests
.venv/bin/python -m pytest tests/ -v

# Run a specific file
.venv/bin/python -m pytest tests/test_photo.py -v --tb=short

Integration tests (real image-proc binary) are in ouestcharlie-imageproc/tests_integration/.

Building a Wheel

The toolkit is pure Python — no Rust compilation required:

pip install hatch
hatch build
# produces dist/ouestcharlie_toolkit-*.whl (pure Python, any platform)

Dependencies

  • mcp — Official MCP Python SDK
  • pyexiv2 — EXIF extraction from image files (wraps Exiv2); requires brew install inih on macOS
  • blake3 — Fast content hashing
  • ouestcharlie-imageproc — Rust coprocessor for image decode, resize, AVIF assembly, JPEG preview

XMP parsing and serialization use stdlib only and have no native dependencies.

Usage

Creating an Agent

from ouestcharlie_toolkit import AgentBase

class HousekeepingAgent(AgentBase):
    def __init__(self):
        super().__init__(name="ouestcharlie-housekeeping", version="1.0.0")

        @self.mcp.tool()
        async def rebuild_partition(backend: str, partition: str, mode: str = "lazy"):
            """Rebuild partition manifest and thumbnails."""
            photos = await self.backend.list_files(partition, suffix=".jpg")
            progress = self.progress(total=len(photos))

            for photo in photos:
                await self.check_cancelled()
                await progress.advance(message=f"Processing {photo.path}")

            return {"photosProcessed": len(photos), "errors": 0}

if __name__ == "__main__":
    agent = HousekeepingAgent()
    agent.run()  # Runs on stdio transport

Working with XMP Sidecars

from ouestcharlie_toolkit import XmpStore

async def add_face_tags(store: XmpStore, photo_path: str, faces: list[str]):
    def modify(xmp):
        for face in faces:
            tag = f"ouestcharlie:faces/{face}"
            if tag not in xmp.tags:
                xmp.tags.append(tag)
        return xmp

    await store.read_modify_write(photo_path, modify)

Backend Configuration

export WOOF_BACKEND_CONFIG='{"type": "filesystem", "root": "/Users/alice/Photos"}'

Architecture

See py_toolkit_LLD.md for the design and agent_LLD_rationale.md for technology selection rationale.

Key design principles:

  • Optimistic concurrency — All manifest and XMP writes use version tokens to detect conflicts
  • Unknown field preservation — Schema evolution via _extra dict in dataclasses
  • Async throughout — All I/O operations are async
  • Backend abstraction — Swappable storage backends (local, S3, GCS, etc.)
  • MCP-native — Built on FastMCP for clean agent implementation

References

License

MIT license

Release files for ouestcharlie-py-toolkit 0.15.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ouestcharlie-py-toolkit 0.15.0
File Size Uploaded
ouestcharlie_py_toolkit-0.15.0.tar.gz 1.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for ouestcharlie-py-toolkit 0.15.0
File Interpreter ABI Platform
ouestcharlie_py_toolkit-0.15.0-py3-none-any.whl Python 3 none any Details

Total release size: 1.3 MB

Release files / ouestcharlie_py_toolkit-0.15.0.tar.gz

Download URL ouestcharlie_py_toolkit-0.15.0.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
8b71a77a2185b89dbdad1064beab5cedd6f7f541f282aeb36f016eaa84e7ea3c
BLAKE2b-256 checksum
How to use checksums
49ae902a09d55eddd5fb8512f3bba7c8bca19c99d248f0e223214f711cc27b22
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release files / ouestcharlie_py_toolkit-0.15.0-py3-none-any.whl

Download URL ouestcharlie_py_toolkit-0.15.0-py3-none-any.whl
Size 64.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3700c646ccb1eab2c869b07937f86fbdc4d0b42ace91984705dff05336b36788
BLAKE2b-256 checksum
How to use checksums
8d72ea81747648a0cf104c7721ad47b8c672ee081ab129976e4a0e2ed098d3c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.15.0 This release

2 release files

0.14.1

2 release files

0.14.0

2 release files

0.13.0

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

5 release files

0.6.0

5 release files

0.5.0

5 release files

0.4.0

5 release files

0.3.0

5 release files

0.2.1

5 release files

0.2.0

5 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page