datamasque-python
Official Python client for the DataMasque 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. This package is a thin Python wrapper around the DataMasque server’s HTTP API, covering connection management, ruleset and ruleset-library CRUD, masking run lifecycle, discovery results, user administration, and license management.
Installation
pip install datamasque-pythonPython 3.9 or newer is required.
Quickstart
from datamasque.client import DataMasqueClient
from datamasque.client.models.dm_instance import DataMasqueInstanceConfig
config = DataMasqueInstanceConfig(
base_url="https://datamasque.example.com",
username="api_user",
password="api_password",
)
client = DataMasqueClient(config)
client.authenticate()
for connection in client.list_connections():
print(connection.name)Authentication is performed on the first request if authenticate() is not called explicitly, and is automatically retried once on a 401 response. client.healthcheck() is available as a lightweight readiness probe that does not consume credentials.
For a DataMasque instance hosted on Snowpark Container Services (SPCS) (a *.snowflakecomputing.app base_url), pass a Snowflake Programmatic Access Token as spcs_pat on DataMasqueInstanceConfig. See the usage docs for details.
Error handling
All methods raise subclasses of DataMasqueException on failure:
DataMasqueApiError — the server responded with a non-2xx status (excluding 502). The triggering Response is available on the .response attribute.
DataMasqueNotReadyError — the server responded with 502, typically because it is still starting up.
DataMasqueTransportError — the request failed before any response was received (connection refused, timeout, DNS failure, SSL handshake failure, etc.).
FailedToStartError / InvalidRulesetError / InvalidLibraryError — raised by start_masking_run when the server rejects the run.
DataMasqueUserError — raised by user-management methods when the input is invalid.
Documentation
All classes and functions have docstrings and type hints.
Compiled docs are hosted at Read the Docs: datamasque-python.
Documentation for the DataMasque product, including a full API reference, can be found on the DataMasque portal.
Contributing
See CONTRIBUTING.rst for development setup, testing, and the pull request flow.
License
Apache License 2.0. See LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for datamasque-python 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| datamasque_python-1.3.0.tar.gz | 210.9 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| datamasque_python-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 288.7 kB
Release files / datamasque_python-1.3.0.tar.gz
| Download URL | datamasque_python-1.3.0.tar.gz |
|---|---|
| Size | 210.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3c834bc624f76f5b1e242e03e4a6b297b608c7cdbb3bf1c8fe3beffe34a6f57e
|
|
BLAKE2b-256 checksum How to use checksums |
b56870c4148bf8ad4c310f91040fb03043796485c53ba6153d58e4923acdaa7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / datamasque_python-1.3.0-py3-none-any.whl
| Download URL | datamasque_python-1.3.0-py3-none-any.whl |
|---|---|
| Size | 77.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b236175d7bceb431a875d70a1c026111d763a290e0a57f39e31fcd8e50134978
|
|
BLAKE2b-256 checksum How to use checksums |
25c77bba9d4566d997a9cf16a8222ed89699047c791c58a5da40a4f5899282d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logSecurity for datamasque-python 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for datamasque_python-1.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
