framework-py 0.1.0.dev0__py3-none-any.whl

framework/templates/skills/framework-workflow/SKILL.md

@@ -0,0 +1,58 @@
+---
+name: framework-workflow
+description: Use when writing or editing any Python notebook or script in this Framework project. Every notebook and script starts with fw.scaffold(). Covers project setup, the analysis workflow, and creating notebooks and scripts with make_notebook() and make_script().
+---
+
+# Framework Workflow
+
+This project uses Framework for reproducible data analysis in Python. Import
+it as `import framework as fw`.
+
+## Start with scaffold()
+
+Begin every notebook and script with:
+
+```python
+import framework as fw
+
+fw.scaffold()
+```
+
+`scaffold()` finds the project root from any subfolder, loads `.env` and the
+settings, sets the random seed when the project asks for one, puts the
+project's `functions/` folder on the import path, and runs `scaffold.py`.
+Without it, settings paths and environment variables are not available.
+
+- Import helpers from `functions/` with a normal `import`. `scaffold()` has
+  already put the folder on the path, so do not edit `sys.path` yourself.
+- Do not reseed after `scaffold()` when the project sets a seed, unless an
+  operation needs its own seed. Say why in a comment if so.
+- Paths in the settings are relative to the project root. Framework resolves
+  them for you, so do not change the working directory.
+
+## Analysis workflow
+
+1. Read raw data with `fw.data_read()`.
+2. Clean it and save intermediate data with `fw.data_save()`.
+3. Analyze the final, analysis-ready data.
+4. Save results with `fw.save_table()`, `fw.save_figure()`, or `fw.save_model()`.
+
+The `framework-data` skill covers data rules, and the `framework-outputs`
+skill covers results, caching, and publishing.
+
+## New notebooks and scripts
+
+Create files through Framework so they go in the right folder with the
+project's template:
+
+```python
+fw.make_notebook("01-data-cleaning")  # notebooks/01-data-cleaning.qmd
+fw.make_script("data-processing")  # scripts/data-processing.py
+fw.make_notebook("talk", stub="revealjs")
+```
+
+## Habits
+
+- Raw data is never modified. Write cleaned versions to the intermediate folder.
+- Notebooks explain each transformation.
+- Commit notebooks and code, not rendered outputs.

framework/templates/stubs/notebook-default.ipynb

@@ -0,0 +1,34 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": ["# {{ title }}\n", "\n", "{{ author }}, {{ date }}"]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": ["import framework as fw\n", "\n", "fw.scaffold()"]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": ["## Analysis"]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {"display_name": "Python 3", "language": "python", "name": "python3"},
+  "language_info": {"name": "python"}
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

framework/templates/stubs/notebook-default.qmd

@@ -0,0 +1,43 @@
+---
+title: "{{ title }}"
+author: "{{ author }}"
+date: "{{ date }}"
+format:
+  html:
+    toc: true
+    toc-depth: 2
+    code-fold: false
+execute:
+  echo: true
+  warning: true
+jupyter: python3
+---
+
+```{python}
+#| label: setup
+#| include: false
+
+import framework as fw
+
+fw.scaffold()
+```
+
+## Introduction
+
+Brief description of this notebook's purpose.
+
+```{python}
+# Your code here
+```
+
+## Analysis
+
+```{python}
+# Analysis code
+```
+
+## Results
+
+```{python}
+# Results code
+```

framework/templates/stubs/notebook-minimal.qmd

@@ -0,0 +1,15 @@
+---
+title: "{{ title }}"
+author: "{{ author }}"
+date: "{{ date }}"
+jupyter: python3
+---
+
+```{python}
+#| label: setup
+#| include: false
+
+import framework as fw
+
+fw.scaffold()
+```

framework/templates/stubs/notebook-revealjs.qmd

@@ -0,0 +1,34 @@
+---
+title: "{{ title }}"
+author: "{{ author }}"
+date: "{{ date }}"
+format:
+  revealjs:
+    theme: default
+    transition: slide
+    slide-number: true
+execute:
+  echo: true
+jupyter: python3
+---
+
+```{python}
+#| label: setup
+#| include: false
+
+import framework as fw
+
+fw.scaffold()
+```
+
+## Introduction
+
+- Point 1
+- Point 2
+- Point 3
+
+## Analysis
+
+```{python}
+# data = fw.data_read("inputs.final.analysis")
+```

