Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

framework-py

Framework for Python: structured data science projects with a data catalog, data integrity tracking, caching, saved outputs, and guardrails for AI coding assistants.

framework-py is the Python implementation of Framework. It reads and writes the same project files as the R package (settings.yml, the data catalog, and framework.db), so either language can work with a project's data. It works without Framework Cloud and without the fw command-line tool.

Status: in development. The plan is in docs/plan.md.

Install

uv add framework-py
# or
pip install framework-py

Optional extras add database drivers, S3 storage, and more file formats: postgres, mysql, duckdb, sqlserver, s3, excel, spss, and sas (version 8 SAS transport files).

uv add "framework-py[postgres,s3]"

Releases are published from GitHub Actions with signed build provenance. To check that a downloaded wheel or sdist was built from this repository:

gh attestation verify framework_py-<version>-py3-none-any.whl --repo frameworktools/framework-py

Use

import framework as fw

fw.settings("directories.notebooks")
info = fw.data_info("inputs.raw.survey")
fw.data_list()

After cloning a project, prepare it with:

uv run python -m framework bootstrap

Development

uv sync
uv run pytest
uv run ruff check && uv run ruff format --check
uv run mypy
uv run python scripts/check_parity.py
uv run python scripts/sync_assets.py --check

Shared files (JSON Schemas, the framework.db schema, conformance fixtures, and the R export list) are copied from the R package with scripts/sync_assets.py. Change them in the R repository, then copy them again.

parity.toml maps every function the R package exports to its Python equivalent, or gives the reason there is none.

Metadata

Release files for framework-py 0.1.0.dev1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for framework-py 0.1.0.dev1
File Size Uploaded Provenance Actions
framework_py-0.1.0.dev1.tar.gz 220.2 kB With provenance Details for framework_py-0.1.0.dev1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for framework-py 0.1.0.dev1
File Interpreter ABI Platform Actions
framework_py-0.1.0.dev1-py3-none-any.whl Python 3 none any Details for framework_py-0.1.0.dev1-py3-none-any.whl

Total release size: 355.6 kB

Release files / framework_py-0.1.0.dev1.tar.gz

Download URL framework_py-0.1.0.dev1.tar.gz
Size 220.2 kB
Tags Source
SHA-256 checksum
How to use checksums
6bd4e31f9449d3ebd454c6911f0f48ddf0a89cd5b9429e6bd8035af9a4b34dbd
BLAKE2b-256 checksum
How to use checksums
c2909d042cb135afe673a4f45e29c0e806758086ab5168ec256f35a2a1ca34cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.

Transparency log

Release files / framework_py-0.1.0.dev1-py3-none-any.whl

Download URL framework_py-0.1.0.dev1-py3-none-any.whl
Size 135.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c08198373518096af17a7733367f84b8098716b7f866f0d73232c78efd07ffc7
BLAKE2b-256 checksum
How to use checksums
cf14d4e00db517c0d9496455e1a8e7e92cd35f9fc1765b220413f886e019357f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.

Transparency log

Security for framework-py 0.1.0.dev1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for framework_py-0.1.0.dev1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page