OuEstCharlie Python Toolkit
Shared Python library for building OuEstCharlie photo management agents.
Overview
This toolkit provides four core capabilities:
- MCP integration — MCP server lifecycle, tool registration, progress reporting, and logging
- Manifest read-edit with consistency — hierarchical manifest traversal, atomic read-modify-write with optimistic concurrency
- XMP read-edit with consistency — sidecar read-modify-write with optimistic concurrency and field-level semantics
- 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 SDKpyexiv2— EXIF extraction from image files (wraps Exiv2); requiresbrew install inihon macOSblake3— Fast content hashingouestcharlie-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
_extradict 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.14.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ouestcharlie_py_toolkit-0.14.1.tar.gz | 1.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ouestcharlie_py_toolkit-0.14.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.3 MB
Release files / ouestcharlie_py_toolkit-0.14.1.tar.gz
| Download URL | ouestcharlie_py_toolkit-0.14.1.tar.gz |
|---|---|
| Size | 1.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
95930aa906fd0359948e278b04778bbc3edd5127914b23fef239de8001db687d
|
|
BLAKE2b-256 checksum How to use checksums |
66ba3637a88aa1555f5caadaca1c57d8d87a384e7a4de0e37807a8abc60949c4
|
| 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 Aug 30, 2026.
Transparency logRelease files / ouestcharlie_py_toolkit-0.14.1-py3-none-any.whl
| Download URL | ouestcharlie_py_toolkit-0.14.1-py3-none-any.whl |
|---|---|
| Size | 64.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fce55e3f3a0aa990051208a17356403c5feefbc3d02f36ac18c7add6a22dd910
|
|
BLAKE2b-256 checksum How to use checksums |
fdd01634fee49530a0c4b731cb3bc59b5cbe5896bfd21f69d8f9224a7cbd51f6
|
| 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 Aug 30, 2026.
Transparency log