Ciridae

Public Python clients, models, and project utilities consumed by Ciridae services, standalone projects, and templates.

The domain libraries remain the source owners in libs/auth-client, libs/email, libs/ghost-client, libs/mcp-access, libs/openapi-tools, libs/project-yaml, and libs/temporal-sentry. This directory only assembles their public modules into one distribution. The owner directories are virtual uv projects for scoped tests and tooling; they do not build separate distributions. Internal consumers resolve ciridae from the workspace, whose editable install links directly to those owner files.

public-package-files.txt is the reviewed artifact boundary. It approves the owned namespaces as public; sources outside those namespace patterns fail the build.

The PyPI distribution is ciridae. Import from the relevant domain namespace:

from ciridae.auth import AuthServiceAccessResponse, AuthServiceClient
from ciridae.email import Button, Email, Heading, Text, render_email
from ciridae.ghost import GhostEnvsClient, create_ghost_server
from ciridae.mcp import CiridaeMcpClient, ProjectToolInventoryResponse
from ciridae.project import ProjectDefinition

Install the OpenAPI compiler extra when a service needs to expose FastAPI operations as MCP tools:

pip install "ciridae[openapi-tools]"

from ciridae_openapi_tools import compile_openapi_tools

Temporal workers can install the optional integration and register its Sentry interceptor without adding those runtime dependencies to other consumers:

pip install "ciridae[temporal-sentry]"

from ciridae.temporal.sentry import SentryInterceptor

Validate a project.yaml file with the same packaged contract:

ciridae validate-project project.yaml

Format it with the package's canonical two-space indentation while preserving comments and quoted values:

ciridae format-project project.yaml
ciridae format-project project.yaml --check

Repository proposal generators can use edit_project_definition to mutate the round-trip document; it validates the contract before and after the edit and returns the same canonical format.

Releasing

1. Update version in pyproject.toml.
2. Merge the change to main.
3. Push the matching tag, for example ciridae-python-v0.1.0.

Before 1.0, use a patch bump for backward-compatible changes, including additive APIs and project.yaml contract or bundled-default updates. Use a minor bump for breaking changes. After 1.0, use patch for fixes, minor for backward-compatible additions, and major for breaking changes.

The tag publishes through PyPI Trusted Publishing. Releases are immutable; change the version rather than replacing an existing artifact.