Skip to main content

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-python

Python 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

Contributing

See CONTRIBUTING.rst for development setup, testing, and the pull request flow.

License

Apache License 2.0. See LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datamasque_python-1.1.8.tar.gz (197.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

datamasque_python-1.1.8-py3-none-any.whl (71.9 kB view details)

Uploaded Python 3

File details

Details for the file datamasque_python-1.1.8.tar.gz.

File metadata

  • Download URL: datamasque_python-1.1.8.tar.gz
  • Upload date:
  • Size: 197.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for datamasque_python-1.1.8.tar.gz
Algorithm Hash digest
SHA256 44a4ee2f73a088a3a6c3829db6f33b948da911488904bc3f10fb5355bd42fa42
MD5 299248a33b2d36e2a061f1d16d23b465
BLAKE2b-256 4b64bcc8166bdf4b766a15bf29606739c9b80f8901b10a1a30b8ca58f858c55d

See more details on using hashes here.

Provenance

The following attestation bundles were made for datamasque_python-1.1.8.tar.gz:

Publisher: release.yml on datamasque/datamasque-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file datamasque_python-1.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for datamasque_python-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 524a7e44d9ec1095247c6216055a0e028f8b4a550a92dee9458b99acb17eec90
MD5 3b97b6e04dbfc458c5ffda4410d36ef2
BLAKE2b-256 612322377d40728c7c20a9cdb5a53bb6af32cc25075b77b00960bf6058979be5

See more details on using hashes here.

Provenance

The following attestation bundles were made for datamasque_python-1.1.8-py3-none-any.whl:

Publisher: release.yml on datamasque/datamasque-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page