Skip to main content

Shared Python toolkit for OuEstCharlie agents

Project description

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

From PyPI (recommended)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ouestcharlie_py_toolkit-0.8.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ouestcharlie_py_toolkit-0.8.0-py3-none-any.whl (45.2 kB view details)

Uploaded Python 3

File details

Details for the file ouestcharlie_py_toolkit-0.8.0.tar.gz.

File metadata

  • Download URL: ouestcharlie_py_toolkit-0.8.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ouestcharlie_py_toolkit-0.8.0.tar.gz
Algorithm Hash digest
SHA256 1386a3ab346722834de3f0fbd258e2d53011573f5dcaafa3ca5f4e3e2f132bfd
MD5 19727e20b66284d88fd2111c6d843a7f
BLAKE2b-256 06f9d134b3602e3b24349e41b3b0bd99c1067da718f95d27259f312d4ada55e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for ouestcharlie_py_toolkit-0.8.0.tar.gz:

Publisher: publish.yml on ouestcharlie/ouestcharlie-py-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ouestcharlie_py_toolkit-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ouestcharlie_py_toolkit-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17c4e3a73ced96af3db1854b70f93b629b7164065cfc73cf2b9e293389f71203
MD5 b5343d17a60131d32922d8e430d891e1
BLAKE2b-256 7618b5675df8668ca5ed68b3ee955ca44c42b138bb70c761b578ea30a14f39bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for ouestcharlie_py_toolkit-0.8.0-py3-none-any.whl:

Publisher: publish.yml on ouestcharlie/ouestcharlie-py-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page