shield-python 0.1.1__tar.gz → 0.1.2__tar.gz

{shield_python-0.1.1 → shield_python-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shield-python
-Version: 0.1.1
+Version: 0.1.2
 Summary: Official Shield SDK for Python
 License: MIT
 Project-URL: Homepage, https://getshield.dev
@@ -11,7 +11,7 @@ Requires-Dist: requests>=2.28.0
 
 # Shield Python SDK
 
-Official Python SDK for [Shield](https://getshield.dev) — tamper-evident session recording for online business transactions.
+Official Python SDK for [Shield](https://getshield.dev) ??tamper-evident session recording for online business transactions.
 
 ## Installation
 
@@ -27,7 +27,7 @@ import shield
 client = shield.Client(api_key="sk_live_your_api_key")
 
 # Create a session
-session = client.sessions.create(title="123 Main St Closing")
+session = client.sessions.create(title="Contract Negotiation with Acme Corp")
 session_id = session["id"]
 
 # Record events
@@ -75,8 +75,8 @@ client = shield.Client(
 
 When an HMAC secret is configured, the SDK computes a signature for each request:
 
-- `X-Shield-Timestamp` — Unix timestamp of the request
-- `X-Shield-Signature` — HMAC-SHA256 of `{timestamp}.{METHOD}.{path}.{SHA256(body)}`
+- `X-Shield-Timestamp` ??Unix timestamp of the request
+- `X-Shield-Signature` ??HMAC-SHA256 of `{timestamp}.{METHOD}.{path}.{SHA256(body)}`
 
 The server validates these headers to ensure requests have not been tampered with or replayed.
 
@@ -192,7 +192,7 @@ async def verify_session(session_id: str):
 
 ## Event Types Reference
 
-Shield Standard Event Taxonomy v1.0 — 37 event types across 7 categories:
+Shield Standard Event Taxonomy v1.0 ??37 event types across 7 categories:
 
 ### Party Events
 | Event Type | Description |

{shield_python-0.1.1 → shield_python-0.1.2}/README.md

@@ -1,255 +1,255 @@
-# Shield Python SDK
-
-Official Python SDK for [Shield](https://getshield.dev) — tamper-evident session recording for online business transactions.
-
-## Installation
-
-```bash
-pip install shield-python
-```
-
-## Quick Start
-
-```python
-import shield
-
-client = shield.Client(api_key="sk_live_your_api_key")
-
-# Create a session
-session = client.sessions.create(title="123 Main St Closing")
-session_id = session["id"]
-
-# Record events
-client.events.create(
-    session_id=session_id,
-    event_type="shield.party.joined",
-    actor="agent@example.com",
-    data={"role": "listing_agent", "name": "Jane Smith"},
-)
-
-client.events.create(
-    session_id=session_id,
-    event_type="shield.content.uploaded",
-    actor="agent@example.com",
-    data={"filename": "purchase_agreement.pdf", "hash": "sha256:abc123..."},
-)
-
-client.events.create(
-    session_id=session_id,
-    event_type="shield.agreement.signed",
-    actor="buyer@example.com",
-    data={"document": "purchase_agreement.pdf"},
-)
-
-# Verify session integrity
-result = client.verify.session(session_id)
-print(result["intact"])  # True
-
-# Export session
-pdf_bytes = client.sessions.export(session_id, format="pdf")
-with open("audit_trail.pdf", "wb") as f:
-    f.write(pdf_bytes)
-```
-
-## HMAC Authentication
-
-For enhanced security, provide an HMAC secret to sign every request:
-
-```python
-client = shield.Client(
-    api_key="sk_live_your_api_key",
-    hmac_secret="your_hmac_secret",
-)
-```
-
-When an HMAC secret is configured, the SDK computes a signature for each request:
-
-- `X-Shield-Timestamp` — Unix timestamp of the request
-- `X-Shield-Signature` — HMAC-SHA256 of `{timestamp}.{METHOD}.{path}.{SHA256(body)}`
-
-The server validates these headers to ensure requests have not been tampered with or replayed.
-
-## Flask Integration
-
-```python
-from flask import Flask, request, jsonify
-import shield
-
-app = Flask(__name__)
-client = shield.Client(api_key="sk_live_your_api_key")
-
-@app.route("/sessions", methods=["POST"])
-def create_session():
-    data = request.get_json()
-    session = client.sessions.create(title=data["title"])
-
-    # Record who created the session
-    client.events.create(
-        session_id=session["id"],
-        event_type="shield.session.created",
-        actor=data["user_email"],
-    )
-    return jsonify(session), 201
-
-@app.route("/sessions/<session_id>/upload", methods=["POST"])
-def upload_document(session_id):
-    file = request.files["file"]
-    # ... save file logic ...
-
-    client.events.create(
-        session_id=session_id,
-        event_type="shield.content.uploaded",
-        actor=request.headers.get("X-User-Email"),
-        data={"filename": file.filename},
-    )
-    return jsonify({"status": "uploaded"}), 200
-
-@app.route("/sessions/<session_id>/sign", methods=["POST"])
-def sign_agreement(session_id):
-    data = request.get_json()
-
-    client.events.create(
-        session_id=session_id,
-        event_type="shield.agreement.signed",
-        actor=data["signer_email"],
-        data={"document": data["document_name"], "ip": request.remote_addr},
-    )
-    return jsonify({"status": "signed"}), 200
-```
-
-## FastAPI Integration
-
-```python
-from fastapi import FastAPI, UploadFile, Header
-from pydantic import BaseModel
-import shield
-
-app = FastAPI()
-client = shield.Client(
-    api_key="sk_live_your_api_key",
-    hmac_secret="your_hmac_secret",
-)
-
-class CreateSessionRequest(BaseModel):
-    title: str
-    user_email: str
-
-class SignRequest(BaseModel):
-    signer_email: str
-    document_name: str
-
-@app.post("/sessions")
-async def create_session(body: CreateSessionRequest):
-    session = client.sessions.create(title=body.title)
-    client.events.create(
-        session_id=session["id"],
-        event_type="shield.session.created",
-        actor=body.user_email,
-    )
-    return session
-
-@app.post("/sessions/{session_id}/upload")
-async def upload_document(
-    session_id: str,
-    file: UploadFile,
-    x_user_email: str = Header(...),
-):
-    # ... save file logic ...
-
-    client.events.create(
-        session_id=session_id,
-        event_type="shield.content.uploaded",
-        actor=x_user_email,
-        data={"filename": file.filename},
-    )
-    return {"status": "uploaded"}
-
-@app.post("/sessions/{session_id}/sign")
-async def sign_agreement(session_id: str, body: SignRequest):
-    client.events.create(
-        session_id=session_id,
-        event_type="shield.agreement.signed",
-        actor=body.signer_email,
-        data={"document": body.document_name},
-    )
-    return {"status": "signed"}
-
-@app.get("/sessions/{session_id}/verify")
-async def verify_session(session_id: str):
-    return client.verify.session(session_id)
-```
-
-## Event Types Reference
-
-Shield Standard Event Taxonomy v1.0 — 37 event types across 7 categories:
-
-### Party Events
-| Event Type | Description |
-|---|---|
-| `shield.party.joined` | A party joined the session |
-| `shield.party.left` | A party left the session |
-| `shield.party.identity.verified` | Party identity was verified |
-| `shield.party.identity.failed` | Party identity verification failed |
-| `shield.party.role.assigned` | A role was assigned to a party |
-
-### Session Events
-| Event Type | Description |
-|---|---|
-| `shield.session.created` | Session was created |
-| `shield.session.opened` | Session was opened |
-| `shield.session.closed` | Session was closed |
-| `shield.session.expired` | Session expired |
-| `shield.session.archived` | Session was archived |
-
-### Content Events
-| Event Type | Description |
-|---|---|
-| `shield.content.uploaded` | Content was uploaded |
-| `shield.content.viewed` | Content was viewed |
-| `shield.content.downloaded` | Content was downloaded |
-| `shield.content.deleted` | Content was deleted |
-| `shield.content.hash.verified` | Content hash was verified |
-
-### Negotiation Events
-| Event Type | Description |
-|---|---|
-| `shield.negotiation.terms.proposed` | Terms were proposed |
-| `shield.negotiation.terms.accepted` | Terms were accepted |
-| `shield.negotiation.terms.rejected` | Terms were rejected |
-| `shield.negotiation.terms.modified` | Terms were modified |
-| `shield.negotiation.terms.expired` | Terms expired |
-| `shield.negotiation.message.sent` | Negotiation message sent |
-| `shield.negotiation.message.read` | Negotiation message read |
-
-### Agreement Events
-| Event Type | Description |
-|---|---|
-| `shield.agreement.drafted` | Agreement was drafted |
-| `shield.agreement.reviewed` | Agreement was reviewed |
-| `shield.agreement.approved` | Agreement was approved |
-| `shield.agreement.signed` | Agreement was signed |
-| `shield.agreement.countersigned` | Agreement was countersigned |
-| `shield.agreement.voided` | Agreement was voided |
-| `shield.agreement.reached` | Agreement was reached |
-
-### Access Events
-| Event Type | Description |
-|---|---|
-| `shield.access.granted` | Access was granted |
-| `shield.access.revoked` | Access was revoked |
-| `shield.access.attempted` | Access was attempted |
-| `shield.access.denied` | Access was denied |
-
-### Disclosure Events
-| Event Type | Description |
-|---|---|
-| `shield.disclosure.presented` | Disclosure was presented |
-| `shield.disclosure.acknowledged` | Disclosure was acknowledged |
-| `shield.disclosure.declined` | Disclosure was declined |
-
-### Evidence Events
-| Event Type | Description |
-|---|---|
-| `shield.evidence.exported` | Evidence was exported |
-| `shield.evidence.verified` | Evidence was verified |
-| `shield.evidence.tampered_detected` | Evidence tampering was detected |
+# Shield Python SDK
+
+Official Python SDK for [Shield](https://getshield.dev) ??tamper-evident session recording for online business transactions.
+
+## Installation
+
+```bash
+pip install shield-python
+```
+
+## Quick Start
+
+```python
+import shield
+
+client = shield.Client(api_key="sk_live_your_api_key")
+
+# Create a session
+session = client.sessions.create(title="Contract Negotiation with Acme Corp")
+session_id = session["id"]
+
+# Record events
+client.events.create(
+    session_id=session_id,
+    event_type="shield.party.joined",
+    actor="agent@example.com",
+    data={"role": "listing_agent", "name": "Jane Smith"},
+)
+
+client.events.create(
+    session_id=session_id,
+    event_type="shield.content.uploaded",
+    actor="agent@example.com",
+    data={"filename": "purchase_agreement.pdf", "hash": "sha256:abc123..."},
+)
+
+client.events.create(
+    session_id=session_id,
+    event_type="shield.agreement.signed",
+    actor="buyer@example.com",
+    data={"document": "purchase_agreement.pdf"},
+)
+
+# Verify session integrity
+result = client.verify.session(session_id)
+print(result["intact"])  # True
+
+# Export session
+pdf_bytes = client.sessions.export(session_id, format="pdf")
+with open("audit_trail.pdf", "wb") as f:
+    f.write(pdf_bytes)
+```
+
+## HMAC Authentication
+
+For enhanced security, provide an HMAC secret to sign every request:
+
+```python
+client = shield.Client(
+    api_key="sk_live_your_api_key",
+    hmac_secret="your_hmac_secret",
+)
+```
+
+When an HMAC secret is configured, the SDK computes a signature for each request:
+
+- `X-Shield-Timestamp` ??Unix timestamp of the request
+- `X-Shield-Signature` ??HMAC-SHA256 of `{timestamp}.{METHOD}.{path}.{SHA256(body)}`
+
+The server validates these headers to ensure requests have not been tampered with or replayed.
+
+## Flask Integration
+
+```python
+from flask import Flask, request, jsonify
+import shield
+
+app = Flask(__name__)
+client = shield.Client(api_key="sk_live_your_api_key")
+
+@app.route("/sessions", methods=["POST"])
+def create_session():
+    data = request.get_json()
+    session = client.sessions.create(title=data["title"])
+
+    # Record who created the session
+    client.events.create(
+        session_id=session["id"],
+        event_type="shield.session.created",
+        actor=data["user_email"],
+    )
+    return jsonify(session), 201
+
+@app.route("/sessions/<session_id>/upload", methods=["POST"])
+def upload_document(session_id):
+    file = request.files["file"]
+    # ... save file logic ...
+
+    client.events.create(
+        session_id=session_id,
+        event_type="shield.content.uploaded",
+        actor=request.headers.get("X-User-Email"),
+        data={"filename": file.filename},
+    )
+    return jsonify({"status": "uploaded"}), 200
+
+@app.route("/sessions/<session_id>/sign", methods=["POST"])
+def sign_agreement(session_id):
+    data = request.get_json()
+
+    client.events.create(
+        session_id=session_id,
+        event_type="shield.agreement.signed",
+        actor=data["signer_email"],
+        data={"document": data["document_name"], "ip": request.remote_addr},
+    )
+    return jsonify({"status": "signed"}), 200
+```
+
+## FastAPI Integration
+
+```python
+from fastapi import FastAPI, UploadFile, Header
+from pydantic import BaseModel
+import shield
+
+app = FastAPI()
+client = shield.Client(
+    api_key="sk_live_your_api_key",
+    hmac_secret="your_hmac_secret",
+)
+
+class CreateSessionRequest(BaseModel):
+    title: str
+    user_email: str
+
+class SignRequest(BaseModel):
+    signer_email: str
+    document_name: str
+
+@app.post("/sessions")
+async def create_session(body: CreateSessionRequest):
+    session = client.sessions.create(title=body.title)
+    client.events.create(
+        session_id=session["id"],
+        event_type="shield.session.created",
+        actor=body.user_email,
+    )
+    return session
+
+@app.post("/sessions/{session_id}/upload")
+async def upload_document(
+    session_id: str,
+    file: UploadFile,
+    x_user_email: str = Header(...),
+):
+    # ... save file logic ...
+
+    client.events.create(
+        session_id=session_id,
+        event_type="shield.content.uploaded",
+        actor=x_user_email,
+        data={"filename": file.filename},
+    )
+    return {"status": "uploaded"}
+
+@app.post("/sessions/{session_id}/sign")
+async def sign_agreement(session_id: str, body: SignRequest):
+    client.events.create(
+        session_id=session_id,
+        event_type="shield.agreement.signed",
+        actor=body.signer_email,
+        data={"document": body.document_name},
+    )
+    return {"status": "signed"}
+
+@app.get("/sessions/{session_id}/verify")
+async def verify_session(session_id: str):
+    return client.verify.session(session_id)
+```
+
+## Event Types Reference
+
+Shield Standard Event Taxonomy v1.0 ??37 event types across 7 categories:
+
+### Party Events
+| Event Type | Description |
+|---|---|
+| `shield.party.joined` | A party joined the session |
+| `shield.party.left` | A party left the session |
+| `shield.party.identity.verified` | Party identity was verified |
+| `shield.party.identity.failed` | Party identity verification failed |
+| `shield.party.role.assigned` | A role was assigned to a party |
+
+### Session Events
+| Event Type | Description |
+|---|---|
+| `shield.session.created` | Session was created |
+| `shield.session.opened` | Session was opened |
+| `shield.session.closed` | Session was closed |
+| `shield.session.expired` | Session expired |
+| `shield.session.archived` | Session was archived |
+
+### Content Events
+| Event Type | Description |
+|---|---|
+| `shield.content.uploaded` | Content was uploaded |
+| `shield.content.viewed` | Content was viewed |
+| `shield.content.downloaded` | Content was downloaded |
+| `shield.content.deleted` | Content was deleted |
+| `shield.content.hash.verified` | Content hash was verified |
+
+### Negotiation Events
+| Event Type | Description |
+|---|---|
+| `shield.negotiation.terms.proposed` | Terms were proposed |
+| `shield.negotiation.terms.accepted` | Terms were accepted |
+| `shield.negotiation.terms.rejected` | Terms were rejected |
+| `shield.negotiation.terms.modified` | Terms were modified |
+| `shield.negotiation.terms.expired` | Terms expired |
+| `shield.negotiation.message.sent` | Negotiation message sent |
+| `shield.negotiation.message.read` | Negotiation message read |
+
+### Agreement Events
+| Event Type | Description |
+|---|---|
+| `shield.agreement.drafted` | Agreement was drafted |
+| `shield.agreement.reviewed` | Agreement was reviewed |
+| `shield.agreement.approved` | Agreement was approved |
+| `shield.agreement.signed` | Agreement was signed |
+| `shield.agreement.countersigned` | Agreement was countersigned |
+| `shield.agreement.voided` | Agreement was voided |
+| `shield.agreement.reached` | Agreement was reached |
+
+### Access Events
+| Event Type | Description |
+|---|---|
+| `shield.access.granted` | Access was granted |
+| `shield.access.revoked` | Access was revoked |
+| `shield.access.attempted` | Access was attempted |
+| `shield.access.denied` | Access was denied |
+
+### Disclosure Events
+| Event Type | Description |
+|---|---|
+| `shield.disclosure.presented` | Disclosure was presented |
+| `shield.disclosure.acknowledged` | Disclosure was acknowledged |
+| `shield.disclosure.declined` | Disclosure was declined |
+
+### Evidence Events
+| Event Type | Description |
+|---|---|
+| `shield.evidence.exported` | Evidence was exported |
+| `shield.evidence.verified` | Evidence was verified |
+| `shield.evidence.tampered_detected` | Evidence tampering was detected |

{shield_python-0.1.1 → shield_python-0.1.2}/pyproject.toml

@@ -1,16 +1,16 @@
-[build-system]
-requires = ["setuptools>=68.0", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "shield-python"
-version = "0.1.1"
-description = "Official Shield SDK for Python"
-readme = "README.md"
-license = {text = "MIT"}
-requires-python = ">=3.8"
-dependencies = ["requests>=2.28.0"]
-
-[project.urls]
-Homepage = "https://getshield.dev"
-Documentation = "https://docs.getshield.dev"
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "shield-python"
+version = "0.1.2"
+description = "Official Shield SDK for Python"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+dependencies = ["requests>=2.28.0"]
+
+[project.urls]
+Homepage = "https://getshield.dev"
+Documentation = "https://docs.getshield.dev"

{shield_python-0.1.1 → shield_python-0.1.2}/setup.py

@@ -1,8 +1,8 @@
-from setuptools import setup, find_packages
-
-setup(
-    name="shield-python",
-    version="0.1.1",
-    packages=find_packages(),
-    install_requires=["requests>=2.28.0"],
-)
+from setuptools import setup, find_packages
+
+setup(
+    name="shield-python",
+    version="0.1.2",
+    packages=find_packages(),
+    install_requires=["requests>=2.28.0"],
+)

{shield_python-0.1.1 → shield_python-0.1.2}/shield/__init__.py

@@ -2,4 +2,4 @@ from .client import Client
 from .exceptions import ShieldError
 
 __all__ = ["Client", "ShieldError"]
-__version__ = "0.1.0"
+__version__ = "0.1.2"

{shield_python-0.1.1 → shield_python-0.1.2}/shield/client.py

@@ -18,7 +18,7 @@ class Client:
 
     Args:
         api_key: Your Shield API key.
-        base_url: Base URL for the Shield API. Defaults to https://getshield.dev/api/v1.
+        base_url: Base URL for the Shield API. Defaults to https://api.getshield.dev/v1.
         hmac_secret: Optional HMAC secret for request signing.
         timeout: Request timeout in seconds. Defaults to 30.
     """
@@ -26,7 +26,7 @@ class Client:
     def __init__(
         self,
         api_key: str,
-        base_url: str = "https://getshield.dev/api/v1",
+        base_url: str = "https://api.getshield.dev/v1",
         hmac_secret: Optional[str] = None,
         timeout: int = 30,
     ):
@@ -79,7 +79,9 @@ class Client:
 
         # HMAC signing
         if self.hmac_secret:
+            import uuid
             timestamp = str(int(time.time()))
+            nonce = str(uuid.uuid4())
             body_hash = hashlib.sha256(body).hexdigest()
             message = f"{timestamp}.{method}.{path}.{body_hash}"
             signature = hmac_mod.new(
@@ -89,6 +91,7 @@ class Client:
             ).hexdigest()
             headers["X-Shield-Signature"] = signature
             headers["X-Shield-Timestamp"] = timestamp
+            headers["X-Shield-Nonce"] = nonce
 
         try:
             response = self._session.request(

{shield_python-0.1.1 → shield_python-0.1.2}/shield_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shield-python
-Version: 0.1.1
+Version: 0.1.2
 Summary: Official Shield SDK for Python
 License: MIT
 Project-URL: Homepage, https://getshield.dev
@@ -11,7 +11,7 @@ Requires-Dist: requests>=2.28.0
 
 # Shield Python SDK
 
-Official Python SDK for [Shield](https://getshield.dev) — tamper-evident session recording for online business transactions.
+Official Python SDK for [Shield](https://getshield.dev) ??tamper-evident session recording for online business transactions.
 
 ## Installation
 
@@ -27,7 +27,7 @@ import shield
 client = shield.Client(api_key="sk_live_your_api_key")
 
 # Create a session
-session = client.sessions.create(title="123 Main St Closing")
+session = client.sessions.create(title="Contract Negotiation with Acme Corp")
 session_id = session["id"]
 
 # Record events
@@ -75,8 +75,8 @@ client = shield.Client(
 
 When an HMAC secret is configured, the SDK computes a signature for each request:
 
-- `X-Shield-Timestamp` — Unix timestamp of the request
-- `X-Shield-Signature` — HMAC-SHA256 of `{timestamp}.{METHOD}.{path}.{SHA256(body)}`
+- `X-Shield-Timestamp` ??Unix timestamp of the request
+- `X-Shield-Signature` ??HMAC-SHA256 of `{timestamp}.{METHOD}.{path}.{SHA256(body)}`
 
 The server validates these headers to ensure requests have not been tampered with or replayed.
 
@@ -192,7 +192,7 @@ async def verify_session(session_id: str):
 
 ## Event Types Reference
 
-Shield Standard Event Taxonomy v1.0 — 37 event types across 7 categories:
+Shield Standard Event Taxonomy v1.0 ??37 event types across 7 categories:
 
 ### Party Events
 | Event Type | Description |