datamasque-cli 1.0.0__tar.gz

datamasque_cli-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  lint:
+    name: Lint (ruff)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --frozen
+
+      - name: ruff check
+        run: uv run ruff check src tests
+
+      - name: ruff format --check
+        run: uv run ruff format --check src tests
+
+  typecheck:
+    name: Typecheck (mypy)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --frozen
+
+      - name: mypy
+        run: uv run mypy src
+
+  test:
+    name: Tests (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --frozen --python ${{ matrix.python-version }}
+
+      - name: pytest
+        run: >-
+          uv run --python ${{ matrix.python-version }}
+          pytest tests/
+          --junitxml=report.xml
+          --import-mode=importlib
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-py${{ matrix.python-version }}
+          path: report.xml
+          retention-days: 7

datamasque_cli-1.0.0/.github/workflows/release-testpypi.yml

@@ -0,0 +1,60 @@
+name: Release (TestPyPI)
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build sdist and wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Show package version
+        run: |
+          VERSION="$(uv run python -c 'import tomllib; print(tomllib.loads(open("pyproject.toml","rb").read().decode())["project"]["version"])')"
+          echo "Publishing version: ${VERSION}"
+          echo "::notice title=TestPyPI version::${VERSION}"
+
+      - name: Build
+        run: uv build
+
+      - name: Validate distributions
+        run: uvx twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-testpypi
+          path: dist/
+          retention-days: 7
+
+  publish:
+    name: Publish to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/datamasque-cli
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist-testpypi
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

datamasque_cli-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build:
+    name: Build sdist and wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Verify tag matches package version
+        run: |
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+          PKG_VERSION="$(uv run python -c 'import tomllib,sys; print(tomllib.loads(open("pyproject.toml","rb").read().decode())["project"]["version"])')"
+          echo "Tag version:     ${TAG_VERSION}"
+          echo "Package version: ${PKG_VERSION}"
+          if [ "${TAG_VERSION}" != "${PKG_VERSION}" ]; then
+            echo "::error::Tag ${GITHUB_REF_NAME} does not match pyproject.toml version ${PKG_VERSION}"
+            exit 1
+          fi
+
+      - name: Build
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 7
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/datamasque-cli
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

datamasque_cli-1.0.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+*.egg
+datamasque-logs.tar.gz

datamasque_cli-1.0.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v1.0.0
+
+Initial release.

datamasque_cli-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,231 @@
+# Contributing
+
+Thanks for your interest in contributing to `datamasque-cli`!
+Contributions, bug reports, and feature requests are all welcome.
+
+## Reporting bugs
+
+File an issue on the
+[GitHub issue tracker](https://github.com/datamasque/datamasque-cli/issues).
+Please include:
+
+- the version of `datamasque-cli` you're using (`dm --version` or `pip show datamasque-cli`);
+- the Python version and operating system;
+- the command you ran (with credentials and other sensitive arguments redacted);
+- the full output, including any traceback.
+
+If the bug concerns a specific DataMasque server API response,
+include the status code and (with any sensitive fields redacted) the response body.
+
+## Feature requests
+
+Open an issue describing what you'd like to do and why.
+We're particularly interested in feedback on:
+
+- command and flag naming;
+- output formats (human-readable tables vs. `--json`);
+- coverage gaps where you've had to fall back to `curl` or the Python client;
+- ergonomics for CI / scripted use.
+
+## Development setup
+
+The project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+Install dependencies and set up a virtual environment:
+
+```console
+git clone https://github.com/datamasque/datamasque-cli.git
+cd datamasque-cli
+uv sync
+```
+
+Then either activate the venv (`source .venv/bin/activate`)
+or prefix commands with `uv run`.
+
+## Running the tests
+
+```console
+make test
+```
+
+Unit tests run entirely against mocked clients,
+so no DataMasque server is required.
+
+### Integration tests
+
+`tests/integration/` hits a real DataMasque instance to catch the bugs unit tests can't —
+ruleset namespace collisions,
+delete targeting,
+server-state resolution,
+and the full `run start → retry → logs --follow` lifecycle.
+They're excluded from `make test` and run only when you opt in.
+
+Point them at a DataMasque you own
+(your local dev instance, a throwaway VM — never a shared/prod instance)
+via env vars:
+
+```console
+export DM_TEST_URL=https://localhost
+export DM_TEST_USERNAME=admin
+export DM_TEST_PASSWORD=secret
+make test-integration
+```
+
+Or skip the typing and source credentials from your active `dm` profile:
+
+```console
+make test-integration-local
+```
+
+Tests create rulesets and connections with uuid-suffixed names (`dm_int_<hex>`)
+and delete them in teardown;
+a crashed run may leave stragglers,
+which `dm rulesets list | grep dm_int_` and `dm connections list | grep dm_int_` will surface.
+
+The run-lifecycle tests need a working file-source and file-destination connection on the instance.
+By default they auto-detect the first `MountedShare` pair
+(preferring it over S3/Azure for speed).
+Override with `DM_TEST_SOURCE_CONN` / `DM_TEST_DESTINATION_CONN` env vars
+if auto-detection picks the wrong ones.
+Tests skip cleanly if no pair is available.
+
+Run the integration suite before opening an MR that touches server interactions
+(`commands/`, `client.py`).
+
+## Linting and type-checking
+
+```console
+make lint     # ruff check
+make format   # ruff format + import sorting
+make mypy     # strict mypy on src/
+make check    # all of the above plus tests
+```
+
+`mypy` runs in strict mode with `disallow_untyped_defs`.
+
+## Code style
+
+- **Line length:**
+  120 characters.
+  Enforced by `ruff format`.
+- **Comments and docstrings:**
+  use [semantic line breaks](https://sembr.org/) —
+  break at clause boundaries, not column widths.
+  This applies to text files (such as this one) as well as Python source.
+- **Comment content:**
+  default to writing no comments;
+  add one only when the *why* is non-obvious
+  (a hidden constraint, a workaround, a subtle invariant).
+  Don't restate what well-named code already says.
+- **Spelling:**
+  British English in docs and comments,
+  matching the rest of the DataMasque codebase.
+- **Typing:**
+  new-style generics (`list[str]`, `dict[str, int]`),
+  not `List` / `Dict`.
+- **Imports:**
+
+  - All imports at the top of the file; no inline imports.
+  - Absolute imports only; relative imports are not used.
+
+- **Formatting:**
+  run `make format` before committing.
+
+## DataMasque conventions
+
+A few project-specific conventions on top of the generic style above:
+
+- **Function naming:**
+  verb-phrase form (`execute_ruleset`, `validate_username`),
+  not `ruleset_executor()`.
+- **Boolean naming:**
+  prefix with a modal verb — `is_`, `has_`, `can_`, `will_`, `was_` —
+  e.g. `is_expired`, `has_validation_errors`, `can_retry`.
+- **Acronym casing:**
+  follow normal casing rules; `HttpClient`, not `HTTPClient`.
+  The brand `DataMasque` is always spelled out in full.
+- **No `hasattr` / `getattr` / `setattr`:**
+  these bypass type checking and hide bugs until runtime.
+  If you reach for them, the typing probably needs reshaping —
+  a protocol, a union, or a dataclass.
+- **No conditional imports:**
+  always import at module top.
+  `TYPE_CHECKING` is the only exception, for typing-only imports.
+- **Dataclasses over dicts:**
+  use a `@dataclass` (or Pydantic model) when the shape is fixed.
+  Reserve `dict` for genuinely dynamic key-value data.
+
+## Pull requests
+
+1. Fork the repository and create a feature branch.
+2. Add tests for any behavioural change.
+3. Run `make check` locally before opening the PR.
+4. Keep commits focused; one logical change per commit is easier to review.
+5. Open a PR against `main` and describe what the change does and why.
+6. The maintainers will review and either merge, request changes, or close with an explanation.
+
+## Commit messages
+
+Use [Conventional Commits](https://www.conventionalcommits.org/) format where practical:
+`feat: add dm run retry command`,
+`fix: handle 401 retry for multipart uploads`,
+`docs: clarify connections update semantics`,
+and so on.
+
+## Releasing
+
+Releases are published automatically by CI when a version tag is pushed.
+
+```console
+make release-patch   # 0.1.0 → 0.1.1 — bug fixes
+make release-minor   # 0.1.0 → 0.2.0 — new features
+make release-major   # 0.1.0 → 1.0.0 — breaking changes
+```
+
+Each target runs `make check`,
+bumps the version in `pyproject.toml`,
+refreshes `uv.lock`,
+commits, tags, and pushes.
+CI handles the publish.
+
+To publish manually without bumping:
+
+```console
+make publish
+```
+
+## Toolchain
+
+| Tool                                        | Purpose                          |
+|---------------------------------------------|----------------------------------|
+| [uv](https://docs.astral.sh/uv/)            | Package manager                  |
+| [ruff](https://docs.astral.sh/ruff/)        | Linting + formatting             |
+| [mypy](https://mypy-lang.org/)              | Type checking (strict mode)      |
+| [pytest](https://pytest.org/)               | Testing                          |
+| [Typer](https://typer.tiangolo.com/)        | CLI framework                    |
+
+## Project structure
+
+```
+src/datamasque_cli/
+    main.py             # Typer app entry point
+    client.py           # Authenticated client factory
+    config.py           # Profile management (~/.config/datamasque-cli/)
+    output.py           # JSON / rich table output formatting
+    commands/
+        auth.py         # login, logout, status, profiles
+        connections.py  # list, get, create, delete
+        rulesets.py     # list, get, create, delete, generate, validate
+        ruleset_libraries.py  # list, get, create, delete, usage
+        runs.py         # start, status, list, logs, cancel, wait
+        users.py        # list, create, reset-password
+        discovery.py    # schema, sdd-report, db-report, file-report
+        seeds.py        # list, upload, delete
+        files.py        # list, upload (Snowflake keys, Oracle wallets)
+        system.py       # health, licence, logs, admin-install
+```
+
+## License
+
+By contributing,
+you agree that your contributions will be licensed under the Apache License 2.0,
+the same license as the rest of the project.

datamasque_cli-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 DataMasque Ltd
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.