relayed 0.0.1__tar.gz

relayed-0.0.1/.gitignore

@@ -0,0 +1,6 @@
+.venv
+__pycache__
+.env
+uvicorn.log
+uvicorn_err.log
+*.txt

relayed-0.0.1/LICENSE

@@ -0,0 +1,186 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and incorporated
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any
+      Contribution embodied within the Work constitutes direct or contributory
+      patent infringement, then any patent licenses granted to You under
+      this License for that Work shall terminate as of the date such
+      litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution, either on its own behalf or on behalf of the Licensor,
+      either alone or combined with the Work, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such obligations only on
+      Your own behalf and on Your sole responsibility, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Diaphora
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

relayed-0.0.1/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: relayed
+Version: 0.0.1
+Summary: Python client for Relayed, a webhook delivery service
+Project-URL: Homepage, https://github.com/JoeCosta7/Relayed
+Author-email: Joseph Costa <joedc3711@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: httpx<1.0,>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Relayed
+
+A Python Client for Relayed, a Webhooks Delivery Service.
+
+## Installation
+
+```bash
+pip install relayed
+```
+
+## Quick start
+
+```python
+import uuid
+from relayed import RelayedClient, RelayedClientError
+
+client = RelayedClient(
+    api_key="your-api-key",
+    base_url="https://relayed.example.com",
+    )
+
+subscription = client.create_subscription(
+        destination_url="https://example.com",
+        event_types=["invoice.paid", "invoice.unpaid"],
+        description="Subscription for a contractor to send webhook whether customer paid the invoice"
+    )
+try:
+    response = client.send_event(
+        event_type="invoice.paid",
+        payload={"invoice_id": "inv_123", "amount": 4200},
+        idempotency_key=str(uuid.uuid4()),  # use a stable value across retries
+    )
+    print(response)  # {"event_id": "...", "delivery_ids": [...]}
+except RelayedClientError as e:
+    print(f"Cannot send event: {e}")
+
+```
+
+## Error Handling
+
+All errors raised by the SDK inherit from RelayedError, so you can catch everything with a single except clause, or catch specific subclasses for fine-grained handling.
+
+```python
+from relayed import (
+    RelayedError,
+    RelayedAuthError,
+    RelayedNotFoundError,
+    RelayedConflictError,
+    RelayedClientError,
+    RelayedServerError,
+)
+```
+
+## Links
+
+- Source: [Github URL](https://github.com/JoeCosta7/Relayed)
+- Issues: [GitHub issues URL](https://github.com/JoeCosta7/Relayed/issues)

relayed-0.0.1/README.md

@@ -0,0 +1,57 @@
+# Relayed
+
+A Python Client for Relayed, a Webhooks Delivery Service.
+
+## Installation
+
+```bash
+pip install relayed
+```
+
+## Quick start
+
+```python
+import uuid
+from relayed import RelayedClient, RelayedClientError
+
+client = RelayedClient(
+    api_key="your-api-key",
+    base_url="https://relayed.example.com",
+    )
+
+subscription = client.create_subscription(
+        destination_url="https://example.com",
+        event_types=["invoice.paid", "invoice.unpaid"],
+        description="Subscription for a contractor to send webhook whether customer paid the invoice"
+    )
+try:
+    response = client.send_event(
+        event_type="invoice.paid",
+        payload={"invoice_id": "inv_123", "amount": 4200},
+        idempotency_key=str(uuid.uuid4()),  # use a stable value across retries
+    )
+    print(response)  # {"event_id": "...", "delivery_ids": [...]}
+except RelayedClientError as e:
+    print(f"Cannot send event: {e}")
+
+```
+
+## Error Handling
+
+All errors raised by the SDK inherit from RelayedError, so you can catch everything with a single except clause, or catch specific subclasses for fine-grained handling.
+
+```python
+from relayed import (
+    RelayedError,
+    RelayedAuthError,
+    RelayedNotFoundError,
+    RelayedConflictError,
+    RelayedClientError,
+    RelayedServerError,
+)
+```
+
+## Links
+
+- Source: [Github URL](https://github.com/JoeCosta7/Relayed)
+- Issues: [GitHub issues URL](https://github.com/JoeCosta7/Relayed/issues)

relayed-0.0.1/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "relayed"
+version = "0.0.1"
+authors = [
+    { name = "Joseph Costa", email="joedc3711@gmail.com" },
+]
+description = "Python client for Relayed, a webhook delivery service"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "httpx>=0.27,<1.0",
+]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+
+[project.urls]
+Homepage = "https://github.com/JoeCosta7/Relayed"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/relayed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

relayed-0.0.1/src/relayed/__init__.py

@@ -0,0 +1,21 @@
+from relayed._client import RelayedClient
+from relayed._errors import (
+    RelayedError,
+    RelayedAuthError,
+    RelayedNotFoundError,
+    RelayedConflictError,
+    RelayedClientError,
+    RelayedServerError,
+)
+
+__all__ = [
+    "RelayedClient",
+    "RelayedError",
+    "RelayedAuthError",
+    "RelayedNotFoundError",
+    "RelayedConflictError",
+    "RelayedClientError",
+    "RelayedServerError",
+]
+
+__version__ = "0.0.1"

relayed-0.0.1/src/relayed/_client.py

@@ -0,0 +1,114 @@
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from ._errors import (
+    RelayedError,
+    RelayedAuthError,
+    RelayedNotFoundError,
+    RelayedConflictError,
+    RelayedClientError,
+    RelayedServerError,
+)
+
+
+_STATUS_EXCEPTIONS: dict[int, type[RelayedError]] = {
+    401: RelayedAuthError,
+    403: RelayedAuthError,
+    404: RelayedNotFoundError,
+    409: RelayedConflictError,
+}
+
+
+class RelayedClient:
+
+    def __init__(self, api_key: str, base_url: str, timeout: float = 30.0):
+        self.api_key = api_key
+        self.base_url = base_url
+        self._client = httpx.Client(
+            base_url=base_url,
+            headers={"Authorization": f"Bearer {api_key}"},
+            timeout=timeout,
+        )
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> "RelayedClient":
+        return self
+
+    def __exit__(self, *exc_info) -> None:
+        self.close()
+
+    def _request(self, method: str, path: str, **kwargs) -> Any:
+        response = self._client.request(method, path, **kwargs)
+        self._raise_for_status(response)
+        if response.status_code == 204 or not response.content:
+            return None
+        return response.json()
+
+    @staticmethod
+    def _raise_for_status(response: httpx.Response) -> None:
+        if 200 <= response.status_code < 300:
+            return
+        exc_cls = _STATUS_EXCEPTIONS.get(response.status_code)
+        if exc_cls is None:
+            exc_cls = RelayedServerError if response.status_code >= 500 else RelayedClientError
+        raise exc_cls(
+            f"Relayed API returned {response.status_code}: {response.text}",
+            status_code=response.status_code,
+            response_body=response.text,
+        )
+
+    def send_event(self, event_type: str, payload: dict[str, Any], idempotency_key: str) -> dict[str, Any]:
+        """Returns {"event_id": str, "delivery_ids": list[str]}.
+
+        idempotency_key is required and not generated for you: if you retry after
+        a dropped connection, reusing the same key is what makes the retry safe.
+        Generating a fresh one per call would defeat that.
+        """
+        return self._request(
+            "POST",
+            "/v1/events",
+            json={"event_type": event_type, "payload": payload},
+            headers={"idempotency-key": idempotency_key},
+        )
+
+    def list_dead_letters(self) -> list[dict[str, Any]]:
+        return self._request("GET", "/v1/deadletter")
+
+    def replay_dead_letter(self, dead_letter_id: str) -> str:
+        """Returns the id of the new delivery created for the replay."""
+        result = self._request("POST", f"/v1/deadletter/{dead_letter_id}/replay")
+        return result["delivery_ids"][0]
+
+    def create_subscription(
+        self,
+        destination_url: str,
+        event_types: list[str],
+        description: str | None = None,
+    ) -> dict[str, Any]:
+        """Returns the created subscription, including webhook_secret.
+
+        webhook_secret is shown only here
+        """
+        return self._request(
+            "POST",
+            "/v1/subscriptions",
+            json={
+                "destination_url": destination_url,
+                "event_types": event_types,
+                "description": description,
+            },
+        )
+
+    def list_subscriptions(self) -> list[dict[str, Any]]:
+        return self._request("GET", "/v1/subscriptions")
+
+    def get_subscription(self, subscription_id: str) -> dict[str, Any]:
+        return self._request("GET", f"/v1/subscriptions/{subscription_id}")
+
+    def delete_subscription(self, subscription_id: str) -> None:
+        self._request("DELETE", f"/v1/subscriptions/{subscription_id}")

relayed-0.0.1/src/relayed/_errors.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+class RelayedError(Exception):
+    def __init__(self, message: str, status_code: int | None = None, response_body: str | None = None):
+        super().__init__(message)
+        self.status_code = status_code
+        self.response_body = response_body
+
+class RelayedAuthError(RelayedError):
+    """401/403 — missing or invalid API key."""
+
+class RelayedNotFoundError(RelayedError):
+    """404 — resource does not exist (or isn't owned by this customer)."""
+
+class RelayedConflictError(RelayedError):
+    """409 — e.g. dead letter already replayed, subscription no longer active."""
+
+class RelayedClientError(RelayedError):
+    """Other 4xx — e.g. 400/422 validation errors."""
+
+class RelayedServerError(RelayedError):
+    """5xx — something went wrong on Relayed's end."""
+

relayed-0.0.1/tests/test_sdk.py

@@ -0,0 +1,23 @@
+# import uuid
+
+# from relayed.sdk.src.relayed.relayed_sdk import RelayedClient
+# import os
+# from dotenv import load_dotenv, find_dotenv
+# from pathlib import Path
+
+# load_dotenv(find_dotenv(), override=False)
+# relayed = RelayedClient(os.getenv("API_KEY"), base_url="http://localhost:8000")
+
+# subscription = relayed.create_subscription(
+#     destination_url="https://webhook.site/1a4b3201-2814-46b7-aa13-ababfa88b463",
+#     event_types=["test.event"],
+# )
+# print("subscription:", subscription["id"], "webhook_secret:", subscription["webhook_secret"])
+
+# result = relayed.send_event(
+#     event_type="test.event",
+#     payload={"message": "Hello from the SDK", "source": "test_sdk.py"},
+#     idempotency_key=str(uuid.uuid4()),
+# )
+
+# print("event:", result["event_id"], "deliveries:", result["delivery_ids"])