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.
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.dev25
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| framework_py-0.1.0.dev25.tar.gz | 559.2 kB | With provenance | Details for framework_py-0.1.0.dev25.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| framework_py-0.1.0.dev25-py3-none-any.whl | Python 3 | none | any | Details for framework_py-0.1.0.dev25-py3-none-any.whl |
Total release size: 930.7 kB
Release files / framework_py-0.1.0.dev25.tar.gz
| Download URL | framework_py-0.1.0.dev25.tar.gz |
|---|---|
| Size | 559.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f62b3885b7578aa5a10fa607518cfbd1dda6282f4f644eca44372eba5ba9ab82
|
|
BLAKE2b-256 checksum How to use checksums |
2f625f3fed2c7f4b1d732d8bf2c8992d72b4e64494ce067d8a01fe6a90938d11
|
| 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 18, 2026.
Transparency logRelease files / framework_py-0.1.0.dev25-py3-none-any.whl
| Download URL | framework_py-0.1.0.dev25-py3-none-any.whl |
|---|---|
| Size | 371.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
59ab8fd2ee34ca9a9959666ff31b7431eeb21b030ff162ecd52968cb77e59bcc
|
|
BLAKE2b-256 checksum How to use checksums |
040faa644496aaa94f8d56f6ac6b296a6d400c1563f04a37b3c39ef2fdf4c0b0
|
| 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 18, 2026.
Transparency logSecurity for framework-py 0.1.0.dev25
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.
Attestation for framework_py-0.1.0.dev25.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 18, 2026.
Transparency logA 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.