art30-emit 0.1.0__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.
- art30_emit-0.1.0/.gitignore +223 -0
- art30_emit-0.1.0/CHANGELOG.md +39 -0
- art30_emit-0.1.0/CONTRIBUTING.md +55 -0
- art30_emit-0.1.0/LICENSE +201 -0
- art30_emit-0.1.0/PKG-INFO +141 -0
- art30_emit-0.1.0/README.md +117 -0
- art30_emit-0.1.0/SECURITY.md +42 -0
- art30_emit-0.1.0/examples/nightly-export/README.md +49 -0
- art30_emit-0.1.0/examples/nightly-export/consent_state.csv +5 -0
- art30_emit-0.1.0/examples/nightly-export/export.py +66 -0
- art30_emit-0.1.0/examples/nightly-export/qedro.yaml +30 -0
- art30_emit-0.1.0/examples/nightly-export/transcript.md +176 -0
- art30_emit-0.1.0/pyproject.toml +71 -0
- art30_emit-0.1.0/src/art30_emit/__init__.py +41 -0
- art30_emit-0.1.0/src/art30_emit/__main__.py +159 -0
- art30_emit-0.1.0/src/art30_emit/emit.py +241 -0
- art30_emit-0.1.0/tests/conftest.py +27 -0
- art30_emit-0.1.0/tests/test_cli.py +91 -0
- art30_emit-0.1.0/tests/test_emit.py +161 -0
- art30_emit-0.1.0/tools/capture_example.py +140 -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
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
# Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
# uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
# poetry.lock
|
|
109
|
+
# poetry.toml
|
|
110
|
+
|
|
111
|
+
# pdm
|
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
113
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
114
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
115
|
+
# pdm.lock
|
|
116
|
+
# pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# pixi
|
|
121
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
122
|
+
# pixi.lock
|
|
123
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
124
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
125
|
+
.pixi
|
|
126
|
+
|
|
127
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
128
|
+
__pypackages__/
|
|
129
|
+
|
|
130
|
+
# Celery stuff
|
|
131
|
+
celerybeat-schedule
|
|
132
|
+
celerybeat.pid
|
|
133
|
+
|
|
134
|
+
# Redis
|
|
135
|
+
*.rdb
|
|
136
|
+
*.aof
|
|
137
|
+
*.pid
|
|
138
|
+
|
|
139
|
+
# RabbitMQ
|
|
140
|
+
mnesia/
|
|
141
|
+
rabbitmq/
|
|
142
|
+
rabbitmq-data/
|
|
143
|
+
|
|
144
|
+
# ActiveMQ
|
|
145
|
+
activemq-data/
|
|
146
|
+
|
|
147
|
+
# SageMath parsed files
|
|
148
|
+
*.sage.py
|
|
149
|
+
|
|
150
|
+
# Environments
|
|
151
|
+
.env
|
|
152
|
+
.envrc
|
|
153
|
+
.venv
|
|
154
|
+
env/
|
|
155
|
+
venv/
|
|
156
|
+
ENV/
|
|
157
|
+
env.bak/
|
|
158
|
+
venv.bak/
|
|
159
|
+
|
|
160
|
+
# Spyder project settings
|
|
161
|
+
.spyderproject
|
|
162
|
+
.spyproject
|
|
163
|
+
|
|
164
|
+
# Rope project settings
|
|
165
|
+
.ropeproject
|
|
166
|
+
|
|
167
|
+
# mkdocs documentation
|
|
168
|
+
/site
|
|
169
|
+
|
|
170
|
+
# mypy
|
|
171
|
+
.mypy_cache/
|
|
172
|
+
.dmypy.json
|
|
173
|
+
dmypy.json
|
|
174
|
+
|
|
175
|
+
# Pyre type checker
|
|
176
|
+
.pyre/
|
|
177
|
+
|
|
178
|
+
# pytype static type analyzer
|
|
179
|
+
.pytype/
|
|
180
|
+
|
|
181
|
+
# Cython debug symbols
|
|
182
|
+
cython_debug/
|
|
183
|
+
|
|
184
|
+
# PyCharm
|
|
185
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
186
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
187
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
188
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
189
|
+
# .idea/
|
|
190
|
+
|
|
191
|
+
# Abstra
|
|
192
|
+
# Abstra is an AI-powered process automation framework.
|
|
193
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
194
|
+
# Learn more at https://abstra.io/docs
|
|
195
|
+
.abstra/
|
|
196
|
+
|
|
197
|
+
# Visual Studio Code
|
|
198
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
199
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
200
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
201
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
202
|
+
# .vscode/
|
|
203
|
+
# Temporary file for partial code execution
|
|
204
|
+
tempCodeRunnerFile.py
|
|
205
|
+
|
|
206
|
+
# Ruff stuff:
|
|
207
|
+
.ruff_cache/
|
|
208
|
+
|
|
209
|
+
# PyPI configuration file
|
|
210
|
+
.pypirc
|
|
211
|
+
|
|
212
|
+
# Marimo
|
|
213
|
+
marimo/_static/
|
|
214
|
+
marimo/_lsp/
|
|
215
|
+
__marimo__/
|
|
216
|
+
|
|
217
|
+
# Streamlit
|
|
218
|
+
.streamlit/secrets.toml
|
|
219
|
+
|
|
220
|
+
# The worked example generates these; `transcript.md` is the committed record of
|
|
221
|
+
# what a run produced, and `tools/capture_example.py --check` keeps it honest.
|
|
222
|
+
examples/nightly-export/events.jsonl
|
|
223
|
+
examples/nightly-export/nightly.csv
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
Notable changes, in the words of somebody deciding whether to upgrade.
|
|
4
|
+
|
|
5
|
+
`0.x` may change interfaces between releases. The one part that will not move
|
|
6
|
+
without a major version is what goes on the wire: the `processing` facet's key and
|
|
7
|
+
schema URL, and the use of the standard `tags` dataset facet for classification,
|
|
8
|
+
because a consumer's record depends on both.
|
|
9
|
+
|
|
10
|
+
## 0.1.0 — 2026-09-26
|
|
11
|
+
|
|
12
|
+
The first version, and the whole of it: put the Art. 30 facet on the wire from code
|
|
13
|
+
no OpenLineage integration can reach.
|
|
14
|
+
|
|
15
|
+
- **`declare(...)` as a context manager**, emitting `START` on entry and `COMPLETE`
|
|
16
|
+
on exit. An exception emits `FAIL` with the message and stack trace in the standard
|
|
17
|
+
`errorMessage` run facet, then propagates unchanged — a record of what happened must
|
|
18
|
+
not change what happens.
|
|
19
|
+
- **`art30-emit … -- <command>` as a wrapper**, for the work an import cannot reach:
|
|
20
|
+
a stored procedure behind a shell script, an SSIS step, a binary compiled in 2014.
|
|
21
|
+
The command's exit status is forwarded, and a non-zero one emits `FAIL` rather than
|
|
22
|
+
`COMPLETE`.
|
|
23
|
+
- **`purpose` and `legal_basis` in the published `processing` facet**, under the
|
|
24
|
+
schema generated in `cordata-tech/qedro` from a governance model. This is the second
|
|
25
|
+
implementation of that schema rather than a second definition of it.
|
|
26
|
+
- **Classification on the standard `tags` dataset facet** (spec 1-0-0), per dataset,
|
|
27
|
+
with `source: USER` — because somebody wrote it down by hand, which is the
|
|
28
|
+
distinction a record carries through to its output. That is what lets Art. 30(1)(c),
|
|
29
|
+
(e) and (f) be reported for systems that could otherwise only be asserted.
|
|
30
|
+
- **A field nobody declared is absent, never empty.** *Nobody said* and *we say it is
|
|
31
|
+
none* are different answers to an auditor, and only the first can be corrected.
|
|
32
|
+
- **Nothing is decided here**: no validation against a compiled list of purposes, no
|
|
33
|
+
legal basis guessed from a job name, no default filling a field nobody declared.
|
|
34
|
+
- **URI namespaces stay whole.** `s3://acme-exports/consent/nightly.csv` is namespace
|
|
35
|
+
`s3://acme-exports` and name `consent/nightly.csv`, in the library and in `--tag`.
|
|
36
|
+
- **A worked example with a captured transcript**, `examples/nightly-export`: a cron
|
|
37
|
+
script wrapped in `declare`, read back by Qedro into a record that earns its
|
|
38
|
+
tombstone. `tools/capture_example.py --check` runs in CI, so the transcript fails
|
|
39
|
+
the build rather than going quietly stale.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
## What this package is for, so a change can be judged against it
|
|
4
|
+
|
|
5
|
+
Two rules decide most questions here, and a change that breaks either needs an
|
|
6
|
+
argument rather than a review.
|
|
7
|
+
|
|
8
|
+
**It emits the published facet, not one of its own.** The `processing` schema is
|
|
9
|
+
generated in [`cordata-tech/qedro`](https://github.com/cordata-tech/qedro) from a
|
|
10
|
+
governance model, and the classification rides on the standard `TagsDatasetFacet`.
|
|
11
|
+
This is the second implementation of that schema rather than a second definition
|
|
12
|
+
of it. A private spelling of either would make the package a vocabulary wearing a
|
|
13
|
+
standard's clothes.
|
|
14
|
+
|
|
15
|
+
**It decides nothing.** No validation against a compiled list of purposes, no
|
|
16
|
+
legal basis inferred from a job name, no default filling a field nobody declared.
|
|
17
|
+
A field the caller did not set is **absent** on the wire, never empty — *nobody
|
|
18
|
+
said* and *we say it is none* are different answers to an auditor, and only the
|
|
19
|
+
first can be corrected later.
|
|
20
|
+
|
|
21
|
+
## Running it
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
uv venv && uv pip install -e ".[dev]"
|
|
25
|
+
.venv/bin/pytest -q
|
|
26
|
+
.venv/bin/ruff check . && .venv/bin/ruff format --check .
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The worked example needs `qedro` as well, and CI checks that its transcript still
|
|
30
|
+
matches what the commands print:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
uv pip install qedro
|
|
34
|
+
python tools/capture_example.py --check
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
If it fails because the output genuinely changed, rerun without `--check` and
|
|
38
|
+
commit the result. The transcript is captured rather than written, so that a
|
|
39
|
+
claim on the front page cannot quietly stop being true.
|
|
40
|
+
|
|
41
|
+
## Releases
|
|
42
|
+
|
|
43
|
+
The version has one source, `art30_emit.__version__`, and `pyproject.toml` reads
|
|
44
|
+
it. Pushing a `v*` tag publishes to PyPI through trusted publishing; the workflow
|
|
45
|
+
fails if the tag disagrees with the version, or if `CHANGELOG.md` has no dated
|
|
46
|
+
entry for it. A tag is a release decision rather than a bookkeeping step.
|
|
47
|
+
|
|
48
|
+
`workflow_dispatch` on the release workflow is a dry run: everything except the
|
|
49
|
+
upload, which is how the workflow gets proved before a tag exists.
|
|
50
|
+
|
|
51
|
+
## Style
|
|
52
|
+
|
|
53
|
+
`ruff check` and `ruff format`, line length 100, Python 3.12 and up. Comments
|
|
54
|
+
explain *why* rather than *what*, and a comment saying why a simpler thing was
|
|
55
|
+
rejected is worth more than one restating the line below it.
|
art30_emit-0.1.0/LICENSE
ADDED
|
@@ -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,141 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: art30-emit
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Emit the OpenLineage Art. 30 processing facet from code that emits nothing today
|
|
5
|
+
Project-URL: Homepage, https://cordata.tech
|
|
6
|
+
Project-URL: Source, https://github.com/cordata-tech/art30-emit
|
|
7
|
+
Project-URL: The facet, https://github.com/cordata-tech/qedro/blob/main/docs/art30-facet.md
|
|
8
|
+
Author-email: Cordata <contact@cordata.tech>
|
|
9
|
+
License-Expression: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: data-lineage,dsgvo,gdpr,governance,openlineage,ropa
|
|
12
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
17
|
+
Classifier: Topic :: Database
|
|
18
|
+
Requires-Python: >=3.12
|
|
19
|
+
Requires-Dist: openlineage-python>=1.20
|
|
20
|
+
Provides-Extra: dev
|
|
21
|
+
Requires-Dist: pytest>=8; extra == 'dev'
|
|
22
|
+
Requires-Dist: ruff>=0.6; extra == 'dev'
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
|
|
25
|
+
# art30-emit
|
|
26
|
+
|
|
27
|
+
[](https://github.com/cordata-tech/art30-emit/actions/workflows/ci.yml)
|
|
28
|
+
[](https://pypi.org/project/art30-emit/)
|
|
29
|
+
[](https://pypi.org/project/art30-emit/)
|
|
30
|
+
[](LICENSE)
|
|
31
|
+
|
|
32
|
+
Put the OpenLineage **Art. 30 processing facet** on the wire from code that emits
|
|
33
|
+
nothing today.
|
|
34
|
+
|
|
35
|
+
dbt, Airflow, Spark and Flink all emit OpenLineage, and none of them emits
|
|
36
|
+
`purpose` or `legal_basis`. Everything else a record of processing activities needs
|
|
37
|
+
— what ran, what it read, what it wrote, when, and in some cases what the data is —
|
|
38
|
+
can be evidenced from what an organisation already runs. Those two fields cannot, so
|
|
39
|
+
they end up asserted in a spreadsheet beside the code and drift from it within a
|
|
40
|
+
quarter.
|
|
41
|
+
|
|
42
|
+
This package emits them from the thing that ran, for the systems nobody instruments:
|
|
43
|
+
a Lambda, a stored procedure behind a shell wrapper, a cron job, a notebook that
|
|
44
|
+
matters more than it should.
|
|
45
|
+
|
|
46
|
+
## Install
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
pip install art30-emit
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
One runtime dependency, `openlineage-python`. Python 3.12 or later.
|
|
53
|
+
|
|
54
|
+
## Use it as a context manager
|
|
55
|
+
|
|
56
|
+
```python
|
|
57
|
+
from art30_emit import declare
|
|
58
|
+
|
|
59
|
+
with declare(
|
|
60
|
+
"acme.crm/consent-sync",
|
|
61
|
+
purpose="customer-administration",
|
|
62
|
+
legal_basis="contract",
|
|
63
|
+
reads=["warehouse/crm_raw.consent_events"],
|
|
64
|
+
writes=["warehouse/crm_curated.consent_state"],
|
|
65
|
+
classify={
|
|
66
|
+
"warehouse/crm_curated.consent_state": {
|
|
67
|
+
"data_category": "contact",
|
|
68
|
+
"subject_type": "customer",
|
|
69
|
+
"residency": "eu",
|
|
70
|
+
"retention": "P7Y",
|
|
71
|
+
}
|
|
72
|
+
},
|
|
73
|
+
):
|
|
74
|
+
sync_consent()
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
`START` is emitted on entry and `COMPLETE` on exit. An exception emits `FAIL` with
|
|
78
|
+
the error message and stack trace, then continues to propagate: a record of what
|
|
79
|
+
happened must not change what happens.
|
|
80
|
+
|
|
81
|
+
## Use it as a command wrapper
|
|
82
|
+
|
|
83
|
+
The wrapper reaches work an import cannot — a stored procedure called from a shell
|
|
84
|
+
script, an SSIS step, a binary somebody compiled in 2014.
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
art30-emit \
|
|
88
|
+
--job acme.billing/monthly-invoices \
|
|
89
|
+
--purpose contract-performance \
|
|
90
|
+
--legal-basis contract \
|
|
91
|
+
--reads warehouse/billing_raw.usage \
|
|
92
|
+
--writes warehouse/billing_curated.invoices \
|
|
93
|
+
--tag warehouse/billing_curated.invoices:data_category=financial \
|
|
94
|
+
--tag warehouse/billing_curated.invoices:subject_type=customer \
|
|
95
|
+
-- ./run-invoicing.sh
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
The command runs unchanged and its exit status is forwarded. A non-zero status emits
|
|
99
|
+
`FAIL` rather than `COMPLETE`, so a record built from these events can tell an
|
|
100
|
+
auditor which runs finished.
|
|
101
|
+
|
|
102
|
+
## Where the events go
|
|
103
|
+
|
|
104
|
+
Wherever the OpenLineage client is configured to send them, through
|
|
105
|
+
`OPENLINEAGE_URL` or `OPENLINEAGE_CONFIG` as that client documents. A transport this
|
|
106
|
+
package invented would be one more thing to trust.
|
|
107
|
+
|
|
108
|
+
For a first run, with neither set, `ART30_EMIT_FILE` appends the events to a file so
|
|
109
|
+
you can read what was produced:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
ART30_EMIT_FILE=events.jsonl art30-emit --job demo/hello --purpose demonstration \
|
|
113
|
+
--legal-basis consent -- echo hello
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Two rules it keeps
|
|
117
|
+
|
|
118
|
+
**It emits the published facet, not one of its own.** The schema is
|
|
119
|
+
[`openlineage-art30-processing-facet.json`](https://github.com/cordata-tech/qedro/blob/main/schemas/openlineage-art30-processing-facet.json),
|
|
120
|
+
generated from a governance model rather than written beside it, and the
|
|
121
|
+
classification rides on the standard `tags` dataset facet (spec 1-0-0) rather than a
|
|
122
|
+
private key. A second spelling of the same fields would be a private vocabulary
|
|
123
|
+
wearing a standard's clothes.
|
|
124
|
+
|
|
125
|
+
**It never decides anything.** No validation against a compiled list of purposes, no
|
|
126
|
+
guessing a legal basis from a job name, no default that fills a field nobody
|
|
127
|
+
declared. What the caller says is what goes on the wire, and what the caller does not
|
|
128
|
+
say is absent — which is the state a record has to be able to report, because *nobody
|
|
129
|
+
said* and *we say it is none* are different answers to an auditor.
|
|
130
|
+
|
|
131
|
+
## What reads it
|
|
132
|
+
|
|
133
|
+
Any governance layer that reads OpenLineage. [Qedro](https://github.com/cordata-tech/qedro)
|
|
134
|
+
turns these events into a GDPR Art. 30 record of processing activities, and
|
|
135
|
+
[`pipeline-runtime`](https://github.com/cordata-tech/pipeline-runtime) emits the same
|
|
136
|
+
facet from pipelines it executes — this is the second implementation of that schema
|
|
137
|
+
rather than a second definition of it.
|
|
138
|
+
|
|
139
|
+
## Licence
|
|
140
|
+
|
|
141
|
+
Apache-2.0.
|