entropy-data 0.3.20__tar.gz → 0.3.22__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 (96) hide show
  1. entropy_data-0.3.22/.github/dependabot.yml +18 -0
  2. {entropy_data-0.3.20 → entropy_data-0.3.22}/.github/workflows/ci.yaml +2 -2
  3. entropy_data-0.3.22/.github/workflows/dependabot-auto-merge.yaml +33 -0
  4. {entropy_data-0.3.20 → entropy_data-0.3.22}/.github/workflows/release.yaml +2 -2
  5. {entropy_data-0.3.20 → entropy_data-0.3.22}/.pre-commit-config.yaml +1 -1
  6. {entropy_data-0.3.20 → entropy_data-0.3.22}/CHANGELOG.md +12 -0
  7. entropy_data-0.3.22/Dockerfile +20 -0
  8. {entropy_data-0.3.20 → entropy_data-0.3.22}/PKG-INFO +16 -5
  9. {entropy_data-0.3.20 → entropy_data-0.3.22}/README.md +13 -2
  10. {entropy_data-0.3.20 → entropy_data-0.3.22}/pyproject.toml +10 -3
  11. entropy_data-0.3.22/src/entropy_data/commands/datacontract_branches.py +264 -0
  12. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/datacontracts.py +23 -3
  13. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/settings.py +89 -1
  14. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/test_results.py +36 -2
  15. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/output.py +9 -0
  16. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/resources.py +5 -1
  17. entropy_data-0.3.22/tests/commands/test_datacontract_branches.py +230 -0
  18. entropy_data-0.3.22/tests/commands/test_email_templates.py +102 -0
  19. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_import_export.py +50 -4
  20. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_integrations.py +0 -1
  21. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_semantics.py +1 -3
  22. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_team_roles.py +1 -4
  23. entropy_data-0.3.22/tests/commands/test_test_results.py +76 -0
  24. entropy_data-0.3.22/tests/conftest.py +28 -0
  25. entropy_data-0.3.20/.github/dependabot.yml +0 -6
  26. entropy_data-0.3.20/Dockerfile +0 -15
  27. entropy_data-0.3.20/tests/conftest.py +0 -10
  28. {entropy_data-0.3.20 → entropy_data-0.3.22}/.dockerignore +0 -0
  29. {entropy_data-0.3.20 → entropy_data-0.3.22}/.editorconfig +0 -0
  30. {entropy_data-0.3.20 → entropy_data-0.3.22}/.github/pull_request_template.md +0 -0
  31. {entropy_data-0.3.20 → entropy_data-0.3.22}/.gitignore +0 -0
  32. {entropy_data-0.3.20 → entropy_data-0.3.22}/CLAUDE.md +0 -0
  33. {entropy_data-0.3.20 → entropy_data-0.3.22}/LICENSE +0 -0
  34. {entropy_data-0.3.20 → entropy_data-0.3.22}/docs/apply-command-plan.md +0 -0
  35. {entropy_data-0.3.20 → entropy_data-0.3.22}/release +0 -0
  36. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/__init__.py +0 -0
  37. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/__main__.py +0 -0
  38. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/cli.py +0 -0
  39. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/client.py +0 -0
  40. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/__init__.py +0 -0
  41. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/access.py +0 -0
  42. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/api_keys.py +0 -0
  43. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/assets.py +0 -0
  44. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/certifications.py +0 -0
  45. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/classifications.py +0 -0
  46. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/connection.py +0 -0
  47. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/connectors.py +0 -0
  48. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/costs.py +0 -0
  49. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/dataproducts.py +0 -0
  50. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/definitions.py +0 -0
  51. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/events.py +0 -0
  52. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/example_data.py +0 -0
  53. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/git_credentials.py +0 -0
  54. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/gitconnections.py +0 -0
  55. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/import_export.py +0 -0
  56. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/integrations.py +0 -0
  57. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/lineage.py +0 -0
  58. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/notification_channels.py +0 -0
  59. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/organization.py +0 -0
  60. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/policies.py +0 -0
  61. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/schemas.py +0 -0
  62. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/search.py +0 -0
  63. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/semantics.py +0 -0
  64. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/sourcesystems.py +0 -0
  65. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/sync.py +0 -0
  66. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/tags.py +0 -0
  67. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/teams.py +0 -0
  68. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/commands/usage.py +0 -0
  69. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/config.py +0 -0
  70. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/sync.py +0 -0
  71. {entropy_data-0.3.20 → entropy_data-0.3.22}/src/entropy_data/util.py +0 -0
  72. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/__init__.py +0 -0
  73. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/__init__.py +0 -0
  74. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_access_request.py +0 -0
  75. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_api_keys.py +0 -0
  76. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_assets.py +0 -0
  77. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_classifications.py +0 -0
  78. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_connection.py +0 -0
  79. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_connectors.py +0 -0
  80. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_costs.py +0 -0
  81. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_datacontracts.py +0 -0
  82. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_dataproducts.py +0 -0
  83. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_git_credentials.py +0 -0
  84. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_gitconnections.py +0 -0
  85. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_lineage.py +0 -0
  86. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_notification_channels.py +0 -0
  87. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_organization.py +0 -0
  88. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_policies.py +0 -0
  89. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_schemas.py +0 -0
  90. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_settings.py +0 -0
  91. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_tags.py +0 -0
  92. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_teams.py +0 -0
  93. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/commands/test_usage.py +0 -0
  94. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/test_cli.py +0 -0
  95. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/test_client.py +0 -0
  96. {entropy_data-0.3.20 → entropy_data-0.3.22}/tests/test_config.py +0 -0
