dbt-pathfinder 0.1.0__tar.gz

dbt_pathfinder-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

dbt_pathfinder-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jon Woodland
+
+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.

dbt_pathfinder-0.1.0/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: dbt-pathfinder
+Version: 0.1.0
+Summary: CLI and library for exploring dbt manifests as graphs.
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: networkx>=3.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: rich>=13.0
+Requires-Dist: typer>=0.9
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# dbt-pathfinder
+
+> 🔎 Explore, debug, and understand your dbt lineage — fast.
+
+`dbt-pathfinder` is a Python CLI + library that parses your `manifest.json` and turns it into a navigable graph of your dbt project.
+
+It helps you answer questions like:
+
+* “What breaks if I change this model?”
+* “How are these two models connected?”
+* “What joins actually exist along this path?”
+* “Is this relationship 1:1 or 1:N?”
+
+---
+
+## 🚀 Why this exists
+
+dbt gives you lineage… but not *exploration*.
+
+When projects scale:
+
+* lineage graphs get noisy
+* impact analysis becomes manual
+* understanding joins requires digging through SQL
+
+`dbt-pathfinder` bridges that gap:
+👉 fast CLI exploration
+👉 precise impact analysis
+👉 inferred join + cardinality insight
+
+---
+
+## ✨ Features
+
+### 🔍 `show`
+
+Inspect a node and its immediate relationships
+
+```bash
+dbt-pathfinder show --manifest target/manifest.json --model fct_orders
+```
+
+Outputs:
+
+* node metadata
+* upstream dependencies
+* downstream children
+
+---
+
+### 💥 `impact`
+
+See everything downstream of a model (grouped by depth)
+
+```bash
+dbt-pathfinder impact --manifest target/manifest.json --model stg_orders
+```
+
+Example output:
+
+```
+Depth 1:
+- fct_orders
+- dim_customers
+
+Depth 2:
+- mart_customer_ltv
+```
+
+Perfect for:
+
+* change impact analysis
+* safe refactoring
+* CI/CD validation
+
+---
+
+### 🧭 `path`
+
+Find the shortest path between two nodes
+
+```bash
+dbt-pathfinder path \
+  --manifest target/manifest.json \
+  --from stg_orders \
+  --to mart_customer_ltv
+```
+
+Supports:
+
+* `--mode directed` (default)
+* `--mode any` (for debugging unexpected relationships)
+
+---
+
+### 🧠 `path-explain` (🔥 killer feature)
+
+Explain *how* models are connected — not just that they are.
+
+```bash
+dbt-pathfinder path-explain \
+  --manifest target/manifest.json \
+  --from stg_orders \
+  --to mart_customer_ltv
+```
+
+Includes:
+
+* inferred join conditions (`JOIN ... ON ...`)
+* join keys
+* inferred cardinality:
+
+  * `1:1`
+  * `1:N`
+  * `N:1`
+  * `N:N`
+* confidence level
+
+> ⚠️ Note: inference is heuristic and depends on SQL structure and dbt tests.
+
+---
+
+## 📦 Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install dbt-pathfinder
+```
+
+### From source (dev)
+
+```bash
+git clone https://github.com/<your-username>/dbt-pathfinder.git
+cd dbt-pathfinder
+pip install -e ".[dev]"
+```
+
+---
+
+## ⚡ Quick Start
+
+1. Generate your dbt manifest:
+
+```bash
+dbt compile
+```
+
+2. Run:
+
+```bash
+dbt-pathfinder show --manifest target/manifest.json --model my_model
+```
+
+---
+
+## 🧰 CLI Usage
+
+```bash
+dbt-pathfinder --help
+```
+
+Examples:
+
+```bash
+dbt-pathfinder show --manifest target/manifest.json --model fct_orders --verbose
+
+dbt-pathfinder impact --manifest target/manifest.json --model stg_orders
+
+dbt-pathfinder impact --manifest target/manifest.json --model stg_orders --output json
+
+dbt-pathfinder path --manifest target/manifest.json --from stg_orders --to mart_customer_ltv
+
+dbt-pathfinder path-explain --manifest target/manifest.json --from stg_orders --to mart_customer_ltv --ui rich
+```
+
+---
+
+## 🖥 Output Modes
+
+* `--ui rich` (default): formatted terminal output
+* `--ui text`: plain text
+* `--output json`: machine-readable (great for CI/CD)
+
+---
+
+## 🧱 Library Usage
+
+You can also use `dbt-pathfinder` programmatically:
+
+```python
+from dbt_pathfinder.services.pathfinder_service import PathfinderService
+
+service = PathfinderService.from_manifest("target/manifest.json")
+
+print(service.show("fct_orders"))
+print(service.impact("stg_orders"))
+print(service.path("stg_orders", "mart_customer_ltv", directed=True))
+print(service.explain_path("stg_orders", "mart_customer_ltv", directed=True))
+```
+
+---
+
+## 🧠 How it works
+
+* Parses dbt `manifest.json`
+* Builds a directed graph:
+
+  ```
+  upstream → downstream
+  ```
+* Uses:
+
+  * graph traversal for lineage + paths
+  * SQL parsing heuristics for join inference
+  * dbt tests (`unique`, `not_null`) for cardinality hints
+
+---
+
+## ⚠️ Limitations
+
+* Join inference is best-effort (complex SQL/macros may reduce accuracy)
+* Requires a valid dbt `manifest.json`
+* Ambiguous model names may require full `unique_id`
+
+---
+
+## 🛠 Roadmap
+
+* [ ] CI/CD integration for impact analysis in PRs
+* [ ] Visualization (graph output / web UI)
+* [ ] dbt Cloud integration
+* [ ] Column-level lineage support
+* [ ] Better SQL parsing for complex joins
+
+---
+
+## 🤝 Contributing
+
+Contributions welcome!
+
+1. Fork the repo
+2. Create a feature branch
+3. Add tests
+4. Open a PR
+
+---
+
+## ⭐ Support
+
+If this tool helps you:
+
+* ⭐ Star the repo
+* 🐛 Open issues
+* 💡 Suggest features
+
+---
+
+## 📄 License
+
+MIT License