hookbridge 1.0.0__tar.gz

hookbridge-1.0.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

hookbridge-1.0.0/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: hookbridge
+Version: 1.0.0
+Summary: Official HookBridge SDK for Python
+Project-URL: Homepage, https://hookbridge.io
+Project-URL: Documentation, https://hookbridge.io/docs/sdks/python
+Project-URL: Repository, https://github.com/hookbridge/hookbridge-python
+Project-URL: Issues, https://github.com/hookbridge/hookbridge-python/issues
+Author-email: HookBridge <support@hookbridge.io>
+License-Expression: MIT
+Keywords: api,hookbridge,sdk,webhook,webhooks
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.25.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# HookBridge Python SDK
+
+Official HookBridge SDK for Python. Send webhooks with guaranteed delivery, automatic retries, and full observability.
+
+## Installation
+
+```bash
+pip install hookbridge
+```
+
+## Quick Start
+
+```python
+from hookbridge import HookBridge
+
+client = HookBridge(api_key="hb_live_xxxxxxxxxxxxxxxxxxxx")
+
+# Send a webhook
+result = client.send(
+    endpoint="https://customer.app/webhooks",
+    payload={
+        "event": "order.created",
+        "order_id": "ord_12345",
+        "amount": 99.99
+    }
+)
+
+print("Message ID:", result.message_id)
+```
+
+## Features
+
+- **Guaranteed Delivery**: Webhooks are stored durably before acknowledgment
+- **Automatic Retries**: Intelligent retry with exponential backoff
+- **Idempotency**: Prevent duplicate webhook sends
+- **Full Observability**: Query logs, metrics, and message status
+- **Type Safety**: Full type hints with mypy support
+- **Async Support**: Both sync and async clients available
+
+## Usage
+
+### Send a Webhook
+
+```python
+result = client.send(
+    endpoint="https://customer.app/webhooks",
+    payload={"event": "user.created", "user_id": "usr_123"},
+    headers={"X-Tenant-Id": "tenant_abc"},
+    idempotency_key="user-123-created"
+)
+```
+
+### Check Message Status
+
+```python
+message = client.get_message(result.message_id)
+print(message.status)  # 'queued', 'succeeded', 'pending_retry', 'failed_permanent'
+```
+
+### Query Delivery Logs
+
+```python
+from datetime import datetime
+
+logs = client.get_logs(
+    status="failed_permanent",
+    start_time=datetime(2025, 1, 1),
+    limit=100
+)
+
+for msg in logs.messages:
+    print(msg.message_id, msg.last_error)
+```
+
+### Get Metrics
+
+```python
+metrics = client.get_metrics("24h")
+print(f"Success rate: {metrics.success_rate * 100:.1f}%")
+print(f"Average latency: {metrics.avg_latency_ms}ms")
+```
+
+### Replay Failed Messages
+
+```python
+# Replay a specific message
+client.replay(message_id)
+
+# Or replay from the Dead Letter Queue
+dlq = client.get_dlq_messages()
+for msg in dlq.messages:
+    client.replay_from_dlq(msg.message_id)
+```
+
+### Manage Retries
+
+```python
+# Cancel a pending retry (moves to DLQ)
+client.cancel_retry(message_id)
+
+# Trigger immediate retry for a pending message
+client.retry_now(message_id)
+```
+
+### API Key Management
+
+```python
+# List API keys
+keys = client.list_api_keys()
+
+# Create a new API key
+new_key = client.create_api_key(mode="live", label="Production backend")
+print("Save this key:", new_key.key)  # Only shown once!
+
+# Delete an API key
+client.delete_api_key("key_abc123")
+```
+
+## Async Usage
+
+```python
+from hookbridge import AsyncHookBridge
+
+async with AsyncHookBridge(api_key="hb_live_xxx") as client:
+    result = await client.send(
+        endpoint="https://customer.app/webhooks",
+        payload={"event": "order.created"}
+    )
+```
+
+## Configuration
+
+```python
+client = HookBridge(
+    # Required: Your API key
+    api_key="hb_live_xxxxxxxxxxxxxxxxxxxx",
+
+    # Optional: Custom base URL (default: https://api.hookbridge.io)
+    base_url="https://api.hookbridge.io",
+
+    # Optional: Request timeout in seconds (default: 30)
+    timeout=30.0,
+
+    # Optional: Number of retries for failed requests (default: 3)
+    retries=3
+)
+```
+
+## Error Handling
+
+```python
+from hookbridge import (
+    HookBridge,
+    AuthenticationError,
+    ValidationError,
+    RateLimitError,
+    NotFoundError,
+    IdempotencyError
+)
+
+try:
+    client.send(...)
+except AuthenticationError:
+    print("Invalid API key")
+except ValidationError as e:
+    print(f"Invalid request: {e}")
+except RateLimitError as e:
+    print(f"Rate limited. Retry after {e.retry_after}s")
+except IdempotencyError:
+    print("Duplicate request with different payload")
+```
+
+## Webhook Delivery
+
+When HookBridge delivers your webhook, it includes these headers:
+
+- `X-Webhook-Signature`: HMAC-SHA256 signature for verification
+- `X-Webhook-Id`: Message ID for tracking
+- `X-Webhook-Timestamp`: Unix timestamp of the send request
+- Any custom headers you specified
+
+### Retry Behavior
+
+- **Fast retries** (for 429 responses): 30s, 60s, 120s, 240s, 300s
+- **Slow retries** (for other errors): 30m, 2h, 6h, 12h, 24h, 48h, 72h, 96h
+- Maximum 8 total attempts before moving to the Dead Letter Queue
+
+## Context Manager Support
+
+```python
+# Sync
+with HookBridge(api_key="...") as client:
+    client.send(...)
+
+# Async
+async with AsyncHookBridge(api_key="...") as client:
+    await client.send(...)
+```
+
+## Requirements
+
+- Python 3.9 or later
+- httpx
+
+## License
+
+MIT