@@ -0,0 +1,18 @@
1
+ version: 2
2
+ updates:
3
+ - package-ecosystem: "pip"
4
+ directory: "/"
5
+ schedule:
6
+ interval: "weekly"
7
+ - package-ecosystem: "github-actions"
8
+ directory: "/"
9
+ schedule:
10
+ interval: "weekly"
11
+ - package-ecosystem: "docker"
12
+ directory: "/"
13
+ schedule:
14
+ interval: "weekly"
15
+ - package-ecosystem: "pre-commit"
16
+ directory: "/"
17
+ schedule:
18
+ interval: "weekly"
@@ -26,7 +26,7 @@ jobs:
26
26
  - uses: actions/checkout@v7
27
27
  - name: Install uv
28
28
  # setup-uv no longer publishes floating major tags, so pin the exact version.
29
- uses: astral-sh/setup-uv@v9.0.0
29
+ uses: astral-sh/setup-uv@v10.0.1
30
30
  with:
31
31
  python-version: ${{ matrix.python-version }}
32
32
  - name: Install the project
@@ -46,7 +46,7 @@ jobs:
46
46
  steps:
47
47
  - uses: actions/checkout@v7
48
48
  - name: Install uv
49
- uses: astral-sh/setup-uv@v9.0.0
49
+ uses: astral-sh/setup-uv@v10.0.1
50
50
  with:
51
51
  python-version: ${{ matrix.python-version }}
52
52
  - name: Install the project
@@ -0,0 +1,33 @@
1
+ # Auto-merge Dependabot PRs that only touch development dependencies — the
2
+ # `[project.optional-dependencies] dev` extra (pytest, responses, ruff,
3
+ # pre-commit). Production dependencies and GitHub Actions bumps are always
4
+ # reported as `direct:production` by fetch-metadata, so they stay manual.
5
+ on: pull_request_target
6
+
7
+ # pull_request_target is required because the GITHUB_TOKEN is read-only on
8
+ # `pull_request` runs from Dependabot. This workflow never checks out or
9
+ # executes the PR's code, so the elevated token is not exposed to it.
10
+ permissions:
11
+ contents: write # enable auto-merge on the PR
12
+ pull-requests: write
13
+
14
+ name: Dependabot auto-merge
15
+ jobs:
16
+ auto-merge:
17
+ runs-on: ubuntu-latest
18
+ if: github.actor == 'dependabot[bot]'
19
+ steps:
20
+ - name: Fetch Dependabot metadata
21
+ id: metadata
22
+ uses: dependabot/fetch-metadata@v3
23
+ with:
24
+ github-token: ${{ secrets.GITHUB_TOKEN }}
25
+
26
+ # For grouped PRs, dependency-type reports the highest type present, so a
27
+ # group mixing dev and production dependencies does not match here.
28
+ - name: Enable auto-merge
29
+ if: steps.metadata.outputs.dependency-type == 'direct:development'
30
+ run: gh pr merge --auto --squash "$PR_URL"
31
+ env:
32
+ PR_URL: ${{ github.event.pull_request.html_url }}
33
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -66,7 +66,7 @@ jobs:
66
66
  with:
67
67
  fetch-depth: 0
68
68
  - name: Install uv
69
- uses: astral-sh/setup-uv@v9.0.0
69
+ uses: astral-sh/setup-uv@v10.0.1
70
70
  with:
71
71
  python-version: "3.12"
72
72
  - name: Build package
@@ -120,7 +120,7 @@ jobs:
120
120
  name: python-package-distributions
121
121
  path: dist/
122
122
  - name: Sign the dists with Sigstore
123
- uses: sigstore/gh-action-sigstore-python@v3.4.0
123
+ uses: sigstore/gh-action-sigstore-python@v3.5.0
124
124
  with:
