PyCatalyst

Schema-aware data generation and testing: recipes (YAML), REST API, optional UI, schema inference, and ML hooks.

Documentation

Published (GitHub Pages): optophi.github.io/pycatalyst — start with Getting Started → Quick Start.
Local docs (from repo root):
```
pip install "pycatalyst[docs]"
pycatalyst docs serve
```
Opens at http://127.0.0.1:5005 by default. Static site: pycatalyst docs build → site/.
Live API (when the server is running): http://127.0.0.1:8005/docs (Swagger).

Tutorial index in the doc site: Quick Start, API authentication, generate, recipes, infer schema, workbench.

Installation

pip install pycatalyst

API server, DB, and common extras:

pip install "pycatalyst[api,db,inference,faker]"

From source (editable):

git clone https://github.com/optophi/pycatalyst
cd pycatalyst
pip install -e ".[dev]"

Quick Start (CLI)

pycatalyst api --port 8005
pycatalyst generate --recipe path/to/recipe.yaml -n 10

See the Quick Start page in the docs for database setup, UI, and REST examples.

Streaming mock data

Python — same sequence as batch generation for a fixed seed:

from pycatalyst import GenerationEngine, SchemaBuilder

engine = GenerationEngine()
schema = SchemaBuilder("events").add_uuid("id").add_string("kind").build()
for row in engine.iter_records(schema, seed=123, limit=1000):
    process(row)

HTTP (Server-Sent Events) — POST /api/v1/stream/sse with the same field list as /generate, plus max_records and optional interval_ms. Use curl -N and a Bearer token when auth is enabled:

curl -N -H "Authorization: Bearer YOUR_JWT" -H "Content-Type: application/json" \
  -d '{"name":"x","fields":[{"name":"n","type":"int"}],"max_records":5,"seed":1}' \
  http://127.0.0.1:8005/api/v1/stream/sse

CLI — NDJSON to stdout (one JSON object per line):

pycatalyst stream ndjson --schema my.json -n 500 --seed 1

CLI — Kafka (pip install pycatalyst[kafka]):

export PYCATALYST_STREAM_KAFKA_BOOTSTRAP=localhost:9092
export PYCATALYST_STREAM_KAFKA_TOPIC=test-topic
pycatalyst stream kafka --schema my.json -n 2000 --batch 100

Server caps (optional): PYCATALYST_STREAM_MAX_RECORDS, PYCATALYST_STREAM_MAX_INTERVAL_MS.

Development

Lint & format: ruff check . && ruff format .
Type check: mypy src/
Tests: pytest
Coverage: pytest --cov=pycatalyst --cov-report=term-missing

Publishing

Bump version in pyproject.toml and CHANGELOG.md.
Create a release tag: git tag v0.1.0 && git push origin v0.1.0.
The GitHub Action uses PyPI Trusted Publishing; configure the publisher on PyPI for this repo, then the workflow will publish on tag push.

License

MIT

Download files

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

Source Distribution

pycatalyst-0.0.17.tar.gz (2.6 MB view details)

Uploaded Aug 29, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pycatalyst-0.0.17-py3-none-any.whl (2.4 MB view details)

Uploaded Aug 29, 2026 Python 3

File details

Details for the file pycatalyst-0.0.17.tar.gz.

File metadata

Download URL: pycatalyst-0.0.17.tar.gz
Upload date: Aug 29, 2026
Size: 2.6 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pycatalyst-0.0.17.tar.gz
Algorithm	Hash digest
SHA256	`90844fd7383699013df53c4b516c00aee30ef3a06f8fd85b63514291e83ffc01`
MD5	`03f2acede767e906ff252d385e64058e`
BLAKE2b-256	`480da93b89e0a92a5c8a0dd411fa5d47041cbfe62cda11f71d3372ef034c860f`

See more details on using hashes here.

Provenance

The following attestation bundles were made for pycatalyst-0.0.17.tar.gz:

Publisher: publish.yml on optophi/pycatalyst

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: pycatalyst-0.0.17.tar.gz
- Subject digest: 90844fd7383699013df53c4b516c00aee30ef3a06f8fd85b63514291e83ffc01
- Sigstore transparency entry: 2638252855
- Sigstore integration time: Aug 29, 2026
Source repository:
- Permalink: optophi/pycatalyst@09f78e1d22a4ae179fff4dfe5990594cb97a28bc
- Branch / Tag: refs/tags/v0.0.17
- Owner: https://github.com/optophi
- Access: private
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@09f78e1d22a4ae179fff4dfe5990594cb97a28bc
- Trigger Event: push