hookbridge-1.0.0/README.md

@@ -0,0 +1,207 @@
+# HookBridge Python SDK
+
+Official HookBridge SDK for Python. Send webhooks with guaranteed delivery, automatic retries, and full observability.
+
+## Installation
+
+```bash
+pip install hookbridge
+```
+
+## Quick Start
+
+```python
+from hookbridge import HookBridge
+
+client = HookBridge(api_key="hb_live_xxxxxxxxxxxxxxxxxxxx")
+
+# Send a webhook
+result = client.send(
+    endpoint="https://customer.app/webhooks",
+    payload={
+        "event": "order.created",
+        "order_id": "ord_12345",
+        "amount": 99.99
+    }
+)
+
+print("Message ID:", result.message_id)
+```
+
+## Features
+
+- **Guaranteed Delivery**: Webhooks are stored durably before acknowledgment
+- **Automatic Retries**: Intelligent retry with exponential backoff
+- **Idempotency**: Prevent duplicate webhook sends
+- **Full Observability**: Query logs, metrics, and message status
+- **Type Safety**: Full type hints with mypy support
+- **Async Support**: Both sync and async clients available
+
+## Usage
+
+### Send a Webhook
+
+```python
+result = client.send(
+    endpoint="https://customer.app/webhooks",
+    payload={"event": "user.created", "user_id": "usr_123"},
+    headers={"X-Tenant-Id": "tenant_abc"},
+    idempotency_key="user-123-created"
+)
+```
+
+### Check Message Status
+
+```python
+message = client.get_message(result.message_id)
+print(message.status)  # 'queued', 'succeeded', 'pending_retry', 'failed_permanent'
+```
+
+### Query Delivery Logs
+
+```python
+from datetime import datetime
+
+logs = client.get_logs(
+    status="failed_permanent",
+    start_time=datetime(2025, 1, 1),
+    limit=100
+)
+
+for msg in logs.messages:
+    print(msg.message_id, msg.last_error)
+```
+
+### Get Metrics
+
+```python
+metrics = client.get_metrics("24h")
+print(f"Success rate: {metrics.success_rate * 100:.1f}%")
+print(f"Average latency: {metrics.avg_latency_ms}ms")
+```
+
+### Replay Failed Messages
+
+```python
+# Replay a specific message
+client.replay(message_id)
+
+# Or replay from the Dead Letter Queue
+dlq = client.get_dlq_messages()
+for msg in dlq.messages:
+    client.replay_from_dlq(msg.message_id)
+```
+
+### Manage Retries
+
+```python
+# Cancel a pending retry (moves to DLQ)
+client.cancel_retry(message_id)
+
+# Trigger immediate retry for a pending message
+client.retry_now(message_id)
+```
+
+### API Key Management
+
+```python
+# List API keys
+keys = client.list_api_keys()
+
+# Create a new API key
+new_key = client.create_api_key(mode="live", label="Production backend")
+print("Save this key:", new_key.key)  # Only shown once!
+
+# Delete an API key
+client.delete_api_key("key_abc123")
+```
+
+## Async Usage
+
+```python
+from hookbridge import AsyncHookBridge
+
+async with AsyncHookBridge(api_key="hb_live_xxx") as client:
+    result = await client.send(
+        endpoint="https://customer.app/webhooks",
+        payload={"event": "order.created"}
+    )
+```
+
+## Configuration
+
+```python
+client = HookBridge(
+    # Required: Your API key
+    api_key="hb_live_xxxxxxxxxxxxxxxxxxxx",
+
+    # Optional: Custom base URL (default: https://api.hookbridge.io)
+    base_url="https://api.hookbridge.io",
+
+    # Optional: Request timeout in seconds (default: 30)
+    timeout=30.0,
+
+    # Optional: Number of retries for failed requests (default: 3)
+    retries=3
+)
+```
+
+## Error Handling
+
+```python
+from hookbridge import (
+    HookBridge,
+    AuthenticationError,
+    ValidationError,
+    RateLimitError,
+    NotFoundError,
+    IdempotencyError
+)
+
+try:
+    client.send(...)
+except AuthenticationError:
+    print("Invalid API key")
+except ValidationError as e:
+    print(f"Invalid request: {e}")
+except RateLimitError as e:
+    print(f"Rate limited. Retry after {e.retry_after}s")
+except IdempotencyError:
+    print("Duplicate request with different payload")
+```
+
+## Webhook Delivery
+
+When HookBridge delivers your webhook, it includes these headers:
+
+- `X-Webhook-Signature`: HMAC-SHA256 signature for verification
+- `X-Webhook-Id`: Message ID for tracking
+- `X-Webhook-Timestamp`: Unix timestamp of the send request
+- Any custom headers you specified
+
+### Retry Behavior
+
+- **Fast retries** (for 429 responses): 30s, 60s, 120s, 240s, 300s
+- **Slow retries** (for other errors): 30m, 2h, 6h, 12h, 24h, 48h, 72h, 96h
+- Maximum 8 total attempts before moving to the Dead Letter Queue
+
+## Context Manager Support
+
+```python
+# Sync
+with HookBridge(api_key="...") as client:
+    client.send(...)
+
+# Async
+async with AsyncHookBridge(api_key="...") as client:
+    await client.send(...)
+```
+
+## Requirements
+
+- Python 3.9 or later
+- httpx
+
+## License
+
+MIT