125
125
  inputs: >-
126
126
  ./dist/*.tar.gz
@@ -1,6 +1,6 @@
1
1
  repos:
2
2
  - repo: https://github.com/astral-sh/ruff-pre-commit
3
- rev: v0.15.22
3
+ rev: v0.16.6
4
4
  hooks:
5
5
  - id: ruff
6
6
  args: [ --fix ]
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.3.22]
4
+
5
+ - Add `entropy-data settings email-templates get|put` to manage the organization's email templates as one document: every email type with its enabled state and the effective subject and body per language, each marked as built-in or customized. `put` replaces the whole setup — omitted types and languages revert to the built-in email, and wording identical to the built-in text stays uncustomized, so a `get` written back unchanged customizes nothing. Requires `GET`/`PUT /api/settings/email-templates` on the instance (entropy-data#1705).
6
+ - `export`, `apply`, `import`, and `sync` handle `email-templates` as an organization-level singleton, applied before `organization-features`.
7
+ - Add `entropy-data datacontracts branches` to work on branches of a data contract: `list`, `create`, `get`, `put` (replace the branch's ODCS document from a file), `yaml`, `changes` (what the branch changes against main, element by element), `rebase`, `merge` and `delete`. `merge` takes `--version` for the version the data contract lands with (main's own version keeps it), `--route land|pull_request` to land here or open a pull/merge request from the branch where the data contract's git branch allows either, and `--update-ports` to set the landed version on the implementing output ports as well. Requires branches on the instance (entropy-data#1697).
8
+ - `datacontracts test`, `datacontracts yaml` and `datacontracts generate` take `--branch` to run against a branch of the data contract instead of the data contract itself.
9
+ - `test-results publish` takes `--data-contract-id` and `--branch` to publish the results onto a branch of the data contract; `test-results list --branch` narrows to the runs on one branch.
10
+
11
+ ## [0.3.21]
12
+
13
+ - The published Docker image now runs on Python 3.14 (`python:3.14-slim`), up from 3.12. The CLI itself is unchanged — 3.14 has been in the CI test matrix since 0.3.20 — and installs from PyPI are unaffected, which still support 3.11 and newer.
14
+
3
15
  ## [0.3.20]
4
16
 
5
17
  - Support Python 3.14, now covered by the CI test matrix alongside 3.11, 3.12, and 3.13.
@@ -0,0 +1,20 @@
1
+ # Named stage rather than an inline `COPY --from=ghcr.io/astral-sh/uv:...`:
2
+ # Dependabot's Docker parser only reads FROM lines, so an inline image
3
+ # reference is never updated.
4
+ FROM ghcr.io/astral-sh/uv:0.12.13 AS uv
5
+
6
+ FROM python:3.14-slim
7
+
8
+ ENV PYTHONUNBUFFERED=1
9
+ ENV UV_COMPILE_BYTECODE=1
10
+
11
+ COPY --from=uv /uv /uvx /bin/
12
+
13
+ COPY pyproject.toml uv.lock README.md /app/
14
+ COPY src/ /app/src/
15
+
16
+ RUN cd /app && uv pip --no-cache-dir install --system .
17
+
18
+ WORKDIR /home/entropy-data
19
+
20
+ ENTRYPOINT ["entropy-data"]
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.4
1
+ Metadata-Version: 2.5
2
2
  Name: entropy-data
3
- Version: 0.3.20
3
+ Version: 0.3.22
4
4
  Summary: CLI for Entropy Data
5
5
  Project-URL: Homepage, https://entropy-data.com
6
6
  Project-URL: Documentation, https://docs.entropy-data.com
@@ -28,7 +28,7 @@ Provides-Extra: dev
28
28
  Requires-Dist: pre-commit>=3.7; extra == 'dev'
29
29
  Requires-Dist: pytest>=9.0.3; extra == 'dev'
30
30
  Requires-Dist: responses>=0.25; extra == 'dev'
31
- Requires-Dist: ruff<0.16,>=0.8; extra == 'dev'
31
+ Requires-Dist: ruff<0.17,>=0.8; extra == 'dev'
32
32
  Description-Content-Type: text/markdown
33
33
 
34
34
  # Entropy Data CLI
@@ -106,11 +106,21 @@ entropy-data teams put marketing --file team.yaml
106
106
  entropy-data settings team-roles get
107
107
  entropy-data settings team-roles put --file team-roles.yaml
108
108
 
109
+ # Dump the email templates, edit the wording, and write them back
110
+ entropy-data settings email-templates get --output yaml > email-templates.yaml
111
+ entropy-data settings email-templates put --file email-templates.yaml
112
+
109
113
  # Approve an access agreement
110
114
  entropy-data access approve 640864de-83d4-4619-afba-ccea8037ed3a
111
115
 
112
116
  # Search across all resources
113
117
  entropy-data search query "customer orders"
118
+
119
+ # Draft a change to a data contract on a branch, test it, and land it
120
+ entropy-data datacontracts branches create orders add-status
121
+ entropy-data datacontracts branches put orders add-status --file orders.yaml
122
+ entropy-data datacontracts test orders --branch add-status
123
+ entropy-data datacontracts branches merge orders add-status --version 1.1.0
114
124
  ```
115
125
 
116
126
  ## Commands
@@ -121,6 +131,7 @@ entropy-data [--version] [--connection NAME] [--output table|json|yaml] [--debug
121
131
  connection list | get | add | remove | set-default | test
122
132
  dataproducts list | get | put | delete | import-from-git | star | unstar | star-status | stargazers | gitconnection ...
123
133
  datacontracts list | get | put | test | delete | yaml | generate | import-from-git | gitconnection ...
134
+ branches list | create | get | put | yaml | changes | rebase | merge | delete
124
135
  access list | get | put | delete | approve | reject | cancel | request
125
136
  teams list | get | put | delete | git-credentials ... | notifications ...
126
137
  sourcesystems list | get | put | delete
@@ -137,7 +148,7 @@ entropy-data [--version] [--connection NAME] [--output table|json|yaml] [--debug
137
148
  connectors list | get | put | delete
138
149
  integrations list | get | runs | runs-get | runs-latest | run | cancel
139
150
  organization get | members ... | git-credentials ...
140
- settings get-customization | put-customization | get-scim-mapping | put-scim-mapping | team-roles ...
151
+ settings get-customization | put-customization | get-scim-mapping | put-scim-mapping | team-roles ... | email-templates ...
141
152
  events poll
142
153
  lineage list | submit | delete
143
154
  schemas get
@@ -164,7 +175,7 @@ idempotent PUT-by-id, so runs converge and are safe to repeat.
164
175
  **Supported resources** (in dependency order): `teams`, `tags`, `definitions`, `policies`,
165
176
  `sourcesystems`, `certifications`, `classification-schemes`, `assets`, `datacontracts`,
166
177
  `dataproducts`, `example-data`, `access`, `semantic-namespaces`, `semantic-ontology`,
167
- `organization-features`.
178
+ `email-templates`, `organization-features`.
168
179
 
169
180
  **Not synced:** users & team members, API keys, git credentials, integration and connector
170
181
  credentials, usage, costs, test results, events, and lineage (per-instance identity,
@@ -73,11 +73,21 @@ entropy-data teams put marketing --file team.yaml
73
73
  entropy-data settings team-roles get
74
74
  entropy-data settings team-roles put --file team-roles.yaml
75
75
 
76
+ # Dump the email templates, edit the wording, and write them back
77
+ entropy-data settings email-templates get --output yaml > email-templates.yaml
78
+ entropy-data settings email-templates put --file email-templates.yaml
79
+
76
80
  # Approve an access agreement
77
81
  entropy-data access approve 640864de-83d4-4619-afba-ccea8037ed3a
78
82
 
79
83
  # Search across all resources
80
84
  entropy-data search query "customer orders"
85
+
86
+ # Draft a change to a data contract on a branch, test it, and land it
87
+ entropy-data datacontracts branches create orders add-status
88
+ entropy-data datacontracts branches put orders add-status --file orders.yaml
89
+ entropy-data datacontracts test orders --branch add-status
90
+ entropy-data datacontracts branches merge orders add-status --version 1.1.0
81
91
  ```
82
92
 
83
93
  ## Commands
@@ -88,6 +98,7 @@ entropy-data [--version] [--connection NAME] [--output table|json|yaml] [--debug
88
98
  connection list | get | add | remove | set-default | test
89
99
  dataproducts list | get | put | delete | import-from-git | star | unstar | star-status | stargazers | gitconnection ...
90
100
  datacontracts list | get | put | test | delete | yaml | generate | import-from-git | gitconnection ...
101
+ branches list | create | get | put | yaml | changes | rebase | merge | delete
91
102
  access list | get | put | delete | approve | reject | cancel | request
92
103
  teams list | get | put | delete | git-credentials ... | notifications ...
93
104
  sourcesystems list | get | put | delete
@@ -104,7 +115,7 @@ entropy-data [--version] [--connection NAME] [--output table|json|yaml] [--debug
104
115
  connectors list | get | put | delete
105
116
  integrations list | get | runs | runs-get | runs-latest | run | cancel
106
117
  organization get | members ... | git-credentials ...
107
- settings get-customization | put-customization | get-scim-mapping | put-scim-mapping | team-roles ...
118
+ settings get-customization | put-customization | get-scim-mapping | put-scim-mapping | team-roles ... | email-templates ...
108
119
  events poll
109
120
  lineage list | submit | delete
110
121
  schemas get
@@ -131,7 +142,7 @@ idempotent PUT-by-id, so runs converge and are safe to repeat.
131
142
  **Supported resources** (in dependency order): `teams`, `tags`, `definitions`, `policies`,
132
143
  `sourcesystems`, `certifications`, `classification-schemes`, `assets`, `datacontracts`,
133
144
  `dataproducts`, `example-data`, `access`, `semantic-namespaces`, `semantic-ontology`,
134
- `organization-features`.
145
+ `email-templates`, `organization-features`.
135
146
 
136
147
  **Not synced:** users & team members, API keys, git credentials, integration and connector
137
148
  credentials, usage, costs, test results, events, and lineage (per-instance identity,
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "entropy-data"
3
- version = "0.3.20"
3
+ version = "0.3.22"
4
4
  description = "CLI for Entropy Data"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.11"
@@ -49,8 +49,10 @@ entropy-data = "entropy_data.cli:app"
49
49
  dev = [
50
50
  "pytest>=9.0.3",
51
51
  "responses>=0.25",
52
- # 0.16 changes the default lint rule set and the formatter style; adopting it is a separate migration.
53
- "ruff>=0.8,<0.16",
52
+ # 0.16 is allowed: its formatter style is applied to the tree, and the
53
+ # lint rules it would otherwise widen are stated explicitly under
54
+ # [tool.ruff.lint].
55
+ "ruff>=0.8,<0.17",
54
56
  "pre-commit>=3.7",
55
57
  ]
56
58
 
@@ -65,6 +67,11 @@ packages = ["src/entropy_data"]
65
67
  line-length = 120
66
68
 
67
69
  [tool.ruff.lint]
70
+ # Ruff's own defaults through 0.15, stated explicitly: 0.16 widens the default
71
+ # rule set, and inheriting that silently would turn a routine version bump into
72
+ # a 410-finding cleanup. Adopting the wider set is a deliberate change to make
73
+ # here, not a side effect of upgrading.
74
+ select = ["E4", "E7", "E9", "F"]
68
75
  extend-select = ["I"]
69
76
 
70
77
  [tool.pytest.ini_options]
@@ -0,0 +1,264 @@
1
+ """Branches of a data contract: cut, author, review and merge a draft of an ODCS document."""
2
+
3
+ import sys
4
+ from pathlib import Path
5
+ from typing import Annotated, Optional
6
+
7
+ import typer
8
+
9
+ from entropy_data.output import OutputFormat, print_data, print_resource, print_resource_list, print_success
10
+
11
+ branches_app = typer.Typer(no_args_is_help=True)
12
+ RESOURCE_TYPE = "datacontract-branches"
13
+ CHANGES_TYPE = "datacontract-branch-changes"
14
+ MERGE_ROUTES = ("land", "pull_request")
15
+
16
+ ID_HELP = "Data contract ID."
17
+ BRANCH_HELP = "Branch name."
18
+
19
+
20
+ def branches_path(data_contract_id: str) -> str:
21
+ from entropy_data.client import _validate_resource_id
22
+
23
+ _validate_resource_id(data_contract_id)
24
+ return f"datacontracts/{data_contract_id}/branches"
25
+
26
+
27
+ def branch_path(data_contract_id: str, branch: str) -> str:
28
+ from entropy_data.client import _validate_resource_id
29
+
30
+ _validate_resource_id(branch)
31
+ return f"{branches_path(data_contract_id)}/{branch}"
32
+
33
+
34
+ def read_text(file: Path) -> str:
35
+ """The document as written, byte for byte: the branch keeps the author's formatting."""
36
+ if str(file) == "-":
37
+ return sys.stdin.read()
38
+ return file.read_text()
39
+
40
+
41
+ @branches_app.command("list")
42
+ def list_branches(
43
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
44
+ output: Annotated[Optional[OutputFormat], typer.Option("--output", "-o", help="Output format.")] = None,
45
+ ) -> None:
46
+ """List the branches of a data contract."""
47
+ from entropy_data.cli import get_client, get_output_format, handle_error
48
+
49
+ fmt = output or get_output_format()
50
+ try:
51
+ client = get_client()
52
+ data, _ = client.list_resources(branches_path(id))
53
+ print_resource_list(data, RESOURCE_TYPE, fmt, title=f"Branches of {id}")
54
+ except Exception as e:
55
+ handle_error(e)
56
+
57
+
58
+ @branches_app.command("create")
59
+ def create_branch(
60
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
61
+ branch: Annotated[str, typer.Argument(help=BRANCH_HELP)],
62
+ output: Annotated[Optional[OutputFormat], typer.Option("--output", "-o", help="Output format.")] = None,
63
+ ) -> None:
64
+ """Cut a branch from a data contract. The branch starts as a copy of the data contract."""
65
+ from entropy_data.cli import get_client, get_output_format, handle_error
66
+ from entropy_data.client import REQUEST_TIMEOUT, _raise_for_status
67
+
68
+ fmt = output or get_output_format()
69
+ try:
70
+ client = get_client()
71
+ response = client.session.put(f"{client.base_url}/api/{branch_path(id, branch)}", timeout=REQUEST_TIMEOUT)
72
+ _raise_for_status(response)
73
+ if fmt == OutputFormat.table:
74
+ print_success(f"Branch '{branch}' of data contract '{id}' created.")
75
+ print_resource(response.json(), RESOURCE_TYPE, fmt)
76
+ except Exception as e:
77
+ handle_error(e)
78
+
79
+
80
+ @branches_app.command("get")
81
+ def get_branch(
82
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
83
+ branch: Annotated[str, typer.Argument(help=BRANCH_HELP)],
84
+ output: Annotated[Optional[OutputFormat], typer.Option("--output", "-o", help="Output format.")] = None,
85
+ ) -> None:
86
+ """Show a branch: its version against main, what it changes, and whether it conflicts."""
87
+ from entropy_data.cli import get_client, get_output_format, handle_error
88
+
89
+ fmt = output or get_output_format()
90
+ try:
91
+ client = get_client()
92
+ data = client.get_resource(branches_path(id), branch)
93
+ print_resource(data, RESOURCE_TYPE, fmt)
94
+ except Exception as e:
95
+ handle_error(e)
96
+
97
+
98
+ @branches_app.command("delete")
99
+ def delete_branch(
100
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
101
+ branch: Annotated[str, typer.Argument(help=BRANCH_HELP)],
102
+ ) -> None:
103
+ """Delete a branch and everything authored on it. The data contract is untouched."""
104
+ from entropy_data.cli import get_client, handle_error
105
+
106
+ try:
107
+ client = get_client()
108
+ client.delete_resource(branches_path(id), branch)
109
+ print_success(f"Branch '{branch}' of data contract '{id}' deleted.")
110
+ except Exception as e:
111
+ handle_error(e)
112
+
113
+
114
+ @branches_app.command("yaml")
115
+ def yaml_branch(
116
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
117
+ branch: Annotated[str, typer.Argument(help=BRANCH_HELP)],
118
+ out_file: Annotated[
119
+ Optional[Path],
120
+ typer.Option("--file", "-f", help="Write YAML to this file. Defaults to stdout."),
121
+ ] = None,
122
+ ) -> None:
123
+ """Get the branch's document as ODCS YAML."""
124
+ from entropy_data.cli import get_client, handle_error
125
+ from entropy_data.client import REQUEST_TIMEOUT, _raise_for_status
126
+
127
+ try:
128
+ client = get_client()
129
+ response = client.session.get(
130
+ f"{client.base_url}/api/{branch_path(id, branch)}/datacontract.yaml",
131
+ headers={"Accept": "application/yaml"},
132
+ timeout=REQUEST_TIMEOUT,
133
+ )
134
+ _raise_for_status(response)
135
+ if out_file is not None:
136
+ out_file.write_text(response.text)
137
+ print_success(f"Branch '{branch}' of data contract '{id}' written to {out_file}.")
138
+ else:
139
+ print(response.text)
140
+ except Exception as e:
141
+ handle_error(e)
142
+
143
+
144
+ @branches_app.command("put")
145
+ def put_branch(
146
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
147
+ branch: Annotated[str, typer.Argument(help=BRANCH_HELP)],
148
+ file: Annotated[Path, typer.Option("--file", "-f", help="ODCS YAML file (use - for stdin).")] = ...,
149
+ ) -> None:
150
+ """Replace the branch's document with an ODCS YAML file. The data contract itself is untouched."""
151
+ from entropy_data.cli import get_client, handle_error
152
+ from entropy_data.client import REQUEST_TIMEOUT, _raise_for_status
153
+
154
+ try:
155
+ content = read_text(file)
156
+ client = get_client()
157
+ response = client.session.put(
158
+ f"{client.base_url}/api/{branch_path(id, branch)}/datacontract.yaml",
159
+ data=content.encode("utf-8"),
160
+ headers={"Content-Type": "application/yaml"},
161
+ timeout=REQUEST_TIMEOUT,
162
+ )
163
+ _raise_for_status(response)
164
+ print_success(f"Branch '{branch}' of data contract '{id}' updated.")
165
+ except Exception as e:
166
+ handle_error(e)
167
+
168
+
169
+ @branches_app.command("changes")
170
+ def changes_of_branch(
171
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
172
+ branch: Annotated[str, typer.Argument(help=BRANCH_HELP)],
173
+ output: Annotated[Optional[OutputFormat], typer.Option("--output", "-o", help="Output format.")] = None,
174
+ ) -> None:
175
+ """List what the branch changes against the data contract, element by element."""
176
+ from entropy_data.cli import get_client, get_output_format, handle_error
177
+
178
+ fmt = output or get_output_format()
179
+ try:
180
+ client = get_client()
181
+ data, _ = client.list_resources(f"{branch_path(id, branch)}/changes")
182
+ print_resource_list(data, CHANGES_TYPE, fmt, title=f"Changes on {branch}")
183
+ except Exception as e:
184
+ handle_error(e)
185
+
186
+
187
+ @branches_app.command("rebase")
188
+ def rebase_branch(
189
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
190
+ branch: Annotated[str, typer.Argument(help=BRANCH_HELP)],
191
+ output: Annotated[Optional[OutputFormat], typer.Option("--output", "-o", help="Output format.")] = None,
192
+ ) -> None:
193
+ """Update the branch from the data contract. Conflicts are reported and resolved in the UI."""
194
+ from entropy_data.cli import get_client, get_output_format, handle_error
195
+
196
+ fmt = output or get_output_format()
197
+ try:
198
+ client = get_client()
199
+ data = client.post_action_json(branches_path(id), branch, "rebase")
200
+ if fmt == OutputFormat.table:
201
+ print_success(f"Branch '{branch}' updated from data contract '{id}'.")
202
+ print_resource(data, RESOURCE_TYPE, fmt)
203
+ except Exception as e:
204
+ handle_error(e)
205
+
206
+
207
+ @branches_app.command("merge")
208
+ def merge_branch(
209
+ id: Annotated[str, typer.Argument(help=ID_HELP)],
210
+ branch: Annotated[str, typer.Argument(help=BRANCH_HELP)],
211
+ version: Annotated[
212
+ Optional[str],
213
+ typer.Option(
214
+ "--version",
215
+ help="The version the data contract lands with. Needed when the branch's own version is not above main's; pass main's version to keep it.",
216
+ ),
217
+ ] = None,
218
+ route: Annotated[
219
+ Optional[str],
220
+ typer.Option(
221
+ "--route",
222
+ help=f"One of: {', '.join(MERGE_ROUTES)}. Defaults to what the data contract's git branch requires.",
223
+ ),
224
+ ] = None,
225
+ update_ports: Annotated[
226
+ bool,
227
+ typer.Option(
228
+ "--update-ports/--no-update-ports",
229
+ help="Set the landed version on the output ports that implement the data contract. Off by default: the ports belong to other data products.",
230
+ ),
231
+ ] = False,
232
+ output: Annotated[Optional[OutputFormat], typer.Option("--output", "-o", help="Output format.")] = None,
233
+ ) -> None:
234
+ """Merge the branch: land it on the data contract, or open a pull request from it."""
235
+ from entropy_data.cli import get_client, get_output_format, handle_error
236
+ from entropy_data.client import REQUEST_TIMEOUT, _raise_for_status
237
+
238
+ if route is not None and route not in MERGE_ROUTES:
239
+ raise typer.BadParameter(f"Must be one of: {', '.join(MERGE_ROUTES)}", param_hint="--route")
240
+
241
+ fmt = output or get_output_format()
242
+ body: dict = {"update_port_versions": update_ports}
243
+ if version:
244
+ body["version"] = version
245
+ if route:
246
+ body["route"] = route
247
+ try:
248
+ client = get_client()
249
+ response = client.session.post(
250
+ f"{client.base_url}/api/{branch_path(id, branch)}/merge", json=body, timeout=REQUEST_TIMEOUT
251
+ )
252
+ _raise_for_status(response)
253
+ if response.status_code == 204:
254
+ print_success(f"Branch '{branch}' merged into data contract '{id}'.")
255
+ return
256
+ # 200: the branch stays open, a pull/merge request was opened from it.
257
+ data = response.json()
258
+ if fmt == OutputFormat.table:
259
+ print_success(f"Request opened for branch '{branch}'. The branch stays open.")
260
+ print_data(data, OutputFormat.json)
261
+ else:
262
+ print_data(data, fmt)
263
+ except Exception as e:
264
+ handle_error(e)
@@ -11,6 +11,17 @@ from entropy_data.util import read_body
11
11
  datacontracts_app = typer.Typer(no_args_is_help=True)
12
12
  RESOURCE_PATH = "datacontracts"
13
13
  RESOURCE_TYPE = "datacontracts"
14
+ BRANCH_HELP = "Work on this branch of the data contract instead of the data contract itself."
15
+
16
+
17
+ def _branch_action(branch: Optional[str], action: str) -> str:
18
+ """The action path, under the branch where one is named."""
19
+ if branch is None:
20
+ return action
21
+ from entropy_data.client import _validate_resource_id
22
+
23
+ _validate_resource_id(branch)
24
+ return f"branches/{branch}/{action}"
14
25
 
15
26
 
16
27
  @datacontracts_app.command("list")
@@ -82,6 +93,7 @@ def put_datacontract(
82
93
  def test_datacontract(
83
94
  id: Annotated[str, typer.Argument(help="Data contract ID.")],
84
95
  server: Annotated[Optional[str], typer.Option("--server", "-s", help="Server name to test against.")] = None,
96
+ branch: Annotated[Optional[str], typer.Option("--branch", "-b", help=BRANCH_HELP)] = None,
85
97
  ) -> None:
86
98
  """Run a data contract test."""
87
99
  import json
@@ -94,7 +106,7 @@ def test_datacontract(
94
106
  if server:
95
107
  params["server"] = server
96
108
  # Data contract tests can take a long time (up to 30 minutes)
97
- data = client.post_action_json(RESOURCE_PATH, id, "test", params=params, timeout=1800)
109
+ data = client.post_action_json(RESOURCE_PATH, id, _branch_action(branch, "test"), params=params, timeout=1800)
98
110
  print(json.dumps(data, indent=2))
99
111
  except Exception as e:
100
112
  handle_error(e)
@@ -133,6 +145,7 @@ def yaml_datacontract(
133
145
  Optional[Path],
134
146
  typer.Option("--file", "-f", help="Write YAML to this file. Defaults to stdout."),
135
147
  ] = None,
148
+ branch: Annotated[Optional[str], typer.Option("--branch", "-b", help=BRANCH_HELP)] = None,
136
149
  ) -> None:
137
150
  """Get a data contract as ODCS YAML."""
138
151
  from entropy_data.cli import get_client, handle_error
@@ -142,7 +155,7 @@ def yaml_datacontract(
142
155
  client = get_client()
143
156
  _validate_resource_id(id)
144
157
  response = client.session.get(
145
- f"{client.base_url}/api/datacontracts/{id}/datacontract.yaml",
158
+ f"{client.base_url}/api/datacontracts/{id}/{_branch_action(branch, 'datacontract.yaml')}",
146
159
  headers={"Accept": "application/yaml"},
147
160
  timeout=REQUEST_TIMEOUT,
148
161
  )
@@ -178,6 +191,7 @@ def generate_datacontract(
178
191
  help="Directory to write each generated file into. If omitted, prints the JSON response.",
179
192
  ),
180
193
  ] = None,
194
+ branch: Annotated[Optional[str], typer.Option("--branch", "-b", help=BRANCH_HELP)] = None,
181
195
  ) -> None:
182
196
  """Generate code artifacts from an ODCS data contract."""
183
197
  import json
@@ -199,7 +213,7 @@ def generate_datacontract(
199
213
  try:
200
214
  client = get_client()
201
215
  # Generation may invoke an LLM for `custom`, so allow extra time.
202
- data = client.post_action_json(RESOURCE_PATH, id, "generate", body=body, timeout=300)
216
+ data = client.post_action_json(RESOURCE_PATH, id, _branch_action(branch, "generate"), body=body, timeout=300)
203
217
  if out_dir is None:
204
218
  print(json.dumps(data, indent=2))
205
219
  return
@@ -296,6 +310,7 @@ def _build_git_import_body(
296
310
  return body
297
311
 
298
312
 
313
+ from entropy_data.commands.datacontract_branches import branches_app # noqa: E402
299
314
  from entropy_data.commands.gitconnections import make_gitconnection_app # noqa: E402
300
315
 
301
316
  datacontracts_app.add_typer(
@@ -303,3 +318,8 @@ datacontracts_app.add_typer(
303
318
  name="gitconnection",
304
319
  help="Manage the git connection.",
305
320
  )
321
+ datacontracts_app.add_typer(
322
+ branches_app,
323
+ name="branches",
324
+ help="Branches of a data contract: cut, author, review and merge a draft.",
325
+ )