Skip to content

openframe-core

The foundation package of the OpenFrame Microservice Development Suite — ports, tracing, telemetry, exceptions, config, and ASGI middleware for any hexagonal architecture Python service.

Developer Guide

Section Contents
Quick Start Working integration in 5 minutes
How It Works Hexagonal architecture in plain language
First Code Change Smallest meaningful change to the package
Debugging Guide AdapterError traces, OTel spans, common failures

Technical Documentation

Section Contents
System Overview What the package does, seven-module model, key design properties
Architecture Module design, dependency order, data flows, design decisions
Package Journey How a request moves from template wiring through adapter to response
ADRs Five architectural decision records from the design and review process
Infrastructure Modal platform, devpi registry, GitHub Actions
Deployment Environments, secrets, CI/CD pipeline
Operations Monitoring, runbooks for six failure scenarios

Code Documentation

Section Contents
Getting Started Install, configure, smoke test
Modules Function and class reference for all seven core modules
CI/CD GitHub Actions workflows