framework/templates/stubs/script-default.py

@@ -0,0 +1,18 @@
+"""{{ title }}
+
+Author: {{ author }}
+Date: {{ date }}
+"""
+
+import framework as fw
+
+fw.scaffold()
+
+
+def main() -> None:
+    # data = fw.data_read("inputs.raw.example")
+    pass
+
+
+if __name__ == "__main__":
+    main()

framework_py-0.1.0.dev0.dist-info/METADATA

@@ -0,0 +1,111 @@
+Metadata-Version: 2.5
+Name: framework-py
+Version: 0.1.0.dev0
+Summary: Structured data science projects: a data catalog, integrity tracking, caching, outputs, and AI guardrails
+Project-URL: Homepage, https://framework.table1.org
+Project-URL: Source, https://github.com/frameworktools/framework-py
+Project-URL: Issues, https://github.com/frameworktools/framework-py/issues
+Author-email: Erik Westlund <erik@table1.org>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: jsonschema>=4.18
+Requires-Dist: keyring>=25
+Requires-Dist: pandas>=2.2
+Requires-Dist: pyarrow>=16
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: secretstorage>=3.2; sys_platform == 'linux'
+Provides-Extra: duckdb
+Requires-Dist: duckdb>=1.0; extra == 'duckdb'
+Provides-Extra: excel
+Requires-Dist: openpyxl>=3.1; extra == 'excel'
+Provides-Extra: mysql
+Requires-Dist: pymysql>=1.1; extra == 'mysql'
+Provides-Extra: postgres
+Requires-Dist: psycopg[binary]>=3.1; extra == 'postgres'
+Provides-Extra: s3
+Requires-Dist: boto3>=1.34; extra == 's3'
+Provides-Extra: sas
+Requires-Dist: pyreadstat>=1.2; extra == 'sas'
+Provides-Extra: spss
+Requires-Dist: pyreadstat>=1.2; extra == 'spss'
+Provides-Extra: sqlserver
+Requires-Dist: pyodbc>=5.0; extra == 'sqlserver'
+Description-Content-Type: text/markdown
+
+# 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](https://framework.table1.org). 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](docs/plan.md).
+
+## Install
+
+```sh
+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).
+
+```sh
+uv add "framework-py[postgres,s3]"
+```
+
+## Use
+
+```python
+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:
+
+```sh
+uv run python -m framework bootstrap
+```
+
+## Development
+
+```sh
+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.

framework_py-0.1.0.dev0.dist-info/RECORD

@@ -0,0 +1,63 @@
+framework/__init__.py,sha256=Mq-Oq0FPzKPL7RbTGbwDaKV3do5DYLsBHkUSREabvoU,5652
+framework/__main__.py,sha256=FBtbnP45klyRrdCk3ANTh2xNg72IKGQopslqZuGLqq0,3337
+framework/_log.py,sha256=MhVL7izCJUvdg7F9430j8gPFiFyx3VcJ0qyJmrn2uUk,885
+framework/_paths.py,sha256=Kr-AZmSaKhKd_Wsxzgi3VnBPGD5FN3_GEg-bPUmKDkA,1736
+framework/_secretservice.py,sha256=zv5UvEekQic466qRmVpLG_hfEkisikHfab8e6kyzS2k,2450
+framework/_time.py,sha256=mv-BS3NjOo0hr6bwYRhUBY-3sG6SJmzaboaMD62QcJw,306
+framework/_wincred.py,sha256=oJGS37Dcw_PZVmiAGRu4H_lhcOC5-FqGGYfxVUGPPmU,3891
+framework/_yaml.py,sha256=ZJqh9ywmBEbD0VpV0FODcyAkvCsUTyj2W0MisFNRyT0,2372
+framework/ai.py,sha256=8IEemkQo-muwuP8FkyjuCl0Bv_CANkQTCiK47aTjqZs,8006
+framework/bootstrap.py,sha256=w-LLg_12KczC03FGD7bL6OZrjqTgFQNC5FPS8vFMIKg,7666
+framework/cache.py,sha256=enPWWQoozoEtrMgNxImTBUnW13Zny0n2X_gEcWAgUXI,11792
+framework/catalog.py,sha256=3ykZuLOXfnWDffXj0kSKsj4rmQ7saOer3athpCLPeAs,6795
+framework/cloud.py,sha256=OcPBn8c0xtTwW1-_Owav_vnPE9XswOCmfZ3COAbksZo,32664
+framework/config_home.py,sha256=pwZTfxN28qzqXCqWKLIqpALYyMKCoHpvEhrDedqlMY4,6716
+framework/connections.py,sha256=0A1wi7PPeFFgmDRZHBiCnDWNIMxpBQyPYAuDDSM5-U0,15548
+framework/console.py,sha256=L5CtNh8mX7oeZZfD1IT3GLG9xX-S0McUIV2DeOBBS00,1119
+framework/create.py,sha256=ZDWsidhqZsKZq038MvAWFI1ASj0GU4RQ9qYvqhZf0PE,22489
+framework/data.py,sha256=-lGRPEagLJ7oKLeKpVjd2sJAR6ehN6kWr3A3bQjk008,18816
+framework/db.py,sha256=dUj_xTEhbrYtlrFLkzwZ8hm95rov_8vELYgge0AcLPk,7604
+framework/dotenv.py,sha256=c3XWhb8H6zD6FhHwah1llCm-aG2CBlFGto2LdrEVRes,2592
+framework/errors.py,sha256=BIrWiMUuxmCBNVGxg-9vUAbht3N8On7iyacp0bnTUNk,1103
+framework/global_config.py,sha256=1MvaC_UuBJxzOUUWnTBUGSxi5Bc_xqntuseg-8Idchg,9096
+framework/hooks.py,sha256=xRoFCECCwlNyk0bedf8D8nxG9cE6uKfZC_GfgAkcDCU,13457
+framework/integrity.py,sha256=2hXk95tlNGs6HVTFA0AqcPWQg2AiO6Hy0APMIXHpCTU,586
+framework/notebooks.py,sha256=Id6b-heolpKh6QGZ5N_Ork4pWQrt2DqNTFuFCAJHEPY,14511
+framework/outputs.py,sha256=U81GqxfZzBopkjJWf6XVxdhfBTh0I69COPzE9ucM8Y4,12197
+framework/packages.py,sha256=TPGrACLNoXl6Qwc5fXXTAbQRpsZYt8fhi00VhLLg9J8,9319
+framework/project.py,sha256=0fqWystQkqbumt_V8EbbRyIkPYlvhWQzOXaMC3BPwmI,1581
+framework/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+framework/quarto.py,sha256=8qCnfCCzPvCVVNyAXCeEqdbJioROB5MO7tti_2WK5Ns,5456
+framework/scaffold.py,sha256=BB59l4M5IJo6p_fOvS263FgKNez6Coz5B67ijWymP9w,9528
+framework/scratch.py,sha256=HO8wfKqET3TuP-Mp1dQKTD0rNlYTifrUQwCvwf5-ApI,3877
+framework/security.py,sha256=dQMxo71rur5ToqbLisykvMEqg6YXD7NJMgfTzK8-ltU,24460
+framework/settings.py,sha256=Fl9U5ftXqqVKkiBxeLBDjkdixXt5CeTTLbfLCapS798,15901
+framework/storage.py,sha256=FoNzVjCPeK7CJ8_ZTBFCgF9hPaIPnf0Hkw8kTsysCNs,18913
+framework/_assets/init.sql,sha256=-aIiuIcCmBniGKq-CHdRtUiV9e_CLXoqxxd05snmgOE,1156
+framework/_assets/hooks/pre-commit,sha256=vx5kfbJo2sAUnvEcZdm_wllw9_sNX4o5xlzYJo8-jbA,1836
+framework/_assets/schema/layer.v1.json,sha256=mfHx1nMwQQOisK_Qtiynt_ZrmV-0uAKzk-NvVh_4Szk,13519
+framework/_assets/schema/layers.v1.json,sha256=3HTKwXKz7b-wm8BzHy254J_iopxULGCU7x4p4ZcEh_Y,19654
+framework/_assets/schema/spec.v1.json,sha256=1uNYKapiiubthiNM-h5ycAAobid18dtIdO1clYmXE4c,13414
+framework/spec/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+framework/spec/check.py,sha256=lJ5wtGiQ2tTFmfa-1X5z06i6VPbqctW2bsW7nNtweBQ,7863
+framework/spec/merge.py,sha256=ffuhG9dP41x0t1NjH_9eoUTZmlH4r5blvkMXVJS1vnI,6271
+framework/spec/resolve.py,sha256=sYIcgg6mak05qgPDp1c1Zss6xG_YQS64yS3T4mibs-g,8633
+framework/templates/defaults.yml,sha256=KMduXZw8-m8qB3jhYd3z8Zb1tPq7bnoqdbvu4wtcQH8,3893
+framework/templates/gitignore/course,sha256=CGPnIM_-ZAU7-WOGyKhaWSTdqUR3atAUmxqrbiFd5RU,2869
+framework/templates/gitignore/presentation,sha256=CAl2vPcA1Lgv1CXsVmuKf7DtIVs-g6WEWnPnOuGmMdc,2743
+framework/templates/gitignore/project,sha256=D8jFTFhIyJyTIh1xrPE5wFkvuJlSkqaqeJYafnmRPts,2622
+framework/templates/gitignore/sensitive,sha256=mz0KwMHq1UJhOGJTFzTbzJug6C6p2wbec9ADl2veqhE,3550
+framework/templates/skills/framework-data/SKILL.md,sha256=jdy9b0OgEWEvySgBTEVwEr6haSHYqRgCRRaT9Xd9zso,1802
+framework/templates/skills/framework-outputs/SKILL.md,sha256=TPxr8mr8Xmf3cdsA8gsd2E6qnADraDz8TMlz2JaMyVw,2407
+framework/templates/skills/framework-packages/SKILL.md,sha256=hReYddtMTK9dzqLiGOrSxbE8YA6OFia_E8tqbkSgNxI,1170
+framework/templates/skills/framework-sensitive-data/SKILL.md,sha256=o3TY43t5Ln6wCUacZ7rvOwVuRgDl2yVUgScsufnwFzk,1536
+framework/templates/skills/framework-workflow/SKILL.md,sha256=-UIc81zJrO-0FfKlt2QK5Zfh0YzqbqNzBPskBpXe_1Q,2139
+framework/templates/stubs/notebook-default.ipynb,sha256=2p3Zj6bQEHlUL1eEVAbPfTTxqGBs84C67tA3MkCzVQs,685
+framework/templates/stubs/notebook-default.qmd,sha256=8Js1S2BcHYeQWmJS-kt31gBvIjKzQeGEy2M2lQCVA1Y,472
+framework/templates/stubs/notebook-minimal.qmd,sha256=2U2k8judffhrh_6m6r6OAbQBCYEtViAjeKRBqBYCJTM,178
+framework/templates/stubs/notebook-revealjs.qmd,sha256=_ztT_gHoudpB5DIjlbvtB5zQ8163DeV8xbWcT-HgJrI,409
+framework/templates/stubs/script-default.py,sha256=vbWqgW0_rHot17mQC3tYb92g_9L-cbTOeL3y99BRrSk,216
+framework_py-0.1.0.dev0.dist-info/METADATA,sha256=bRUaDUI5tJy07M93rsCcxQhgP234sSCgPUR8N3gi35U,3481
+framework_py-0.1.0.dev0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+framework_py-0.1.0.dev0.dist-info/licenses/LICENSE,sha256=giOOgSwALkZimC7uhLZQK8Untez641bLW1-2-Cjvmq0,1072
+framework_py-0.1.0.dev0.dist-info/RECORD,,

framework_py-0.1.0.dev0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

framework_py-0.1.0.dev0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2026 Erik Westlund
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.