scalio-platform

Shared building blocks of the Scalio apps (Nexus, Compass, Citadel, Foundry, Rosetta, Pulse, Beacon, Cockpit, ID, Monitor). Before this package each app kept its own copy of these files (architecture review C2/C4, ADR 0058 in scalio-docs). Nothing in this package is secret.

Use in an app

scalio-platform==0.1.0            # backend/requirements.txt, exact version

from scalio_platform import error_report, health, job_lease
from scalio_platform.migrations import BASELINE, run_migrations

MIGRATIONS = BASELINE                      # append (2, migrate_002_...) and so on, never edit past steps

async def startup():
    await run_migrations(db, MIGRATIONS)   # before the background loops
    for name, loop in LOOPS.items():
        asyncio.create_task(job_lease.run_exclusive(db, name, loop))

error_report.install(app, "citadel", build_info)
code, body = await health.health_report(db, build_info(), lease_jobs=sorted(LOOPS))

A migration step must be safe to run twice: two instances can start at the same moment.

Develop and release

• pip install -e ".[dev]", then pytest -q and ruff check . (both run in CI).
• Release: bump pyproject.toml and __version__, run python3 tools/changelog.py release <version> (moves changelog.d/ into CHANGELOG.md), merge, then «Freigeben» in the Scalio Cockpit (workflow publish.yml: PyPI with trusted publishing, tag and GitHub release). Tags without v.
• A change of behaviour changes every app on its next upgrade: say so in the PR and the CHANGELOG.