etchv-sdk 1.0.0__tar.gz

etchv_sdk-1.0.0/.gitignore

@@ -0,0 +1,7 @@
+node_modules/
+.venv/
+__pycache__/
+*.pyc
+dist/
+*.tgz
+.env*

etchv_sdk-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Etchv
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

etchv_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.5
+Name: etchv-sdk
+Version: 1.0.0
+Summary: Official Python client for the Etchv forensic watermarking API for images, PDFs and videos
+Project-URL: Homepage, https://etchv.com/docs
+Project-URL: Documentation, https://etchv.com/docs/sdks/python
+Project-URL: Repository, https://github.com/etchv-labs/python-sdk
+Project-URL: Issues, https://github.com/etchv-labs/python-sdk/issues
+Author-email: Etchv Labs <hello@etchv.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,detection,etchv,forensic watermarking,image,invisible watermark,pdf,sdk,video,watermark,watermarking
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <3.15,>=3.14
+Requires-Dist: httpx<1,>=0.27
+Description-Content-Type: text/markdown
+
+# Etchv Python SDK
+
+Official server-side Python client for [Etchv](https://etchv.com): embed and
+detect invisible forensic watermarks in images, PDFs and videos.
+
+## Install
+
+```sh
+pip install etchv-sdk
+```
+
+Requires Python 3.14. Import it as `etchv`. Fully typed.
+
+## Quickstart
+
+Create an API key in the [Etchv dashboard](https://etchv.com/dashboard/api-keys)
+and set `ETCHV_API_KEY` on your server. Embedding needs the `watermarks:embed`
+scope, detection `watermarks:detect`, and both use credits.
+
+```python
+import os
+from pathlib import Path
+from etchv import Etchv
+
+with Etchv(os.environ["ETCHV_API_KEY"]) as client:
+    result = client.embed_image(Path("photo.jpg").read_bytes(),
+                                {"recipient": "customer-123"}, filename="photo.jpg")
+    Path(result.filename).write_bytes(result.image)  # write bytes as-is
+
+    detection = client.detect_image(result.image)
+    print(detection.watermarked, detection.watermark_id, detection.confidence)
+```
+
+Use `embed_document` / `detect_document` for PDFs and `embed_video` /
+`detect_video` for H.264 MP4/MOV. Uploads are limited to 20 MB. Detection
+recovers a SHA-256 digest of your data, not the data itself.
+
+## Async jobs
+
+```python
+job = client.submit_embed("documents", pdf_bytes, {"recipient": "customer-123"},
+                          filename="report.pdf", idempotency_key="report-001")
+status = client.get_job(job["request_id"])  # ["status"]: queued, running, retrying, succeeded, failed
+result = client.get_embed_result(job["request_id"])  # waits for the file
+```
+
+`submit_detection`, `get_job(..., detect=True)` and `get_detection_result` work
+the same way. Reusing an `idempotency_key` with the same input returns the saved
+result (kept 24 hours) without another charge.
+
+## Also included
+
+- API key check: `check_api_key()` (no credits used).
+- Assets: `list_assets`, `get_asset`, `update_asset`, `download_asset`,
+  `delete_asset`, `delete_assets`.
+- Webhooks: `create_webhook`, `list_webhooks`, `update_webhook`,
+  `delete_webhook`, `list_webhook_deliveries`, `redeliver_webhook`; verify
+  deliveries with `verify_webhook(raw_body, headers, signing_secret)`, which
+  raises `WebhookVerificationError`.
+- Customer storage (S3, GCS, Azure): `create_storage_destination`,
+  `list_storage_destinations`, `update_storage_destination`,
+  `verify_storage_destination`, `delete_storage_destination`,
+  `create_storage_delivery`, `list_storage_deliveries`, `get_storage_delivery`,
+  `retry_storage_delivery`, `download_storage_delivery`.
+
+## Errors
+
+API failures raise `EtchvError` or a subclass such as `AuthenticationError`,
+`PermissionDeniedError`, `ConflictError`, `GoneError`, `RateLimitError` or
+`DeadlineExceededError`. Each carries `status_code`, `detail` and `request_id`
+(quote it to support). Messages never include your API key.
+
+```python
+from etchv import EtchvError
+
+try:
+    client.detect_image(image)
+except EtchvError as error:
+    print(error.status_code, error.request_id)
+```
+
+## Links
+
+- Full guide: https://etchv.com/docs/sdks/python
+- API reference: https://etchv.com/docs
+- Support: hello@etchv.com
+
+License: MIT (covers this SDK, not the hosted Etchv service).
+
+Questions or bug reports: open an issue here or email hello@etchv.com.

etchv_sdk-1.0.0/README.md

@@ -0,0 +1,90 @@
+# Etchv Python SDK
+
+Official server-side Python client for [Etchv](https://etchv.com): embed and
+detect invisible forensic watermarks in images, PDFs and videos.
+
+## Install
+
+```sh
+pip install etchv-sdk
+```
+
+Requires Python 3.14. Import it as `etchv`. Fully typed.
+
+## Quickstart
+
+Create an API key in the [Etchv dashboard](https://etchv.com/dashboard/api-keys)
+and set `ETCHV_API_KEY` on your server. Embedding needs the `watermarks:embed`
+scope, detection `watermarks:detect`, and both use credits.
+
+```python
+import os
+from pathlib import Path
+from etchv import Etchv
+
+with Etchv(os.environ["ETCHV_API_KEY"]) as client:
+    result = client.embed_image(Path("photo.jpg").read_bytes(),
+                                {"recipient": "customer-123"}, filename="photo.jpg")
+    Path(result.filename).write_bytes(result.image)  # write bytes as-is
+
+    detection = client.detect_image(result.image)
+    print(detection.watermarked, detection.watermark_id, detection.confidence)
+```
+
+Use `embed_document` / `detect_document` for PDFs and `embed_video` /
+`detect_video` for H.264 MP4/MOV. Uploads are limited to 20 MB. Detection
+recovers a SHA-256 digest of your data, not the data itself.
+
+## Async jobs
+
+```python
+job = client.submit_embed("documents", pdf_bytes, {"recipient": "customer-123"},
+                          filename="report.pdf", idempotency_key="report-001")
+status = client.get_job(job["request_id"])  # ["status"]: queued, running, retrying, succeeded, failed
+result = client.get_embed_result(job["request_id"])  # waits for the file
+```
+
+`submit_detection`, `get_job(..., detect=True)` and `get_detection_result` work
+the same way. Reusing an `idempotency_key` with the same input returns the saved
+result (kept 24 hours) without another charge.
+
+## Also included
+
+- API key check: `check_api_key()` (no credits used).
+- Assets: `list_assets`, `get_asset`, `update_asset`, `download_asset`,
+  `delete_asset`, `delete_assets`.
+- Webhooks: `create_webhook`, `list_webhooks`, `update_webhook`,
+  `delete_webhook`, `list_webhook_deliveries`, `redeliver_webhook`; verify
+  deliveries with `verify_webhook(raw_body, headers, signing_secret)`, which
+  raises `WebhookVerificationError`.
+- Customer storage (S3, GCS, Azure): `create_storage_destination`,
+  `list_storage_destinations`, `update_storage_destination`,
+  `verify_storage_destination`, `delete_storage_destination`,
+  `create_storage_delivery`, `list_storage_deliveries`, `get_storage_delivery`,
+  `retry_storage_delivery`, `download_storage_delivery`.
+
+## Errors
+
+API failures raise `EtchvError` or a subclass such as `AuthenticationError`,
+`PermissionDeniedError`, `ConflictError`, `GoneError`, `RateLimitError` or
+`DeadlineExceededError`. Each carries `status_code`, `detail` and `request_id`
+(quote it to support). Messages never include your API key.
+
+```python
+from etchv import EtchvError
+
+try:
+    client.detect_image(image)
+except EtchvError as error:
+    print(error.status_code, error.request_id)
+```
+
+## Links
+
+- Full guide: https://etchv.com/docs/sdks/python
+- API reference: https://etchv.com/docs
+- Support: hello@etchv.com
+
+License: MIT (covers this SDK, not the hosted Etchv service).
+
+Questions or bug reports: open an issue here or email hello@etchv.com.

etchv_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["hatchling>=1.26,<2"]
+build-backend = "hatchling.build"
+
+[project]
+name = "etchv-sdk"
+version = "1.0.0"
+description = "Official Python client for the Etchv forensic watermarking API for images, PDFs and videos"
+readme = "README.md"
+requires-python = ">=3.14,<3.15"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{name = "Etchv Labs", email = "hello@etchv.com"}]
+keywords = ["etchv", "watermark", "watermarking", "forensic watermarking", "invisible watermark", "image", "pdf", "video", "detection", "api", "sdk"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Security",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = ["httpx>=0.27,<1"]
+
+[project.urls]
+Homepage = "https://etchv.com/docs"
+Documentation = "https://etchv.com/docs/sdks/python"
+Repository = "https://github.com/etchv-labs/python-sdk"
+Issues = "https://github.com/etchv-labs/python-sdk/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/etchv"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/etchv", "tests", "README.md", "LICENSE", "pyproject.toml"]

etchv_sdk-1.0.0/src/etchv/__init__.py

@@ -0,0 +1,38 @@
+"""Official Python client for the Etchv forensic watermarking API."""
+from .client import (
+    __version__,
+    AuthenticationError,
+    ConflictError,
+    DeadlineExceededError,
+    DetectionResult,
+    DetectionUnit,
+    EmbedResult,
+    Etchv,
+    EtchvError,
+    GoneError,
+    NotFoundError,
+    PaymentRequiredError,
+    PermissionDeniedError,
+    RateLimitError,
+    WebhookVerificationError,
+    verify_webhook,
+)
+
+__all__ = [
+    "__version__",
+    "Etchv",
+    "EtchvError",
+    "AuthenticationError",
+    "PaymentRequiredError",
+    "PermissionDeniedError",
+    "NotFoundError",
+    "ConflictError",
+    "GoneError",
+    "RateLimitError",
+    "DeadlineExceededError",
+    "EmbedResult",
+    "DetectionResult",
+    "DetectionUnit",
+    "WebhookVerificationError",
+    "verify_webhook",
+]