Skip to main content

Python SDK for the Wipe.me encrypted messaging protocol and API

Project description

wipe-me

The official Python SDK for Wipe.me. The synchronized 0.3 alpha supports the same v1 encryption, configurable framing, progress, link, and HTTP operations as the JavaScript and Go SDKs.

python -m pip install --pre wipe-me==0.3.0a1
import time
from wipeme import Client, decrypt, encrypt, generate_message_id, generate_secret

api = Client("https://wipe.me", client_id="sdk-python")
message_id, secret = generate_message_id(), generate_secret()
encrypted = encrypt(message_id, secret, "Private hello", on_progress=print)
created = api.create(
    message_id,
    encrypted.envelope,
    deletion_key=encrypted.deletion_key_header,
    content_hash=encrypted.content_hash,
    expires_at=int(time.time() * 1000) + 24 * 60 * 60 * 1000,
)
download = api.retrieve(message_id)
opened = decrypt(download.body, message_id, secret)

The synchronous client supports create, atomic one-time retrieve, idempotent delete, and health operations. Free anonymous messages are validated at 3 MiB and 14 days. API failures raise APIError with status, stable code, human-readable message, and optional retry_after attributes.

create(..., on_progress=...) and retrieve(..., on_progress=...) expose byte-based upload/download events. Retrieval reads in configurable logical chunks (100 KiB by default); physical network boundaries remain runtime-controlled.

Crypto uses Argon2id, HKDF-SHA-256, and AES-256-GCM through argon2-cffi and PyCA cryptography. The fragment secret remains local and is never sent to the API.

Project details


Download files

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

Source Distribution

wipe_me-0.3.0a1.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

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

wipe_me-0.3.0a1-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file wipe_me-0.3.0a1.tar.gz.

File metadata

  • Download URL: wipe_me-0.3.0a1.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for wipe_me-0.3.0a1.tar.gz
Algorithm Hash digest
SHA256 4b085f616bad606f1b1d95ec5d1e0f7315ab0630e279904dd77b4d02f7d74e82
MD5 d9f88f0fef5b0d49f6ea6efa1a306274
BLAKE2b-256 2d58792503a6c09575ed015459b1698aae00ec6f8bdfef922da862bc8996dfc0

See more details on using hashes here.

File details

Details for the file wipe_me-0.3.0a1-py3-none-any.whl.

File metadata

  • Download URL: wipe_me-0.3.0a1-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for wipe_me-0.3.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 ba3a4ae932f9ad9d74712f611d17be84c80090fe9a18506beb5e45a1bcb8bb52
MD5 a52bc2b5132de59cf62322849efe86cf
BLAKE2b-256 f94c45960b575befceab054aa218d9f330f0b81fbb3394a4ba1257a7f83c77f3

See more details on using hashes here.

Supported by

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