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.

Project links

Data verified by PyPI on Jul 29, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.2.3)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for datamasque from gravatar.com datamasque

Credits

Author: DataMasque Ltd

GitHub Statistics

Data verified by PyPI on Jul 29, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.9

Tags

api-client data-masking data-privacy datamasque synthetic-data test-data

Classifiers

Report project as malware

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.2.1.tar.gz (203.2 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.2.1-py3-none-any.whl (76.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for datamasque_python-1.2.1.tar.gz
Algorithm Hash digest
SHA256 b45f314f99d72745869f597f891a05a5178d22882fad81cbeadff1942a7d4fc3
MD5 09ff90b456a7f19c3ef68a7fd34708f7
BLAKE2b-256 583b10a09a5055ed19168ec7721e5c7b9393197e7ece7c12e3b9210929e1f060

See more details on using hashes here.

Provenance

The following attestation bundles were made for datamasque_python-1.2.1.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.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for datamasque_python-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 228f0375e3855484627a95e16e6b979ad80ccd498fdc15b35f52efe142c4b663
MD5 a40d4c8ee702b51ea58e61059e5aaba4
BLAKE2b-256 f019ddf1e7e92c77471f4ea8b0b3d667b38c0e6d0709e36a300553890dd9d0e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for datamasque_python-1.2.1-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