burnledger 0.1.0__tar.gz

burnledger-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: burnledger
+Version: 0.1.0
+Summary: Python SDK for the BurnLedger API
+License-Expression: MIT
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: cryptography>=41.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"

burnledger-0.1.0/README.md

@@ -0,0 +1,151 @@
+# BurnLedger Python SDK
+
+Python client for the [BurnLedger](https://github.com/fdfretes/deleteme) API — cryptographic deletion certificates for regulatory compliance.
+
+## Install
+
+```bash
+pip install burnledger
+```
+
+**Requirements:** Python 3.10+
+
+## Quick Start
+
+```python
+from burnledger import BurnLedger
+
+with BurnLedger(api_key="dp_...") as dp:
+    # 1. Attest — snapshot systems before deletion
+    att = dp.attest("user@example.com", system_ids=["sys_abc", "sys_def"])
+
+    # 2. Delete data (your code, your tools)
+
+    # 3. Verify — confirm deletion and get certificate
+    result = dp.verify(att.id, "user@example.com", timeout=60)
+
+    # 4. Download certificate PDF
+    dp.save_pdf(result.certificate.id, "./deletion-cert.pdf")
+```
+
+### Async
+
+```python
+from burnledger import AsyncBurnLedger
+
+async with AsyncBurnLedger(api_key="dp_...") as dp:
+    att = await dp.attest("user@example.com", system_ids=["sys_abc"])
+    result = await dp.verify(att.id, "user@example.com", timeout=60)
+```
+
+## Offline Verification
+
+Verify certificates without network access using Ed25519 signatures:
+
+```python
+from burnledger import verify_certificate, verify_transparency, PublicKeyInfo
+
+key = PublicKeyInfo.from_hex("abcdef...", revoked=False)
+keys = {key.key_id: key}
+
+cert_result = verify_certificate(certificate, keys)
+# VerificationResult.VALID or raises VerificationError
+
+log_result = verify_transparency(certificate, keys)
+# TransparencyResult.INCLUDED or raises VerificationError
+```
+
+## Webhook Verification
+
+Verify incoming webhook signatures (HMAC-SHA256):
+
+```python
+from burnledger import verify_webhook_signature
+
+valid = verify_webhook_signature(
+    secret=webhook_secret,         # from dp.register_webhook()
+    body=request.body,             # raw request body
+    signature=request.headers["X-BurnLedger-Signature"],
+)
+```
+
+## API Reference
+
+### Client
+
+```python
+BurnLedger(
+    api_key: str,
+    *,
+    base_url: str = "https://api.burnledger.com",
+    timeout: float = 30.0,
+    max_retries: int = 2,
+)
+```
+
+### Systems
+
+| Method | Returns |
+|--------|---------|
+| `register_system(**opts)` | `System` |
+| `get_system(id)` | `System` |
+| `list_systems(limit=25)` | `SyncPaginator[System]` |
+| `deregister_system(id)` | `None` |
+| `health_check(id)` | `System` |
+
+### Attestations
+
+| Method | Returns |
+|--------|---------|
+| `attest(subject, **opts)` | `Attestation` |
+| `get_attestation(id)` | `Attestation` |
+| `wait_for(id, **opts)` | `Attestation` |
+| `verify(id, subject, **opts)` | `VerifyResult` |
+
+### Certificates
+
+| Method | Returns |
+|--------|---------|
+| `get_certificate(id)` | `CertificateResponse` |
+| `list_certificates(limit=25)` | `SyncPaginator[CertificateResponse]` |
+| `download_pdf(id)` | `bytes` |
+| `save_pdf(id, path)` | `None` |
+| `get_revocation_status(id)` | `RevocationStatus` |
+| `revoke_certificate(id, reason=...)` | `CertificateResponse` |
+
+### Webhooks
+
+| Method | Returns |
+|--------|---------|
+| `register_webhook(url=...)` | `Webhook` |
+| `list_webhooks(limit=25)` | `SyncPaginator[Webhook]` |
+| `delete_webhook(id)` | `None` |
+
+### Transparency Log
+
+These methods do not require authentication.
+
+| Method | Returns |
+|--------|---------|
+| `get_log_head()` | `SignedTreeHead` |
+| `get_log_entry(index)` | `LogEntry` |
+| `get_log_entries(start, end)` | `list[LogEntry]` |
+| `get_inclusion_proof(index, tree_size)` | `InclusionProof` |
+| `get_consistency_proof(old_size, new_size)` | `ConsistencyProof` |
+
+### Pagination
+
+All `list_*` methods return a paginator that auto-fetches pages:
+
+```python
+for cert in dp.list_certificates():
+    print(cert.id)
+
+# async
+async for cert in dp.list_certificates():
+    print(cert.id)
+```
+
+## License
+
+MIT

burnledger-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "burnledger"
+version = "0.1.0"
+description = "Python SDK for the BurnLedger API"
+license = "MIT"
+requires-python = ">=3.10"
+dependencies = [
+    "httpx>=0.25.0",
+    "cryptography>=41.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "respx>=0.21",
+    "mypy>=1.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+burnledger = ["py.typed"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

burnledger-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

burnledger-0.1.0/src/burnledger/__init__.py

@@ -0,0 +1,102 @@
+"""BurnLedger Python SDK.
+
+Usage::
+
+    from burnledger import BurnLedger
+
+    with BurnLedger(api_key="dp_...") as dp:
+        att = dp.attest("user@example.com", system_ids=["..."])
+        result = dp.verify(att.id, "user@example.com", timeout=60)
+        cert = dp.get_certificate(result.certificate.id)
+"""
+
+from burnledger._client import AsyncBurnLedger, BurnLedger
+from burnledger._errors import (
+    APIError,
+    AuthenticationError,
+    ConflictError,
+    BurnLedgerError,
+    NotFoundError,
+    RateLimitError,
+    ServerError,
+    TimeoutError,
+    ValidationError,
+    VerificationError,
+)
+from burnledger._models import (
+    Attestation,
+    AttestationStatus,
+    CertificateResponse,
+    CertificateStatus,
+    ConnectorType,
+    ConsistencyProof,
+    HashScope,
+    HealthStatus,
+    InclusionProof,
+    LogEntry,
+    LogEntryType,
+    ProofMode,
+    RevocationStatus,
+    SignedTreeHead,
+    System,
+    SystemAttestation,
+    TransparencyResult,
+    TransparencyStatus,
+    VerificationResult,
+    VerificationSystem,
+    VerifyResult,
+    Webhook,
+)
+from burnledger._pagination import AsyncPaginator, SyncPaginator
+from burnledger._verify import PublicKeyInfo, issuance_bytes, verify_certificate, verify_transparency
+from burnledger._webhooks import verify_webhook_signature
+
+__all__ = [
+    # Clients
+    "BurnLedger",
+    "AsyncBurnLedger",
+    # Verification
+    "verify_certificate",
+    "verify_transparency",
+    "issuance_bytes",
+    "verify_webhook_signature",
+    "PublicKeyInfo",
+    # Models
+    "Attestation",
+    "CertificateResponse",
+    "ConsistencyProof",
+    "InclusionProof",
+    "LogEntry",
+    "RevocationStatus",
+    "SignedTreeHead",
+    "System",
+    "SystemAttestation",
+    "VerificationSystem",
+    "VerifyResult",
+    "Webhook",
+    # Enums
+    "AttestationStatus",
+    "CertificateStatus",
+    "ConnectorType",
+    "HashScope",
+    "HealthStatus",
+    "LogEntryType",
+    "ProofMode",
+    "TransparencyResult",
+    "TransparencyStatus",
+    "VerificationResult",
+    # Pagination
+    "AsyncPaginator",
+    "SyncPaginator",
+    # Errors
+    "APIError",
+    "AuthenticationError",
+    "ConflictError",
+    "BurnLedgerError",
+    "NotFoundError",
+    "RateLimitError",
+    "ServerError",
+    "TimeoutError",
+    "ValidationError",
+    "VerificationError",
+]