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, sas (version 8 SAS transport files), and rds (R's .rds data frames).

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

Skill sync

Sync a local skill and its companion files with your Framework Cloud account:

fw.skills_sync(".agents/skills/my-skill", dry_run=True)
fw.skills_sync(".agents/skills/my-skill")

Local edits create account versions. Edited Framework skills become private forks with an exact source version. Concurrent edits stop for reconciliation. Skill sync guide.

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.dev10

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.dev10
File Size Uploaded Provenance Actions
framework_py-0.1.0.dev10.tar.gz 439.7 kB With provenance Details for framework_py-0.1.0.dev10.tar.gz

Built distribution (wheel)

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

Total release size: 722.8 kB

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

Download URL framework_py-0.1.0.dev10.tar.gz
Size 439.7 kB
Tags Source
SHA-256 checksum
How to use checksums
21a59aec3ece36889e2140a02e2342e68b594b1ba7b7e03415869a5b6f7a77a4
BLAKE2b-256 checksum
How to use checksums
60cf0498095ffa32faf04cdd2958b2e63d8c3185ae35fc7f24292554b8aacfac
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 Nov 7, 2026.

Transparency log

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

Download URL framework_py-0.1.0.dev10-py3-none-any.whl
Size 283.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
210e2fe35495e649210c86d9e43bd26e3470a194fe1e4457eca1754b6ab68818
BLAKE2b-256 checksum
How to use checksums
7ab8281f16247419413317b28330ad7a2a1437b28b2af90880ab39c0d31dcef8
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 Nov 7, 2026.

Transparency log

Security for framework-py 0.1.0.dev10

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.dev10.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 Nov 7, 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