datamasque-cli 1.0.0__py3-none-any.whl

datamasque_cli-1.0.0.dist-info/METADATA

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: datamasque-cli
+Version: 1.0.0
+Summary: Official command-line interface for the DataMasque data-masking platform.
+Project-URL: Homepage, https://datamasque.com/
+Project-URL: Repository, https://github.com/datamasque/datamasque-cli
+Project-URL: Issues, https://github.com/datamasque/datamasque-cli/issues
+Author: DataMasque Ltd
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: datamasque-python<2,>=1.0.0
+Requires-Dist: tomli-w>=1.0.0
+Requires-Dist: typer>=0.15.0
+Description-Content-Type: text/markdown
+
+# DataMasque CLI
+
+Official command-line interface for the
+[DataMasque](https://datamasque.com/) platform.
+
+DataMasque is a data masking platform that replaces sensitive data with realistic but non-production values,
+so teams can use production-shaped data in non-production environments without exposing PII.
+
+DataMasque CLI `dm` covers:
+
+- connections, rulesets, ruleset libraries, and masking runs
+- schema discovery and sensitive-data discovery
+- users, files, and DataMasque instance administration
+
+<p align="center">
+  <img src="assets/demo.gif" width="820" alt="DataMasque CLI demo — running dm version, listing connections, and checking a masking run">
+</p>
+
+## Installation
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
+
+```console
+uv tool install datamasque-cli
+```
+
+This installs `dm` as a command in your terminal.
+
+To run without installing:
+
+```console
+uvx --from datamasque-cli dm
+```
+
+## Quickstart
+
+> [!NOTE]
+> `dm auth login` writes credentials in plain text (mode 600).
+> For shared hosts or any machine you'd rather not leave credentials on disk, [set environmental variables](#configuration) instead.
+>
+> Either way, prefer a `mask_builder` or `mask_runner` role over admin.
+
+```console
+# Save credentials
+dm auth login
+
+# Browse configurations
+dm connections list
+dm rulesets list
+
+# Start a masking run
+dm run start --connection mydb --ruleset myruleset
+
+# Check progress on masking runs
+dm run list --status running
+dm run logs 42 --follow
+```
+
+`dm run start` and `dm run wait` block until the run finishes.
+Pass `--background` to `start` to skip the wait.
+
+## Shell completion
+
+`dm` provides built-in completion for bash, zsh, and fish:
+
+```console
+dm --install-completion
+```
+
+Restart your shell, then `dm run <TAB>` and friends will complete subcommands.
+`dm --show-completion` prints the script without installing it.
+
+## Configuration
+
+To use environmental variables for DataMasque Authentication,
+set `DATAMASQUE_URL`, `DATAMASQUE_USERNAME`, and `DATAMASQUE_PASSWORD`.
+These take precedence over any saved profile for that call.
+
+Otherwise, `dm auth` credentials live in `~/.config/datamasque-cli/config.toml` (mode `0600`).
+
+Manage multiple instances by passing `--profile` to `dm auth login`,
+then `dm auth use <profile>` to switch the default,
+or `--profile <name>` on any command to override per-call.
+
+For instances with self-signed or expired TLS certificates
+(typically a local dev box),
+pass `--insecure` to `dm auth login` to persist the toggle on the profile,
+or set `DATAMASQUE_VERIFY_SSL=false` to skip verification per call.
+
+## Commands
+
+### Authentication
+
+```console
+dm auth login                                   # Interactive — prompts for URL, username, password
+dm auth login --profile staging                 # Save credentials under a named profile
+dm auth login --insecure                        # Skip TLS verification (self-signed / expired cert)
+dm auth status                                  # Show current auth + licence
+dm auth list                                    # List configured profiles
+dm auth use <profile>                           # Switch active profile
+dm auth logout                                  # Remove stored credentials
+```
+
+### Connections
+
+```console
+dm connections list                             # List all connections (includes source/destination role)
+dm connections get <name>                       # Show connection details
+dm connections create --file conn.json          # Create from JSON
+dm connections create --name <n> --type database --db-type postgres \
+    --host <h> --port 5432 --database <d> --user <u> --password <p>
+dm connections test <name>                      # Verify reachability (DB handshake / filesystem / bucket)
+dm connections update <name> --password <new>   # Rotate a field in place, preserving the UUID
+dm connections delete <name>                    # Delete a connection
+```
+
+### Rulesets
+
+```console
+dm rulesets list                                  # List all rulesets
+dm rulesets list --type file                      # Filter by type
+dm rulesets get <name>                            # Show ruleset details
+dm rulesets get <name> --yaml                     # Print raw YAML only
+dm rulesets get <name> --type file                # Disambiguate same-name rulesets
+dm rulesets create --name <n> --file rules.yaml   # Create/update (type auto-detected from YAML)
+dm rulesets create --name <n> --file rules.yaml --type file  # Force a type
+dm rulesets delete <name> [--type file|database]  # Delete a ruleset
+dm rulesets generate --file request.json          # Generate from schema
+dm rulesets generate --file req.json -o out.yaml  # Generate to file
+dm rulesets validate --file rules.yaml            # Validate against server
+dm rulesets export-bundle -o bundle.zip           # Export rulesets + libraries + seeds
+dm rulesets import-bundle --file bundle.zip       # Import a previously exported bundle
+dm rulesets import-bundle -f bundle.zip --overwrite-rulesets --overwrite-libraries  # Replace existing entries
+```
+
+### Ruleset libraries
+
+```console
+dm libraries list                                 # List all libraries
+dm libraries get <name>                           # Show library details
+dm libraries get <name> --yaml                    # Print raw YAML only
+dm libraries create --name <n> --file lib.yaml    # Create/update from file
+dm libraries create --name <n> --file lib.yaml --namespace pii  # With namespace
+dm libraries delete <name>                        # Delete a library
+dm libraries validate <name>                      # Re-validate against current server schema
+dm libraries usage <name>                         # Show rulesets using it
+```
+
+### Masking runs
+
+```console
+dm run start -c <conn> -r <ruleset>                          # Start a run and block until done
+dm run start -c <conn> -r <ruleset> --background             # Start and return immediately
+dm run start -c <conn> -r <ruleset> --options batch_size=1000 --options dry_run=true
+dm run retry <id>                                             # Re-run with the same config as an existing run
+dm run status <id>                                            # Get run status
+dm run list                                                   # List recent runs
+dm run list --status running                                  # Filter by status
+dm run logs <id>                                              # Show execution logs
+dm run logs <id> --follow                                     # Stream logs until terminal state
+dm run cancel <id>                                            # Cancel a running job
+dm run wait <id>                                              # Block until complete
+dm run report <id>                                            # Download the masking run CSV report
+```
+
+### Users
+
+```console
+dm users list                                   # List all users
+dm users create --username <u> --email <e> --role mask_builder
+dm users reset-password <username>              # Reset to temp password
+dm users delete <username>                      # Delete a user
+```
+
+### Discovery
+
+```console
+dm discover schema <connection>                 # Start a schema-discovery run
+dm discover schema-results <run-id>             # List schema-discovery results once the run finishes
+dm discover sdd-report <run-id>                 # Sensitive data discovery report
+dm discover db-report <run-id>                  # Database discovery CSV
+dm discover file-report <run-id>                # File discovery report
+```
+
+### Seeds
+
+```console
+dm seeds list                                   # List all seed files
+dm seeds upload ./my_seeds.csv                  # Upload a seed file
+dm seeds delete my_seeds.csv                    # Delete a seed file
+```
+
+### Files
+
+```console
+dm files list snowflake-key                     # List Snowflake keys
+dm files upload snowflake-key --name mykey -f key.p8  # Upload a file
+dm files delete snowflake-key mykey             # Delete an uploaded file
+```
+
+### System
+
+```console
+dm system health                                # Instance health check
+dm system licence                               # Licence information
+dm system upload-licence ./licence.lic          # Upload a licence file
+dm system logs -o logs.tar.gz                   # Download application logs
+dm system admin-install --email admin@co.com    # Initial admin setup
+dm system set-locality AU                       # Set system locality
+```
+
+## JSON output
+
+Every list / get command supports `--json` for machine-parseable output:
+
+```console
+dm connections list --json | jq '.[].name'
+STATUS=$(dm run status 42 --json | jq -r '.status')
+dm rulesets get myruleset --json | jq -r '.yaml' > ruleset.yaml
+```
+
+## Documentation
+
+Documentation for the DataMasque product,
+including a full API reference,
+can be found on the
+[DataMasque portal](https://portal.datamasque.com/portal/documentation/).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup,
+running tests,
+the release flow,
+and code-style conventions.
+
+## License
+
+Apache License 2.0.
+See [LICENSE](LICENSE).

datamasque_cli-1.0.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+datamasque_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamasque_cli/client.py,sha256=ZMPxRXurtUsXGZB5aPOGP78JYmeQPBSUL42ool2mEPs,3956
+datamasque_cli/config.py,sha256=lxqdKo5StOR1Z5jOSObi2MxD5BUz045hJ6kr_BaX3Hg,2533
+datamasque_cli/main.py,sha256=aDaByGJMGngqix0kACu6EoMNmmyYiEiskbzHrhrHbQM,1386
+datamasque_cli/output.py,sha256=Qx6q8rwctyzC6-gXQHP_I-O3YhonrFhiJhPap5uFGdA,3897
+datamasque_cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamasque_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamasque_cli/commands/auth.py,sha256=LO3BfkaCj6F2doEQ-KHo0GfYy5FyJOVI5ro1xqE6SOc,5234
+datamasque_cli/commands/connections.py,sha256=r8wGDPl_DK5OaNXOh6fuN4aFKzMEMhLHoHmibXHgSdc,11853
+datamasque_cli/commands/discovery.py,sha256=94pnkbb47_PTL22_KvCd_iWpQsVtC9fByfAidGXi2bg,5172
+datamasque_cli/commands/files.py,sha256=EdbJGG7DklMurhFki_A1PEVl7t9g0oqbdOoQMnIFqvg,2833
+datamasque_cli/commands/ruleset_libraries.py,sha256=tKVku8-gmoSsGJP8ViOXmyPoU9ukkYyJ6vbr-mDO9uU,5730
+datamasque_cli/commands/rulesets.py,sha256=Qy_PoLs38lfI_1BBX9jbTrl4_outQGaJ7hLw75J448Y,12182
+datamasque_cli/commands/runs.py,sha256=uJTAGIwR2T-WFg93B6Ff3bIEBQ4IMHeO4RMwKph5Kns,19266
+datamasque_cli/commands/seeds.py,sha256=wh8b92TFWhOyoHdrnM3I3ZJLDQQF3etuQdyCMVxEaUU,1890
+datamasque_cli/commands/system.py,sha256=t1kL6l9ouqh5C3JUPGc9sZVqrl7uJxFbywCbBLECA-0,4605
+datamasque_cli/commands/users.py,sha256=MD-bUzNBSMlXx0eE_e44XCN8KpTwi-GnSwng9uXjfqk,2886
+datamasque_cli-1.0.0.dist-info/METADATA,sha256=jpmv17hLpNc1EFPleYSPvxCN-iGNPpDRCS6l07eMOj8,10354
+datamasque_cli-1.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+datamasque_cli-1.0.0.dist-info/entry_points.txt,sha256=a54ZX2DxL6kuYAv3dAWZfu04SOU6cY9IijB8ymEFrdA,47
+datamasque_cli-1.0.0.dist-info/licenses/LICENSE,sha256=gVLGJV27v5e4tp1G_pB5P6Uk8xQFNa7nGR3i3PUWBfY,11286
+datamasque_cli-1.0.0.dist-info/RECORD,,

datamasque_cli-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

datamasque_cli-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dm = datamasque_cli.main:app

datamasque_cli-1.0.0.dist-info/licenses/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.