data-graf 0.1.0.dev0__tar.gz

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.
Files changed (28) hide show
  1. data_graf-0.1.0.dev0/.gitignore +223 -0
  2. data_graf-0.1.0.dev0/CLAUDE.md +32 -0
  3. data_graf-0.1.0.dev0/LICENSE +201 -0
  4. data_graf-0.1.0.dev0/NOTICE +10 -0
  5. data_graf-0.1.0.dev0/PKG-INFO +86 -0
  6. data_graf-0.1.0.dev0/README.md +67 -0
  7. data_graf-0.1.0.dev0/docs/DEV/plan.md +108 -0
  8. data_graf-0.1.0.dev0/docs/DEV/readme-lineage.md +138 -0
  9. data_graf-0.1.0.dev0/examples/chinook.semantic_model.yaml +502 -0
  10. data_graf-0.1.0.dev0/pyproject.toml +34 -0
  11. data_graf-0.1.0.dev0/src/datagraf/__init__.py +17 -0
  12. data_graf-0.1.0.dev0/src/datagraf/checks.py +114 -0
  13. data_graf-0.1.0.dev0/src/datagraf/cli.py +231 -0
  14. data_graf-0.1.0.dev0/src/datagraf/export.py +41 -0
  15. data_graf-0.1.0.dev0/src/datagraf/lineage.py +212 -0
  16. data_graf-0.1.0.dev0/src/datagraf/model.py +201 -0
  17. data_graf-0.1.0.dev0/src/datagraf/schemas/osi-0.1.1.schema.json +344 -0
  18. data_graf-0.1.0.dev0/src/datagraf/schemas/ossie-0.3.0.dev0.schema.json +398 -0
  19. data_graf-0.1.0.dev0/src/datagraf/sqlite.py +134 -0
  20. data_graf-0.1.0.dev0/tests/conftest.py +75 -0
  21. data_graf-0.1.0.dev0/tests/fixtures/ossie/flights.semantic_model.yaml +197 -0
  22. data_graf-0.1.0.dev0/tests/fixtures/ossie/ossie-schema.json +398 -0
  23. data_graf-0.1.0.dev0/tests/fixtures/ossie/sap_business_partner.semantic_model.yaml +82 -0
  24. data_graf-0.1.0.dev0/tests/fixtures/ossie/tpcds_semantic_model.yaml +612 -0
  25. data_graf-0.1.0.dev0/tests/fixtures/ossie-0.1.1/osi-schema.json +344 -0
  26. data_graf-0.1.0.dev0/tests/fixtures/ossie-0.1.1/tpcds_semantic_model.yaml +578 -0
  27. data_graf-0.1.0.dev0/tests/test_checks_sqlite_cli.py +157 -0
  28. data_graf-0.1.0.dev0/tests/test_model_lineage.py +122 -0