hookbridge-1.0.0/hookbridge/__init__.py

@@ -0,0 +1,72 @@
+"""
+HookBridge SDK for Python
+
+Send webhooks with guaranteed delivery, automatic retries, and full observability.
+
+Example:
+    >>> from hookbridge import HookBridge
+    >>>
+    >>> client = HookBridge(api_key="hb_live_xxxxxxxxxxxxxxxxxxxx")
+    >>>
+    >>> result = client.send(
+    ...     endpoint="https://customer.app/webhooks",
+    ...     payload={"event": "order.created", "order_id": "12345"}
+    ... )
+    >>> print(result.message_id)
+"""
+
+from hookbridge.client import HookBridge, AsyncHookBridge
+from hookbridge.types import (
+    SendWebhookResponse,
+    Message,
+    MessageSummary,
+    MessageStatus,
+    LogsResponse,
+    Metrics,
+    MetricsWindow,
+    APIKeyInfo,
+    APIKeyMode,
+    CreateAPIKeyResponse,
+    DLQMessagesResponse,
+)
+from hookbridge.errors import (
+    HookBridgeError,
+    AuthenticationError,
+    NotFoundError,
+    ValidationError,
+    RateLimitError,
+    IdempotencyError,
+    ReplayLimitError,
+    NetworkError,
+    TimeoutError,
+)
+
+__version__ = "1.0.0"
+
+__all__ = [
+    # Client
+    "HookBridge",
+    "AsyncHookBridge",
+    # Types
+    "SendWebhookResponse",
+    "Message",
+    "MessageSummary",
+    "MessageStatus",
+    "LogsResponse",
+    "Metrics",
+    "MetricsWindow",
+    "APIKeyInfo",
+    "APIKeyMode",
+    "CreateAPIKeyResponse",
+    "DLQMessagesResponse",
+    # Errors
+    "HookBridgeError",
+    "AuthenticationError",
+    "NotFoundError",
+    "ValidationError",
+    "RateLimitError",
+    "IdempotencyError",
+    "ReplayLimitError",
+    "NetworkError",
+    "TimeoutError",
+]