model-ledger 0.5.0__tar.gz

model_ledger-0.5.0/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,20 @@
+---
+name: Bug Report
+about: Report a bug in model-ledger
+labels: bug
+assignees: vigneshnarayanaswamy
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps or code to reproduce the behavior.
+
+**Expected behavior**
+What you expected to happen.
+
+**Environment**
+- Python version:
+- model-ledger version:
+- OS:

model_ledger-0.5.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Questions & Support
+    url: https://discord.gg/block-opensource
+    about: Ask questions and get help from the community

model_ledger-0.5.0/.github/workflows/gitleaks.yml

@@ -0,0 +1,23 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+name: Gitleaks
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          fetch-depth: 0
+
+      - name: Install gitleaks
+        run: |
+          curl -sSfL https://github.com/gitleaks/gitleaks/releases/download/v8.24.3/gitleaks_8.24.3_linux_x64.tar.gz | tar xz
+          sudo mv gitleaks /usr/local/bin/
+
+      - name: Run gitleaks
+        run: gitleaks detect --config .gitleaks.toml --verbose

model_ledger-0.5.0/.github/workflows/release.yml

@@ -0,0 +1,55 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    permissions:
+      id-token: write
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+
+      - name: Pull current version from pyproject.toml
+        id: get_version
+        run: |
+          echo "VERSION=$(grep -m 1 'version =' "pyproject.toml" | awk -F'"' '{print $2}')" >> $GITHUB_ENV
+
+      - name: Extract tag version
+        id: extract_tag
+        run: |
+          TAG_VERSION=$(echo "${{ github.event.release.tag_name }}" | sed -E 's/v(.*)/\1/')
+          echo "TAG_VERSION=$TAG_VERSION" >> $GITHUB_ENV
+
+      - name: Confirm tag matches version from pyproject.toml
+        id: check_tag
+        run: |
+          if [ "${{ env.TAG_VERSION }}" != "${{ env.VERSION }}" ]; then
+            echo "::error::Tag version (${{ env.TAG_VERSION }}) does not match version in pyproject.toml (${{ env.VERSION }})."
+            exit 1
+          fi
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6
+        with:
+          version: "latest"
+          enable-cache: true
+
+      - name: Install Python
+        run: uv python install 3.12
+
+      - name: Build Package
+        run: uv build
+
+      - name: Upload to GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload ${{ github.event.release.tag_name }} dist/*
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1

model_ledger-0.5.0/.gitignore

@@ -0,0 +1,30 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.venv/
+venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+*.db
+*.sqlite
+*.sqlite3
+.env
+.env.local
+.DS_Store
+
+# Lock file (contains index URLs from local environment)
+uv.lock
+
+# Internal design docs (contain org-specific context)
+docs/superpowers/
+
+# Detailed internal blocklist (committed config is .gitleaks.toml)
+.gitleaks-internal.toml

model_ledger-0.5.0/.gitleaks.toml

@@ -0,0 +1,46 @@
+# Gitleaks config for OSS boundary enforcement
+# Blocks internal infrastructure patterns from leaking into the public repo.
+# For detailed internal blocklists, see .gitleaks-internal.toml (gitignored).
+
+title = "model-ledger OSS boundary rules"
+
+# Internal corporate hostnames
+[[rules]]
+id = "internal-hostname"
+description = "Internal corporate hostname"
+regex = '''[a-z0-9.-]+\.sqprod\.co'''
+keywords = ["sqprod"]
+
+# Internal Artifactory / PyPI mirror
+[[rules]]
+id = "internal-artifactory"
+description = "Internal Artifactory hostname"
+regex = '''artifactory\.global\.square'''
+keywords = ["artifactory.global"]
+
+[[rules]]
+id = "internal-pypi-mirror"
+description = "Internal PyPI mirror"
+regex = '''block-artifacts\.com'''
+keywords = ["block-artifacts"]
+
+# Corporate email in source (OK in pyproject.toml authors, git config)
+[[rules]]
+id = "corporate-email"
+description = "Corporate email domain in source files"
+regex = '''@squareup\.com'''
+keywords = ["squareup.com"]
+
+# Internal GNS hostname
+[[rules]]
+id = "internal-gns"
+description = "Internal GNS hostname"
+regex = '''gns\.square'''
+keywords = ["gns.square"]
+
+# Global allowlist — files where matches are expected
+[allowlist]
+paths = [
+    '''\.gitleaks\.toml$''',
+    '''\.gitleaks-internal\.toml$''',
+]

model_ledger-0.5.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.24.3
+    hooks:
+      - id: gitleaks
+        # Runs committed config; for internal blocklist, run manually:
+        # gitleaks detect --config .gitleaks-internal.toml

model_ledger-0.5.0/CHANGELOG.md

@@ -0,0 +1,67 @@
+# Changelog
+
+## Unreleased
+
+- feat: `register_group()` — register governed model groups with member linking
+- feat: `members()` — list all models that belong to a group
+- feat: `groups()` — find all groups a model belongs to
+
+## v0.5.0
+
+- feat: `Ledger.from_sqlite(path)` — persistent SQLite backend, zero dependencies
+- feat: `Ledger.from_snowflake(conn, schema)` — persistent Snowflake backend
+- feat: `sql_connector()` — config-driven SQL-based model discovery
+- feat: `rest_connector()` — config-driven REST API model discovery
+- feat: `github_connector()` — discover models from config files in GitHub repos
+- feat: Connector factories return `SourceConnector` instances for composability
+
+## Unreleased
+
+- fix: deduplicate `ModelNotFoundError` — use canonical class from `core.exceptions`
+- test: add coverage for `'value' AS model_name` extraction pattern
+
+## v0.4.8
+
+- fix: exclude volatile timestamps from content hash dedup
+
+## v0.4.7
+
+- perf: cache nodes from `add()`, skip existing edges in `connect()`
+
+## v0.4.6
+
+- perf: skip per-model backend queries when cache is warm, store content hash
+
+## v0.4.5
+
+- perf: content-hash dedup and bulk preload in `add()`
+
+## v0.4.4
+
+- fix: extract `model_name` from SELECT aliases and add pipeline input ports
+
+## v0.4.3
+
+- perf: add name cache to Ledger for zero-cost model lookups
+
+## v0.4.2
+
+- perf: bulk load discovered snapshots in `connect()` — 1 query instead of N
+
+## v0.4.1
+
+- fix: `DataPort` schema matching must require both sides have the key
+
+## v0.4.0
+
+- feat: DataNode graph architecture — `add()`, `connect()`, `trace()`, `upstream()`, `downstream()`
+- feat: `DataPort` with schema discriminators for shared table matching
+- feat: `SourceConnector` protocol for platform-specific discovery
+- feat: SQL adapters — `extract_tables_from_sql`, `extract_write_tables`, `extract_model_name_filters`
+
+## v0.3.0
+
+- feat: event-log paradigm — `ModelRef`, `Snapshot`, `Tag`
+- feat: `Ledger` SDK — `register`, `record`, `tag`, `link_dependency`, `dependencies`, `inventory_at`
+- feat: `LedgerBackend` protocol with `InMemoryLedgerBackend`
+- feat: Scanner architecture — `Scanner` protocol, `ModelCandidate`, `InventoryScanner`

model_ledger-0.5.0/CLAUDE.md

@@ -0,0 +1,60 @@
+# model-ledger
+
+Open-source model inventory and governance framework. Apache-2.0.
+
+## Build & Test
+
+```bash
+.venv/bin/python -m pytest tests/ -v
+.venv/bin/python -m pytest tests/test_file.py::test_name -v  # single test
+.venv/bin/python -m ruff check src/ tests/
+.venv/bin/python -m ruff format src/ tests/
+.venv/bin/python -m mypy src/
+```
+
+## Architecture
+
+### v0.5.0 (current — production backends + connector factories)
+- `src/model_ledger/backends/sqlite_ledger.py` — SQLiteLedgerBackend (persistent, zero-dep)
+- `src/model_ledger/backends/snowflake.py` — SnowflakeLedgerBackend (upstreamed from Block)
+- `src/model_ledger/connectors/sql.py` — sql_connector() factory
+- `src/model_ledger/connectors/rest.py` — rest_connector() factory
+- `src/model_ledger/connectors/github.py` — github_connector() factory
+- `src/model_ledger/sdk/ledger.py` — Ledger.from_sqlite(), Ledger.from_snowflake()
+
+### v0.4.x (DataNode graph)
+- `src/model_ledger/core/ledger_models.py` — ModelRef, Snapshot, Tag
+- `src/model_ledger/sdk/ledger.py` — Ledger SDK (register, record, tag, add, connect, trace, upstream, downstream)
+- `src/model_ledger/graph/models.py` — DataNode, DataPort (with schema discriminators)
+- `src/model_ledger/graph/protocol.py` — SourceConnector protocol
+- `src/model_ledger/backends/ledger_protocol.py` — LedgerBackend protocol
+- `src/model_ledger/backends/ledger_memory.py` — InMemory backend
+- `src/model_ledger/adapters/sql.py` — SQL parsing (extract_tables, write_tables, model_name_filters)
+- `src/model_ledger/adapters/tables.py` — Table-based pipeline discovery
+- `src/model_ledger/adapters/cron.py` — Cron expression translation
+
+### v0.3.0 (event-log paradigm)
+- `src/model_ledger/scanner/` — Scanner protocol, ModelCandidate, InventoryScanner, ScannerRegistry
+
+### v0.2.0 (legacy — retained for reference)
+- `src/model_ledger/core/models.py` — Model, ModelVersion, ComponentNode
+- `src/model_ledger/sdk/inventory.py` — Inventory, DraftVersion (context manager API)
+- `src/model_ledger/backends/` — InventoryBackend protocol + SQLite/InMemory
+- `src/model_ledger/validate/` — SR 11-7, EU AI Act, NIST AI RMF validation profiles
+- `src/model_ledger/introspect/` — Plugin-based model introspection
+- `src/model_ledger/cli/` — Typer CLI
+- `src/model_ledger/export/` — Audit pack export
+
+## Boundary Rules
+
+This is an Apache-2.0 open-source project. All code must be generic and useful to any organization. Organization-specific connectors, auth, and backends go in separate packages.
+
+**Examples in code, tests, and docstrings must be generic** — use names like "Credit Scorecard", "feature_pipeline", "risk-team", "scoring_model". Never use organization-specific system names, team names, queue names, or person names in OSS code.
+
+## Key Patterns
+
+- Event-log paradigm: models are identities (ModelRef), everything else is immutable Snapshots
+- Protocol-first: all extension points use `@runtime_checkable` Protocol (no ABCs)
+- Tool-shaped SDK: every Ledger method works as an agent tool call
+- Append-only audit trail on every mutation
+- Plugin discovery via `importlib.metadata.entry_points()`

model_ledger-0.5.0/CODEOWNERS

@@ -0,0 +1,2 @@
+# model-ledger project leads
+* @vigneshnarayanaswamy

model_ledger-0.5.0/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing to model-ledger
+
+Thank you for your interest in contributing to model-ledger!
+
+## Development Setup
+
+```bash
+# Clone the repository
+git clone git@github.com:block/model-ledger.git
+cd model-ledger
+
+# Install dependencies
+uv sync --all-extras
+
+# Run tests
+uv run pytest -v
+
+# Run linter
+uv run ruff check .
+uv run ruff format --check .
+```
+
+## Making Changes
+
+1. Fork the repository and create a branch from `main`.
+2. Write tests for your changes (TDD preferred).
+3. Run `uv run pytest -v` and ensure all tests pass.
+4. Run `uv run ruff check . && uv run ruff format .` for linting.
+5. Commit with DCO sign-off: `git commit --signoff`
+6. Use conventional commit format for PR titles: `feat(scope): description`
+
+## DCO Sign-Off
+
+All commits must include a DCO (Developer Certificate of Origin) sign-off:
+
+```bash
+git commit --signoff -m "feat(sdk): add bulk registration"
+```
+
+## Code Style
+
+- Python 3.10+ type hints throughout
+- Pydantic 2.x for data models
+- ruff for linting and formatting
+- pytest for testing
+
+## Block Employees
+
+If you work at Block, see internal documentation for Block-specific integrations and adapters.
+
+## Questions?
+
+Open a discussion on GitHub or reach out on Discord.

model_ledger-0.5.0/GOVERNANCE.md

@@ -0,0 +1 @@
+## [Click here for Block Open Source Project governance information](https://github.com/block/.github/blob/main/GOVERNANCE.md)

model_ledger-0.5.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Block, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.