@@ -0,0 +1,223 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ *.lcov
51
+ .hypothesis/
52
+ .pytest_cache/
53
+ cover/
54
+
55
+ # Translations
56
+ *.mo
57
+ *.pot
58
+
59
+ # Django stuff:
60
+ *.log
61
+ local_settings.py
62
+ db.sqlite3
63
+ db.sqlite3-journal
64
+
65
+ # Flask stuff:
66
+ instance/
67
+ .webassets-cache
68
+
69
+ # Scrapy stuff:
70
+ .scrapy
71
+
72
+ # Sphinx documentation
73
+ docs/_build/
74
+
75
+ # PyBuilder
76
+ .pybuilder/
77
+ target/
78
+
79
+ # Jupyter Notebook
80
+ .ipynb_checkpoints
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ # Pipfile.lock
97
+
98
+ # uv
99
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ # uv.lock
103
+
104
+ # poetry
105
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
106
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
107
+ # commonly ignored for libraries.
108
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
109
+ # poetry.lock
110
+ # poetry.toml
111
+
112
+ # pdm
113
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
114
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
115
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
116
+ # pdm.lock
117
+ # pdm.toml
118
+ .pdm-python
119
+ .pdm-build/
120
+
121
+ # pixi
122
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
123
+ # pixi.lock
124
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
125
+ # in the .venv directory. It is recommended not to include this directory in version control.
126
+ .pixi/*
127
+ !.pixi/config.toml
128
+
129
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
130
+ __pypackages__/
131
+
132
+ # Celery stuff
133
+ celerybeat-schedule*
134
+ celerybeat.pid
135
+
136
+ # Redis
137
+ *.rdb
138
+ *.aof
139
+ *.pid
140
+
141
+ # RabbitMQ
142
+ mnesia/
143
+ rabbitmq/
144
+ rabbitmq-data/
145
+
146
+ # ActiveMQ
147
+ activemq-data/
148
+
149
+ # SageMath parsed files
150
+ *.sage.py
151
+
152
+ # Environments
153
+ .env
154
+ .envrc
155
+ .venv
156
+ env/
157
+ venv/
158
+ ENV/
159
+ env.bak/
160
+ venv.bak/
161
+
162
+ # Conda environments
163
+ conda-meta/
164
+
165
+ # Spyder project settings
166
+ .spyderproject
167
+ .spyproject
168
+
169
+ # Rope project settings
170
+ .ropeproject
171
+
172
+ # mkdocs/Zensical documentation
173
+ /site
174
+
175
+ # mypy
176
+ .mypy_cache/
177
+ .dmypy.json
178
+ dmypy.json
179
+
180
+ # Pyre type checker
181
+ .pyre/
182
+
183
+ # pytype static type analyzer
184
+ .pytype/
185
+
186
+ # Cython debug symbols
187
+ cython_debug/
188
+
189
+ # PyCharm
190
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
191
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
192
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
193
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
194
+ # .idea/
195
+
196
+ # Abstra
197
+ # Abstra is an AI-powered process automation framework.
198
+ # Ignore directories containing user credentials, local state, and settings.
199
+ # Learn more at https://abstra.io/docs
200
+ .abstra/
201
+
202
+ # Visual Studio Code
203
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
204
+ # can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
205
+ # and can be added to the global gitignore or merged into this file. However, if you prefer, you
206
+ # could uncomment the following to ignore the entire vscode folder
207
+ # .vscode/
208
+ # Temporary file for partial code execution
209
+ tempCodeRunnerFile.py
210
+
211
+ # Ruff stuff:
212
+ .ruff_cache/
213
+
214
+ # PyPI configuration file
215
+ .pypirc
216
+
217
+ # Marimo
218
+ marimo/_static/
219
+ marimo/_lsp/
220
+ __marimo__/
221
+
222
+ # Streamlit
223
+ .streamlit/secrets.toml
@@ -0,0 +1,32 @@
1
+ # CLAUDE.md
2
+
3
+ data-graph: lineage, checks and profiling for Apache Ossie semantic models. Plan and status: `docs/DEV/plan.md`.
4
+
5
+ ## Commands
6
+
7
+ ```bash
8
+ pip install -e ".[dev]"
9
+ pytest # 44 tests; no network, no LLM; builds its own SQLite database
10
+ dgr validate tests/fixtures/ossie/tpcds_semantic_model.yaml
11
+ ```
12
+
13
+ ## Layout (`src/datagraf/`)
14
+
15
+ - `model.py`: reads 0.1.x (`semantic_model:` list, `dialects`) and 0.3.x (root model, `sql`) into dataclasses.
16
+ - `lineage.py`: `build()` makes a networkx DiGraph with ids `source:`, `column:`, `dataset:`, `field:`, `metric:`.
17
+ Edges point from what is needed to what needs it. References come from sqlglot, by the spec's scoping rules.
18
+ Unresolved references go into `G.graph["problems"]`; they are never guessed. Joins live in `G.graph["joins"]`, not as edges.
19
+ - `checks.py`: the bundled JSON Schema for the document's version, plus reference, join and gap checks.
20
+ - `export.py`: zinet `graph.yaml` (sources and columns are primitives, the model is the one application), or JSON.
21
+ - `sqlite.py`: `draft()` from a catalogue, `profile()` of the data, through dd-db (`SQLiteDB(path, read_only=True)`,
22
+ i.e. `mode=ro` + `PRAGMA query_only`). Uses only `BaseDB` methods, so other dd-db adapters can follow.
23
+ - `cli.py`: the `dgr` click group. Exit 0 ok, 1 model errors, 2 usage.
24
+
25
+ ## Rules
26
+
27
+ - Reuse the dd-* stack (dd-db, dd-llm via GraphLang, dd-config, dd-logging) rather than writing a local version; if a dd
28
+ package lacks something, add it there.
29
+ - No LLM calls in the library. LLM work will be GraphLang recipes (see the plan), as in app-graph.
30
+ - Databases are only ever opened read-only. Quote identifiers with `sqlite.q()`.
31
+ - `from __future__ import annotations` in every module.
32
+ - Fixtures under `tests/fixtures/` are verbatim copies from apache/ossie (see NOTICE); don't edit them.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,10 @@
1
+ data-graph
2
+ Copyright 2026 digital-duck
3
+
4
+ This product includes files from Apache Ossie (incubating), https://github.com/apache/ossie,
5
+ licensed under the Apache License, Version 2.0:
6
+
7
+ src/datagraf/schemas/ossie-0.3.0.dev0.schema.json core-spec/ossie-schema.json at main d4dca4e9f81c (2026-11-22)
8
+ src/datagraf/schemas/osi-0.1.1.schema.json core-spec/osi-schema.json at tag osi-0.1.1-rc1
9
+ tests/fixtures/ossie/* examples/ and core-spec/ at main d4dca4e9f81c
10
+ tests/fixtures/ossie-0.1.1/* examples/ and core-spec/ at tag osi-0.1.1-rc1
@@ -0,0 +1,86 @@
1
+ Metadata-Version: 2.5
2
+ Name: data-graf
3
+ Version: 0.1.0.dev0
4
+ Summary: Lineage, checks and profiling for semantic layers written in Apache Ossie
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ License-File: NOTICE
8
+ Requires-Python: >=3.11
9
+ Requires-Dist: click>=8.1
10
+ Requires-Dist: dd-db>=0.1.3
11
+ Requires-Dist: jsonschema>=4.20
12
+ Requires-Dist: networkx>=3.0
13
+ Requires-Dist: pyyaml>=6.0
14
+ Requires-Dist: sqlglot>=25
15
+ Requires-Dist: zinet>=0.2.2
16
+ Provides-Extra: dev
17
+ Requires-Dist: pytest>=8; extra == 'dev'
18
+ Description-Content-Type: text/markdown
19
+
20
+ # data-graph
21
+
22
+ Lineage, checks and profiling for semantic layers written in [Apache Ossie](https://ossie.apache.org/) (incubating;
23
+ formerly Open Semantic Interchange). An Ossie model names the datasets, fields, metrics and joins of a business's data;
24
+ data-graph turns one into a graph and answers questions about it:
25
+
26
+ - **lineage:** what a metric is made of, down to source columns;
27
+ - **impact:** which metrics a change to a column, field or dataset touches;
28
+ - **checks:** unknown references, joins to undeclared datasets or fields, metrics over datasets with no join path, gaps;
29
+ - **profiling:** read-only, against the data behind the model;
30
+ - **drawing and export:** through [zinet](https://github.com/digital-duck/zinet).
31
+
32
+ It is part of the digital-duck family: zinet for the graph format and drawing, dd-db for database access, [GraphLang](https://github.com/digital-duck/graflang)
33
+ for the LLM steps (planned), beside app-graph, work-graph and concept-book. Prototype: version 0.1.0.dev0. See
34
+ [docs/DEV/plan.md](docs/DEV/plan.md) for the design and what comes next.
35
+
36
+ ## Install
37
+
38
+ ```bash
39
+ pip install data-graf # once published; Python 3.11+
40
+ pip install -e ".[dev]" # from source; registers `dgr`
41
+ pytest
42
+ ```
43
+
44
+ Names: the repository is `data-graph`; the PyPI package is `data-graf`, the import is `datagraf` and the command is `dgr`.
45
+ `datagraph` is already the import and command name of an unrelated package on PyPI (`datagraph-core`), and "graf"
46
+ matches GraphLang's `graf`.
47
+
48
+ ## Use
49
+
50
+ ```bash
51
+ dgr validate model.yaml # JSON Schema for its Ossie version, then references and gaps (exit 1 on an error)
52
+ dgr show model.yaml # datasets, fields, metrics, joins
53
+ dgr lineage model.yaml total_sales # upstream, to source columns
54
+ dgr impact model.yaml store_sales.ss_ext_sales_price # downstream: the metrics it feeds
55
+ dgr check model.yaml # references and gaps, without the schema
56
+ dgr export model.yaml --format zinet -o lineage.graph.yaml # or --format json
57
+ dgr render model.yaml -o lineage.html # or --format mermaid / ascii / svg / png
58
+ dgr draft --sqlite shop.db -o shop.semantic_model.yaml # a skeleton from a SQLite catalogue
59
+ dgr profile model.yaml --sqlite shop.db # rows, nulls, distinct, ranges, metric values
60
+ ```
61
+
62
+ A name is a metric (`total_sales`), a dataset-scoped metric or field (`store_sales.total_quantity`), a dataset, or a node
63
+ id (`column:tpcds.public.store_sales.ss_quantity`).
64
+
65
+ Both Ossie shapes are read: the released 0.1.1 (`semantic_model:` list, `dialects` expressions) and the 0.3.0 draft
66
+ (one model at the root, `sql` expressions). Each is checked against its own bundled schema.
67
+
68
+ `examples/chinook.semantic_model.yaml` is the Chinook sample database (the one
69
+ [data-copilot](https://github.com/digital-duck/data-copilot) used) as a finished model: drafted with `dgr draft`,
70
+ then given descriptions, synonyms and metrics by hand.
71
+
72
+ ## From Python
73
+
74
+ ```python
75
+ import datagraf as dg
76
+
77
+ model = dg.load("tpcds_semantic_model.yaml")
78
+ G = dg.build(model) # networkx DiGraph: source -> column -> field -> metric
79
+ up = dg.upstream(G, dg.resolve(G, "customer_lifetime_value"))
80
+ problems = dg.model_problems(model, G)
81
+ ```
82
+
83
+ ## License
84
+
85
+ Apache-2.0. The Ossie schemas in `src/datagraf/schemas/` and the example models in `tests/fixtures/` come from
86
+ [apache/ossie](https://github.com/apache/ossie), also Apache-2.0; see [NOTICE](NOTICE).
@@ -0,0 +1,67 @@
1
+ # data-graph
2
+
3
+ Lineage, checks and profiling for semantic layers written in [Apache Ossie](https://ossie.apache.org/) (incubating;
4
+ formerly Open Semantic Interchange). An Ossie model names the datasets, fields, metrics and joins of a business's data;
5
+ data-graph turns one into a graph and answers questions about it:
6
+
7
+ - **lineage:** what a metric is made of, down to source columns;
8
+ - **impact:** which metrics a change to a column, field or dataset touches;
9
+ - **checks:** unknown references, joins to undeclared datasets or fields, metrics over datasets with no join path, gaps;
10
+ - **profiling:** read-only, against the data behind the model;
11
+ - **drawing and export:** through [zinet](https://github.com/digital-duck/zinet).
12
+
13
+ It is part of the digital-duck family: zinet for the graph format and drawing, dd-db for database access, [GraphLang](https://github.com/digital-duck/graflang)
14
+ for the LLM steps (planned), beside app-graph, work-graph and concept-book. Prototype: version 0.1.0.dev0. See
15
+ [docs/DEV/plan.md](docs/DEV/plan.md) for the design and what comes next.
16
+
17
+ ## Install
18
+
19
+ ```bash
20
+ pip install data-graf # once published; Python 3.11+
21
+ pip install -e ".[dev]" # from source; registers `dgr`
22
+ pytest
23
+ ```
24
+
25
+ Names: the repository is `data-graph`; the PyPI package is `data-graf`, the import is `datagraf` and the command is `dgr`.
26
+ `datagraph` is already the import and command name of an unrelated package on PyPI (`datagraph-core`), and "graf"
27
+ matches GraphLang's `graf`.
28
+
29
+ ## Use
30
+
31
+ ```bash
32
+ dgr validate model.yaml # JSON Schema for its Ossie version, then references and gaps (exit 1 on an error)
33
+ dgr show model.yaml # datasets, fields, metrics, joins
34
+ dgr lineage model.yaml total_sales # upstream, to source columns
35
+ dgr impact model.yaml store_sales.ss_ext_sales_price # downstream: the metrics it feeds
36
+ dgr check model.yaml # references and gaps, without the schema
37
+ dgr export model.yaml --format zinet -o lineage.graph.yaml # or --format json
38
+ dgr render model.yaml -o lineage.html # or --format mermaid / ascii / svg / png
39
+ dgr draft --sqlite shop.db -o shop.semantic_model.yaml # a skeleton from a SQLite catalogue
40
+ dgr profile model.yaml --sqlite shop.db # rows, nulls, distinct, ranges, metric values
41
+ ```
42
+
43
+ A name is a metric (`total_sales`), a dataset-scoped metric or field (`store_sales.total_quantity`), a dataset, or a node
44
+ id (`column:tpcds.public.store_sales.ss_quantity`).
45
+
46
+ Both Ossie shapes are read: the released 0.1.1 (`semantic_model:` list, `dialects` expressions) and the 0.3.0 draft
47
+ (one model at the root, `sql` expressions). Each is checked against its own bundled schema.
48
+
49
+ `examples/chinook.semantic_model.yaml` is the Chinook sample database (the one
50
+ [data-copilot](https://github.com/digital-duck/data-copilot) used) as a finished model: drafted with `dgr draft`,
51
+ then given descriptions, synonyms and metrics by hand.
52
+
53
+ ## From Python
54
+
55
+ ```python
56
+ import datagraf as dg
57
+
58
+ model = dg.load("tpcds_semantic_model.yaml")
59
+ G = dg.build(model) # networkx DiGraph: source -> column -> field -> metric
60
+ up = dg.upstream(G, dg.resolve(G, "customer_lifetime_value"))
61
+ problems = dg.model_problems(model, G)
62
+ ```
63
+
64
+ ## License
65
+
66
+ Apache-2.0. The Ossie schemas in `src/datagraf/schemas/` and the example models in `tests/fixtures/` come from
67
+ [apache/ossie](https://github.com/apache/ossie), also Apache-2.0; see [NOTICE](NOTICE).