dbdocs 0.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dbdocs/__init__.py +0 -0
- dbdocs/__main__.py +3 -0
- dbdocs/cli/__init__.py +0 -0
- dbdocs/cli/main.py +86 -0
- dbdocs/core/__init__.py +0 -0
- dbdocs/core/artifacts.py +82 -0
- dbdocs/core/config.py +117 -0
- dbdocs/core/exceptions.py +24 -0
- dbdocs/core/log.py +58 -0
- dbdocs/extract/__init__.py +0 -0
- dbdocs/extract/_sqlglot_lineage.py +267 -0
- dbdocs/extract/column_lineage.py +181 -0
- dbdocs/extract/erd.py +102 -0
- dbdocs/extract/erd_json.py +80 -0
- dbdocs/extract/graph.py +72 -0
- dbdocs/extract/nodes.py +119 -0
- dbdocs/main.py +6 -0
- dbdocs/site/__init__.py +0 -0
- dbdocs/site/builder.py +132 -0
- dbdocs/site/bundle/assets/app.js +500 -0
- dbdocs/site/bundle/assets/favicon.svg +12 -0
- dbdocs/site/bundle/assets/graph/index.css +1 -0
- dbdocs/site/bundle/assets/graph/index.js +62 -0
- dbdocs/site/bundle/assets/style.css +289 -0
- dbdocs/site/bundle/assets/vendor/marked.min.js +6 -0
- dbdocs/site/bundle/assets/vendor/minisearch.min.js +8 -0
- dbdocs/site/bundle/index.html +48 -0
- dbdocs/site/deploy.py +123 -0
- dbdocs/site/inject.py +32 -0
- dbdocs-0.0.0.dist-info/METADATA +78 -0
- dbdocs-0.0.0.dist-info/RECORD +34 -0
- dbdocs-0.0.0.dist-info/WHEEL +4 -0
- dbdocs-0.0.0.dist-info/entry_points.txt +2 -0
- dbdocs-0.0.0.dist-info/licenses/LICENSE +21 -0
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: dbdocs
|
|
3
|
+
Version: 0.0.0
|
|
4
|
+
Summary: Alternative dbt docs site: Catalog + ERD + column-level lineage
|
|
5
|
+
Project-URL: Homepage, https://github.com/datnguye/dbt-docs
|
|
6
|
+
Project-URL: Repository, https://github.com/datnguye/dbt-docs
|
|
7
|
+
Author-email: Dat Nguyen <datnguyen.it09@gmail.com>
|
|
8
|
+
License: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: dbt,dbterd,documentation,erd,lineage,sqlglot
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
14
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
15
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
16
|
+
Requires-Python: >=3.10
|
|
17
|
+
Requires-Dist: click>=8.1
|
|
18
|
+
Requires-Dist: dbterd>=1.26
|
|
19
|
+
Requires-Dist: pyyaml>=6.0
|
|
20
|
+
Requires-Dist: sqlglot>=25
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
|
|
23
|
+
<p align="center">
|
|
24
|
+
<img src="docs/assets/logo.svg" alt="dbdocs logo" width="220" height="88">
|
|
25
|
+
</p>
|
|
26
|
+
|
|
27
|
+
<p align="center"><b>An alternative dbt docs site — catalog + ERD + column-level lineage, baked into one file.</b></p>
|
|
28
|
+
|
|
29
|
+
<p align="center">
|
|
30
|
+
<a href="https://dbdocs.datnguye.me/demo/"><img src="https://img.shields.io/badge/live-demo-FF694A?style=flat&logo=rocket&logoColor=white" alt="live demo"></a>
|
|
31
|
+
<a href="https://dbdocs.datnguye.me/"><img src="https://img.shields.io/badge/docs-visit%20site-blue?style=flat&logo=gitbook&logoColor=white" alt="docs"></a>
|
|
32
|
+
<a href="https://pypi.org/project/dbdocs/"><img src="https://badge.fury.io/py/dbdocs.svg" alt="PyPI version"></a>
|
|
33
|
+
<img src="https://img.shields.io/badge/CLI-Python-FFCE3E?labelColor=14354C&logo=python&logoColor=white" alt="python-cli">
|
|
34
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
|
35
|
+
<a href="https://www.python.org"><img src="https://img.shields.io/badge/Python-3.10|3.11|3.12|3.13-3776AB.svg?style=flat&logo=python&logoColor=white" alt="python"></a>
|
|
36
|
+
</p>
|
|
37
|
+
|
|
38
|
+
Turn your dbt artifacts into a single self-contained `index.html`: a browsable catalog, an interactive lineage DAG and ERD, and **column-level lineage** from your compiled SQL. No server, no database, no build step — just a file you can open or host anywhere.
|
|
39
|
+
|
|
40
|
+
| Catalog | Model page | Lineage DAG |
|
|
41
|
+
|---|---|---|
|
|
42
|
+
|  |  |  |
|
|
43
|
+
|
|
44
|
+
## Install
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
pip install dbdocs --upgrade
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Requires Python 3.10+.
|
|
51
|
+
|
|
52
|
+
## Quickstart
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
dbt docs generate # writes target/manifest.json + target/catalog.json
|
|
56
|
+
dbdocs generate # builds ./site/index.html with all data baked in
|
|
57
|
+
dbdocs serve # static http server on http://127.0.0.1:8000
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Full walkthrough, configuration, and architecture live in the **[documentation](https://dbdocs.datnguye.me/)**.
|
|
61
|
+
|
|
62
|
+
## Why dbdocs?
|
|
63
|
+
|
|
64
|
+
dbt's own docs are great until you want lineage at the *column* level — that's the gap this fills. Everything is derived from your dbt `manifest.json` / `catalog.json` and baked into one offline-friendly SPA: catalog navigation grouped by database/schema, per-model SQL and columns, interactive React Flow graphs, column-level lineage via sqlglot, client-side search, a dark/light theme, and versioned deploys with a built-in version switcher.
|
|
65
|
+
|
|
66
|
+
See the [docs](https://dbdocs.datnguye.me/) for the deep dives.
|
|
67
|
+
|
|
68
|
+
## Contributing
|
|
69
|
+
|
|
70
|
+
Contributions are welcome — bugs, features, docs, typos. See the **[Contributing Guide](https://dbdocs.datnguye.me/latest/nav/development/contributing-guide.html)**.
|
|
71
|
+
|
|
72
|
+
If dbdocs saves you some clicks, consider [buying me a coffee](https://www.buymeacoffee.com/datnguye).
|
|
73
|
+
|
|
74
|
+
<a href="https://www.buymeacoffee.com/datnguye"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?logo=buy-me-a-coffee&logoColor=white&labelColor=ff813f&style=for-the-badge" alt="buy me a coffee"></a>
|
|
75
|
+
|
|
76
|
+
## License
|
|
77
|
+
|
|
78
|
+
[MIT](./LICENSE) © Dat Nguyen
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
dbdocs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
2
|
+
dbdocs/__main__.py,sha256=yQJWXyRFDkt8JzXs51kPYI1ztJdEOXChU9v5qat5TIA,37
|
|
3
|
+
dbdocs/main.py,sha256=KKpj_MhPReIFWFpTCUNE6YWovhxkF6DljhQ8entZRac,94
|
|
4
|
+
dbdocs/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
|
+
dbdocs/cli/main.py,sha256=FJTHcI_MHBX6HX3evg3h67-z-Db9Jlr2hfGX1XIrRLE,3429
|
|
6
|
+
dbdocs/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
7
|
+
dbdocs/core/artifacts.py,sha256=qfJXO-JheaUnXgaOu2s5zaMysC4ASvztAkAo_T9ZmkQ,3401
|
|
8
|
+
dbdocs/core/config.py,sha256=LOErawakQphK6Dx-xasYH5NvM5YFNUBQxS8WUo1ZoHM,4704
|
|
9
|
+
dbdocs/core/exceptions.py,sha256=Y5r5b2KQI-GBk480m3uIqU2BE9q1RAhQfGw-kWbmDBg,673
|
|
10
|
+
dbdocs/core/log.py,sha256=IqXrhSlFXx7Dbl7sV_C8mC82X9Q5UsJIKllnT0dq3Ws,2193
|
|
11
|
+
dbdocs/extract/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
12
|
+
dbdocs/extract/_sqlglot_lineage.py,sha256=Oop9zwHIe6PLx-hnSXlNwNc9tIqlA6IDKVhNX7OsrdQ,8624
|
|
13
|
+
dbdocs/extract/column_lineage.py,sha256=F03TWhSufs15PLOlYZ3ACus5lNBi4ziZ6gveORFNdEw,7752
|
|
14
|
+
dbdocs/extract/erd.py,sha256=oU0XJb9oLP4Gc0ct-lNMVipVDNDi64CEqMomR7gsP9Q,4375
|
|
15
|
+
dbdocs/extract/erd_json.py,sha256=_wOb6_fYQDYurv8O4xvbFDKsQATmcChHj4SqUm3Kf3s,2946
|
|
16
|
+
dbdocs/extract/graph.py,sha256=q4I606VJvmvEXFjHsVR-eEU6fdAoIlWY9vuoNEN0duE,2846
|
|
17
|
+
dbdocs/extract/nodes.py,sha256=rOPIMJqpT2qmh1xcE4U8s07NuUN-6_GDAC4J8obclnE,5049
|
|
18
|
+
dbdocs/site/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
19
|
+
dbdocs/site/builder.py,sha256=U5kF6wQFlyF66TOE3MZgshhnUNNwY1ATglW3GoyRCJ8,5025
|
|
20
|
+
dbdocs/site/deploy.py,sha256=a3KFAbOaDhQkfGMHXvyU9yVBXKQuPPj8-qV0xykAncI,4422
|
|
21
|
+
dbdocs/site/inject.py,sha256=RxwTo5ID-75mMZqzjzXD5cRyYXK_Hx8aY0SExcBsMJw,1241
|
|
22
|
+
dbdocs/site/bundle/index.html,sha256=5wYef2C-hiYoR9fRnQkKSlNgn4bDCW09SkmENDaRbSg,2530
|
|
23
|
+
dbdocs/site/bundle/assets/app.js,sha256=dJtiRNaSMZUjjgfIG8i03cX1C38VmXzxHtsGoJCpPBo,24062
|
|
24
|
+
dbdocs/site/bundle/assets/favicon.svg,sha256=t-hyu5rEhadcFNtUmXC4sNNH245D6bxaicBi9aFRpA4,1054
|
|
25
|
+
dbdocs/site/bundle/assets/style.css,sha256=Pzf8MiC8PRTthRw_ajKkEny9gMGQuta__B5S_eONZdA,13864
|
|
26
|
+
dbdocs/site/bundle/assets/graph/index.css,sha256=n00AfipdUUZeqqf4a8tRvDTvbAY1w7uauIJfkt3CCwQ,19166
|
|
27
|
+
dbdocs/site/bundle/assets/graph/index.js,sha256=aob8OTDQKTv5kw1U5zPVfRjYjSiG-gx47hsN9wZP3w0,372089
|
|
28
|
+
dbdocs/site/bundle/assets/vendor/marked.min.js,sha256=Ffq85bZYmLMrA_XtJen4kacprUwNbYdxEKd0SqhHqJQ,35479
|
|
29
|
+
dbdocs/site/bundle/assets/vendor/minisearch.min.js,sha256=7Wrfw94HgrFAfBJDhvNQ1Y_zKD0C6XG37vS3pKdFz_A,19315
|
|
30
|
+
dbdocs-0.0.0.dist-info/METADATA,sha256=ReK7phMfFVeZtA8yN-sQExehB8A-fbunrFxAe4Hq77U,3941
|
|
31
|
+
dbdocs-0.0.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
|
|
32
|
+
dbdocs-0.0.0.dist-info/entry_points.txt,sha256=1IpUdKASIW6TO1RGa60dwoh9vKv-KEyD-8vtrbVIqsY,44
|
|
33
|
+
dbdocs-0.0.0.dist-info/licenses/LICENSE,sha256=8i4i2eLi11n7bvCGL4eOMBPaYV9azdtTDgOgPqBMrWc,1067
|
|
34
|
+
dbdocs-0.0.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Dat Nguyen
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|