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

Sync with Framework Cloud

Pull or push everything that syncs with the project on Framework Cloud: its packages, skills, and data registry. Each call lists the changes by part and asks once.

fw.pull_all(dry_run=True)
fw.pull_all()
fw.push_all()

pull_skills() / push_skills() and pull_data_registry() / push_data_registry() sync one part.

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

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

Built distribution (wheel)

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

Total release size: 909.8 kB

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

Download URL framework_py-0.1.0.dev22.tar.gz
Size 546.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4f538c5d15fb73c5fd7312980bd8001fbef7e71e8106e252a0e7f1ecf92debf8
BLAKE2b-256 checksum
How to use checksums
0db95ad9746381570482ebc5565543f221beda9a29b6f717e22143a45bf5fc93
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 15, 2026.

Transparency log

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

Download URL framework_py-0.1.0.dev22-py3-none-any.whl
Size 363.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9155a747f6294ab21d083f4808308e0e0e42347285a29f146d0b8bb6ce5084d5
BLAKE2b-256 checksum
How to use checksums
a2203ccc0669ba1347da0d4a75c383ffd3fdcb9529e9fa627cde6f9ad919a738
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 15, 2026.

Transparency log

Security for framework-py 0.1.0.dev22

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.dev22.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 15, 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