OpenTDF Python SDK
Unofficial OpenTDF SDK for Python
Features
- TDF Encryption/Decryption: Create and decrypt TDF files with policy-based access control
- Flexible Configuration: Support for various authentication methods and platform endpoints
- Comprehensive Testing: Full test suite with unit and integration tests
Legacy Version
A legacy version (0.2.x) of this project is available for users who need the previous implementation. For more information, see LEGACY_VERSION.md or visit the legacy branch on GitHub.
Installation
Install from PyPI:
pip install otdf-python
Quick Start
Basic Configuration
from otdf_python.sdk_builder import SDKBuilder
# Create and configure SDK using builder pattern
builder = SDKBuilder()
builder.set_platform_endpoint("https://platform.example.com")
builder.client_secret("your-client-id", "your-client-secret")
# Build the SDK instance
sdk = builder.build()
Advanced Configuration
from otdf_python.sdk_builder import SDKBuilder
# Create SDK with additional configuration options
builder = SDKBuilder()
builder.set_platform_endpoint("https://platform.example.com")
builder.set_issuer_endpoint("https://auth.example.com")
builder.client_secret("your-client-id", "your-client-secret")
# Examples, for local development
# Use HTTP instead of HTTPS
builder.use_insecure_plaintext_connection(True)
# Or
# Skip TLS verification
builder.use_insecure_skip_verify(True)
# Build the SDK instance
sdk = builder.build()
Encrypt Data
from io import BytesIO
# Create TDF configuration with attributes
config = sdk.new_tdf_config(attributes=["https://example.net/attr/attr1/value/value1"])
# Encrypt data to TDF format
input_data = b"Hello, World!"
output_stream = BytesIO()
manifest, size, _ = sdk.create_tdf(BytesIO(input_data), config, output_stream)
encrypted_data = output_stream.getvalue()
# Save encrypted data to file
with open("encrypted.tdf", "wb") as f:
f.write(encrypted_data)
Decrypt Data
# Read encrypted TDF file
with open("encrypted.tdf", "rb") as f:
encrypted_data = f.read()
# Decrypt TDF
tdf_reader = sdk.load_tdf(encrypted_data)
decrypted_data = tdf_reader.payload
# Save decrypted data
with open("decrypted.txt", "wb") as f:
f.write(decrypted_data)
Project Structure
packages/otdf-python/src/otdf_python/
├── sdk.py # Main SDK interface
├── config.py # Configuration management
├── tdf.py # TDF format handling
├── nanotdf.py # NanoTDF format handling
├── crypto_utils.py # Cryptographic utilities
├── kas_client.py # Key Access Service client
└── ... # Additional modules
tests/
└── ... # Various tests
Contributing
- Fork the repository
- Create a feature branch:
git checkout -b feature-name - Make your changes
- Run tests:
uv run pytest tests/ - Commit your changes:
git commit -am 'feat: add feature' - Push to the branch:
git push origin feature-name - Submit a pull request
Release Process
For maintainers and contributors working on releases:
- See RELEASES.md for comprehensive release documentation
- Feature branch alpha releases available for testing changes before merge
- Automated releases via Release Please on the main branch
License
This project is licensed under the MIT License - see the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for otdf-python 0.11.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 | |
|---|---|---|---|
| otdf_python-0.11.0.tar.gz | 180.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| otdf_python-0.11.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 431.2 kB
Release files / otdf_python-0.11.0.tar.gz
| Download URL | otdf_python-0.11.0.tar.gz |
|---|---|
| Size | 180.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
62fa2449e2cbe8e11c195bfdeac99042cf6d8cfe8884aad74b64b57bc1250940
|
|
BLAKE2b-256 checksum How to use checksums |
d8ab03b8d57d9ff71846d0b37f11ab06598976742aeac0be98754c5fe9c2fbfb
|
| 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 15, 2026.
Transparency logRelease files / otdf_python-0.11.0-py3-none-any.whl
| Download URL | otdf_python-0.11.0-py3-none-any.whl |
|---|---|
| Size | 251.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
80b16f54b4aaeefa05fd1af675baabb6a0ded779ff0e1370e00f405825ad7b2d
|
|
BLAKE2b-256 checksum How to use checksums |
1515d00824c80dd7be4918d27b666a0c560664f6d4504f1ffeec52d827f914bd
|
| 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 15, 2026.
Transparency log
