Core framework
Install from PyPI as core-framework, import core_framework. MIT — LICENSE. Repository, PyPI.
Install
uv add core-framework
Local development
Use Python 3.14. Install uv and Docker.
docker compose -f docker-compose.dev.yaml up -d
uv sync --locked --all-extras --dev
uv run cf-alembic
make run
Firebase: copy firebase_config.example.json to firebase_config.json at the repo root and replace with your Firebase project’s service account JSON from the console.
For make test, use the Firebase CLI (Auth emulator). Stop DB/Redis: docker compose -f docker-compose.dev.yaml down.
Pre-commit: uv sync --dev installs pre-commit. Enable hooks with uv run pre-commit install (ruff, mdformat, uv-lock, and other checks in .pre-commit-config.yaml).
Hosts
In your host app, load Settings or a Settings subclass from core_framework.core.settings, pass it to init_app from core_framework.main, then wire host-specific dependencies, exception handlers, and routers.
from core_framework.main import init_app
from fastapi import FastAPI
from myapp.settings import HostSettings, load_default_settings
def build_app(settings: HostSettings | None = None) -> FastAPI:
resolved = settings if settings is not None else load_default_settings()
app = init_app(resolved)
from myapp.bootstrap import configure_dependencies
from myapp.exception_handlers import setup_exception_handlers
configure_dependencies(runtime=app.state.core_runtime)
setup_exception_handlers(app)
from myapp.api.router import router
app.include_router(router)
return app
From the host repository root, run uv run cf-alembic. See core-framework-migration.
Host pytest
In your host repository, add the core-framework[testing] extra to dev or test dependencies. In tests/conftest.py, register pytest_core_framework_config (returns TestConfig) and a session-scoped anyio_backend fixture that returns "asyncio".
import pytest
from core_framework.testing import TestConfig
from myapp.settings import load_default_settings
def pytest_core_framework_config() -> TestConfig:
from myapp.main import build_app
return TestConfig(
settings_loader=load_default_settings,
app_factory=build_app,
)
@pytest.fixture(scope="session")
def anyio_backend() -> str:
return "asyncio"
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file core_framework-3.0.0.tar.gz.
File metadata
- Download URL: core_framework-3.0.0.tar.gz
- Upload date:
- Size: 937.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a0305f5aaabd1082f95fff93384c849369e2c5e8777ccc0ffb84a70839e70c5
|
|
| MD5 |
ce083fc6aa2e82351dcedb01e840c11c
|
|
| BLAKE2b-256 |
aeff885d93a77cb4d06681282e5ef9818cbbdfddd741de316bda6f0bb5c3745e
|
File details
Details for the file core_framework-3.0.0-py3-none-any.whl.
File metadata
- Download URL: core_framework-3.0.0-py3-none-any.whl
- Upload date:
- Size: 450.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc09a3f6a08ffbbbc2049f73aeaf5fce95b23d2a1d5a770a5a6430d542d9085d
|
|
| MD5 |
897b9a02044edbebf1cc364a8923cbad
|
|
| BLAKE2b-256 |
710c68c2f85af774214a7a2bf40097f040f9158d84d0038a942e76ec76a14ce3
|
