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 provides structured data science projects with a data catalog, integrity tracking, caching, saved outputs, and AI coding assistant guardrails.

framework-py is the Python implementation of Framework (documentation). It reads and writes the same project files as the R package (settings.yml, the data catalog, and framework.db), so either language can read and verify a project's data. It runs standalone without Framework Cloud or the fw CLI.

Status: in development. See docs/plan.md for the implementation plan.

Installation

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

Optional extras install database drivers, S3 storage, and additional file formats: postgres, mysql, duckdb, sqlserver, s3, excel, spss, sas (version 8 SAS transport files), and rds (R .rds data frames).

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

GitHub Actions builds releases with signed build provenance. Verify that a wheel or sdist came from this repository:

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

Quick start

import framework as fw

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

Prepare a cloned project:

uv run python -m framework bootstrap

Framework Cloud sync

Pull or push packages, skills, and the data registry for a linked Framework Cloud project. Each call lists changes by section and asks once before applying them.

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

pull_skills(), push_skills(), pull_data_registry(), and push_data_registry() sync individual sections.

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 pinned to an exact source version. Concurrent edits stop for reconciliation. See the Skill sync guide.

When a skill's copies in .claude/skills and .agents/skills differ, copy the version to keep over the others (what it replaces is backed up), then sync:

fw.skills_copy(from_="claude", skills=["my-skill"])

After moving a skills folder by hand, or to track a copy as another skill, record it in .framework/skills.lock.json:

fw.skills_move("claude", "agents")
fw.skills_move(".claude/skills/my-skill", skill_id="5d0c2a7e-...")

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

scripts/sync_assets.py copies shared files (JSON Schemas, the framework.db schema, conformance fixtures, and the R export list) from the R package. Edit shared assets in the R repository, then run scripts/sync_assets.py here.

parity.toml maps every exported R function to its Python equivalent or records why none exists.

Metadata

Release files for framework-py 0.1.0.dev37

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

Built distribution (wheel)

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

Total release size: 1.1 MB

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

Download URL framework_py-0.1.0.dev37.tar.gz
Size 694.0 kB
Tags Source
SHA-256 checksum
How to use checksums
558e977cf681f6b3b41c2970ab824a562bee738edbf2529ccce370c244698ab8
BLAKE2b-256 checksum
How to use checksums
21763318dd315780376aa2006c4cf877877415ceb7a57cbec774872aaf69c08c
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 21, 2026.

Transparency log

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

Download URL framework_py-0.1.0.dev37-py3-none-any.whl
Size 430.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5e4e859a511dbc5965a48c3fe5e6c0929ae76115ee0e2bfa9ecdef542e36bb3c
BLAKE2b-256 checksum
How to use checksums
1e045df9825a561feede10e6dc91ea4cd5705972452b493e5a1c858919b2e2ff
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 21, 2026.

Transparency log

Security for framework-py 0.1.0.dev37

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.dev37.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 21, 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