destiny_sdk 0.1.0__tar.gz

destiny_sdk-0.1.0/LICENSE

@@ -0,0 +1,51 @@
+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, whether in Source or Object form, 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 any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to 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 otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently 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 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 a Contribution incorporated 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:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+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
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, 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 as an addendum 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 copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, 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 redistributing 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 consequential 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 any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional 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 act 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 such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

destiny_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.3
+Name: destiny_sdk
+Version: 0.1.0
+Summary: A software development kit (sdk) to support interaction with the DESTINY repository
+License: Apache 2.0
+Author: Adam Hamilton
+Author-email: adam@futureevidence.org
+Requires-Python: >=3.12,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: cachetools (>=5.5.2,<6.0.0)
+Requires-Dist: fastapi (>=0.115.12,<0.116.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: pydantic (>=2.11.3,<3.0.0)
+Requires-Dist: pytest (>=8.4.0,<9.0.0)
+Requires-Dist: pytest-asyncio (>=1.0.0,<2.0.0)
+Requires-Dist: pytest-httpx (>=0.35.0,<0.36.0)
+Requires-Dist: python-jose (>=3.4.0,<4.0.0)
+Description-Content-Type: text/markdown
+
+# DESTINY SDK
+
+SDK for interaction with the DESTINY repository. For now this just contains data models for validation and structuring, but will be built out to include convenience functions etc.
+
+## Documentation
+
+The documentation for destiny-sdk is hosted [here](https://destiny-evidence.github.io/destiny-repository/sdk/sdk.html)
+
+## Installation from PyPI
+
+```sh
+pip install destiny-sdk
+```
+
+```sh
+poetry add destiny-sdk
+```
+
+## Development
+
+### Dependencies
+
+```sh
+poetry install
+```
+
+### Tests
+
+```sh
+poetry run pytest
+```
+
+### Installing as an editable package of another project
+
+Run the following command in the root folder of the other project (assuming poetry as a packaging framework). Pip also has an `--editable` option that you can use.
+
+```sh
+poetry add --editable ./PATH/TO/sdk/
+```
+
+or replace the dependency in `pyproject.toml` with
+
+```toml
+destiny-sdk = {path = "./PATH/TO/sdk/", develop = true}
+```
+
+### Installing a local wheel
+
+If you want to use a local build of the sdk `z.whl`, do
+
+```sh
+poetry build
+poetry add ./PATH/TO/WHEEL.whl
+```
+
+### Publishing to test pypi
+
+```sh
+poetry config repositories.testpypi https://test.pypi.org/legacy/
+poetry config pypi-token.testpypi [YOUR_TESTPYPI_TOKEN]
+poetry publish --repository testpypi
+```
+
+## Publishing
+
+```sh
+poetry config pypi-token.pypi [YOUR_PYPI_TOKEN]
+poetry publish
+```
+

destiny_sdk-0.1.0/README.md

@@ -0,0 +1,69 @@
+# DESTINY SDK
+
+SDK for interaction with the DESTINY repository. For now this just contains data models for validation and structuring, but will be built out to include convenience functions etc.
+
+## Documentation
+
+The documentation for destiny-sdk is hosted [here](https://destiny-evidence.github.io/destiny-repository/sdk/sdk.html)
+
+## Installation from PyPI
+
+```sh
+pip install destiny-sdk
+```
+
+```sh
+poetry add destiny-sdk
+```
+
+## Development
+
+### Dependencies
+
+```sh
+poetry install
+```
+
+### Tests
+
+```sh
+poetry run pytest
+```
+
+### Installing as an editable package of another project
+
+Run the following command in the root folder of the other project (assuming poetry as a packaging framework). Pip also has an `--editable` option that you can use.
+
+```sh
+poetry add --editable ./PATH/TO/sdk/
+```
+
+or replace the dependency in `pyproject.toml` with
+
+```toml
+destiny-sdk = {path = "./PATH/TO/sdk/", develop = true}
+```
+
+### Installing a local wheel
+
+If you want to use a local build of the sdk `z.whl`, do
+
+```sh
+poetry build
+poetry add ./PATH/TO/WHEEL.whl
+```
+
+### Publishing to test pypi
+
+```sh
+poetry config repositories.testpypi https://test.pypi.org/legacy/
+poetry config pypi-token.testpypi [YOUR_TESTPYPI_TOKEN]
+poetry publish --repository testpypi
+```
+
+## Publishing
+
+```sh
+poetry config pypi-token.pypi [YOUR_PYPI_TOKEN]
+poetry publish
+```

destiny_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core"]
+
+[tool.poetry]
+authors = [
+    "Adam Hamilton <adam@futureevidence.org>",
+    "Andrew Harvey <andrew@futureevidence.org>",
+    "Daniel Breves <daniel@futureevidence.org>",
+    "Jack Walmisley <jack@futureevidence.org>",
+]
+description = "A software development kit (sdk) to support interaction with the DESTINY repository"
+license = "Apache 2.0"
+name = "destiny_sdk"
+readme = "README.md"
+version = "0.1.0"
+
+[tool.poetry.dependencies]
+cachetools = "^5.5.2"
+fastapi = "^0.115.12"
+httpx = "^0.28.1"
+pydantic = "^2.11.3"
+pytest = "^8.4.0"
+pytest-asyncio = "^1.0.0"
+pytest-httpx = "^0.35.0"
+python = "^3.12"
+python-jose = "^3.4.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.15.0"
+pytest-env = "^1.1.5"
+ruff = "^0.11.5"
+uvloop = "^0.21.0"
+
+[tool.pytest.ini_options]
+addopts = ["--color=yes", "--import-mode=importlib", "--verbose"]
+env = ["ENV=test"]
+norecursedirs = ["tests/e2e"]
+pythonpath = "."
+testpaths = ["tests"]

destiny_sdk-0.1.0/src/destiny_sdk/__init__.py

@@ -0,0 +1,23 @@
+"""The DESTINY SDK provides files for interacting with DESTINY repository."""
+
+from . import (
+    auth,
+    client,
+    enhancements,
+    identifiers,
+    imports,
+    references,
+    robots,
+    visibility,
+)
+
+__all__ = [
+    "auth",
+    "client",
+    "enhancements",
+    "identifiers",
+    "imports",
+    "references",
+    "robots",
+    "visibility",
+]

destiny_sdk-0.1.0/src/destiny_sdk/auth.py

@@ -0,0 +1,204 @@
+"""HMAC authentication assistance methods."""
+
+import hashlib
+import hmac
+import time
+from typing import Protocol, Self
+from uuid import UUID
+
+from fastapi import HTTPException, Request, status
+from pydantic import UUID4, BaseModel
+
+FIVE_MINUTES = 60 * 5
+
+
+class AuthException(HTTPException):
+    """
+    An exception related to HTTP authentication.
+
+    Raised by implementations of the AuthMethod protocol.
+
+    .. code-block:: python
+
+        raise AuthException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Unable to parse authentication token.",
+        )
+
+    """
+
+
+def create_signature(
+    secret_key: str, request_body: bytes, client_id: UUID4, timestamp: float
+) -> str:
+    """
+    Create an HMAC signature using SHA256.
+
+    :param secret_key: secret key with which to encrypt message
+    :type secret_key: bytes
+    :param request_body: request body to be encrypted
+    :type request_body: bytes
+    :param client_id: client id to include in hmac
+    :type: UUID4
+    :param timestamp: timestamp for when the request is sent
+    :type: float
+    :return: encrypted hexdigest of the request body with the secret key
+    :rtype: str
+    """
+    timestamp_bytes = f"{timestamp}".encode()
+    signature_components = b":".join([request_body, client_id.bytes, timestamp_bytes])
+    return hmac.new(
+        secret_key.encode(), signature_components, hashlib.sha256
+    ).hexdigest()
+
+
+class HMACAuthorizationHeaders(BaseModel):
+    """
+    The HTTP authorization headers required for HMAC authentication.
+
+    Expects the following headers to be present in the request
+
+    - Authorization: Signature [request signature]
+    - X-Client-Id: [UUID]
+    - X-Request-Timestamp: [float]
+    """
+
+    signature: str
+    client_id: UUID4
+    timestamp: float
+
+    @classmethod
+    def from_request(cls, request: Request) -> Self:
+        """
+        Get the required headers for HMAC authentication.
+
+        :param request: The incoming request
+        :type request: Request
+        :raises AuthException: Authorization header is missing
+        :raises AuthException: Authorization type not supported
+        :raises AuthException: X-Client-Id header is missing
+        :raises AuthException: Client id format is invalid
+        :raises AuthException: X-Request-Timestamp header is missing
+        :raises AuthException: Request timestamp has expired
+        :return: Header values necessary for authenticating the request
+        :rtype: HMACAuthorizationHeaders
+        """
+        signature_header = request.headers.get("Authorization")
+
+        if not signature_header:
+            raise AuthException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="Authorization header missing.",
+            )
+
+        scheme, _, signature = signature_header.partition(" ")
+
+        if scheme != "Signature":
+            raise AuthException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="Authorization type not supported.",
+            )
+
+        client_id = request.headers.get("X-Client-Id")
+
+        if not client_id:
+            raise AuthException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="X-Client-Id header missing",
+            )
+
+        try:
+            UUID(client_id)
+        except (ValueError, TypeError) as exc:
+            raise AuthException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="Invalid format for client id, expected UUID4.",
+            ) from exc
+
+        timestamp = request.headers.get("X-Request-Timestamp")
+
+        if not timestamp:
+            raise AuthException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="X-Request-Timestamp header missing",
+            )
+
+        if (time.time() - float(timestamp)) > FIVE_MINUTES:
+            raise AuthException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="Request timestamp has expired.",
+            )
+
+        return cls(signature=signature, client_id=client_id, timestamp=timestamp)
+
+
+class HMACAuthMethod(Protocol):
+    """
+    Protocol for HMAC auth methods, enforcing the implmentation of __call__().
+
+    This allows FastAPI to call class instances as depenedencies in FastAPI routes,
+    see https://fastapi.tiangolo.com/advanced/advanced-dependencies
+
+        .. code-block:: python
+
+            auth = HMACAuthMethod()
+
+            router = APIRouter(
+                prefix="/robots", tags=["robot"], dependencies=[Depends(auth)]
+            )
+    """
+
+    async def __call__(self, request: Request) -> bool:
+        """
+        Callable interface to allow use as a dependency.
+
+        :param request: The request to verify
+        :type request: Request
+        :raises NotImplementedError: __call__() method has not been implemented.
+        :return: True if authorization is successful.
+        :rtype: bool
+        """
+        raise NotImplementedError
+
+
+class HMACAuth(HMACAuthMethod):
+    """Adds HMAC auth when used as a router or endpoint dependency."""
+
+    def __init__(self, secret_key: str) -> None:
+        """Initialise HMAC auth with a given secret key."""
+        self.secret_key = secret_key
+
+    async def __call__(self, request: Request) -> bool:
+        """Perform Authorization check."""
+        auth_headers = HMACAuthorizationHeaders.from_request(request)
+        request_body = await request.body()
+        expected_signature = create_signature(
+            self.secret_key,
+            request_body,
+            auth_headers.client_id,
+            auth_headers.timestamp,
+        )
+
+        if not hmac.compare_digest(auth_headers.signature, expected_signature):
+            raise AuthException(
+                status_code=status.HTTP_401_UNAUTHORIZED, detail="Signature is invalid."
+            )
+
+        return True
+
+
+class BypassHMACAuth(HMACAuthMethod):
+    """
+    A fake auth class that will always respond successfully.
+
+    Intended for use in local environments and for testing.
+
+    Not for production use!
+    """
+
+    async def __call__(
+        self,
+        request: Request,  # noqa: ARG002
+    ) -> bool:
+        """Bypass Authorization check."""
+        return True

destiny_sdk-0.1.0/src/destiny_sdk/client.py

@@ -0,0 +1,113 @@
+"""Send authenticated requests to Destiny Repository."""
+
+import time
+from collections.abc import Generator
+
+import httpx
+from pydantic import UUID4, HttpUrl
+
+from destiny_sdk.robots import (
+    BatchEnhancementRequestRead,
+    BatchRobotResult,
+    EnhancementRequestRead,
+    RobotResult,
+)
+
+from .auth import create_signature
+
+
+class HMACSigningAuth(httpx.Auth):
+    """Client that adds an HMAC signature to a request."""
+
+    requires_request_body = True
+
+    def __init__(self, secret_key: str, client_id: UUID4) -> None:
+        """
+        Initialize the client.
+
+        :param secret_key: the key to use when signing the request
+        :type secret_key: str
+        """
+        self.secret_key = secret_key
+        self.client_id = client_id
+
+    def auth_flow(
+        self, request: httpx.Request
+    ) -> Generator[httpx.Request, httpx.Response]:
+        """
+        Add a signature to the given request.
+
+        :param request: request to be sent with signature
+        :type request: httpx.Request
+        :yield: Generator for Request with signature headers set
+        :rtype: Generator[httpx.Request, httpx.Response]
+        """
+        timestamp = time.time()
+        signature = create_signature(
+            self.secret_key, request.content, self.client_id, timestamp
+        )
+        request.headers["Authorization"] = f"Signature {signature}"
+        request.headers["X-Client-Id"] = f"{self.client_id}"
+        request.headers["X-Request-Timestamp"] = f"{timestamp}"
+        yield request
+
+
+class Client:
+    """
+    Client for interaction with the Destiny API.
+
+    Current implementation only supports robot results.
+    """
+
+    def __init__(self, base_url: HttpUrl, secret_key: str, client_id: UUID4) -> None:
+        """
+        Initialize the client.
+
+        :param base_url: The base URL for the Destiny Repository API.
+        :type base_url: HttpUrl
+        :param secret_key: The secret key for signing requests
+        :type auth_method: str
+        """
+        self.session = httpx.Client(
+            base_url=str(base_url),
+            headers={"Content-Type": "application/json"},
+            auth=HMACSigningAuth(secret_key=secret_key, client_id=client_id),
+        )
+
+    def send_robot_result(self, robot_result: RobotResult) -> EnhancementRequestRead:
+        """
+        Send a RobotResult to destiny repository.
+
+        Signs the request with the client's secret key.
+
+        :param robot_result: The Robot Result to send
+        :type robot_result: RobotResult
+        :return: The EnhancementRequestRead object from the response.
+        :rtype: EnhancementRequestRead
+        """
+        response = self.session.post(
+            "/robot/enhancement/single/",
+            json=robot_result.model_dump(mode="json"),
+        )
+        response.raise_for_status()
+        return EnhancementRequestRead.model_validate(response.json())
+
+    def send_batch_robot_result(
+        self, batch_robot_result: BatchRobotResult
+    ) -> BatchEnhancementRequestRead:
+        """
+        Send a BatchRobotResult to destiny repository.
+
+        Signs the request with the client's secret key.
+
+        :param batch_robot_result: The Batch Robot Result to send
+        :type batch_robot_result: BatchRobotResult
+        :return: The BatchEnhancementRequestRead object from the response.
+        :rtype: BatchEnhancementRequestRead
+        """
+        response = self.session.post(
+            "/robot/enhancement/batch/",
+            json=batch_robot_result.model_dump(mode="json"),
+        )
+        response.raise_for_status()
+        return BatchEnhancementRequestRead.model_validate(response.json())

destiny_sdk-0.1.0/src/destiny_sdk/core.py

@@ -0,0 +1,35 @@
+"""Core classes for the Destiny SDK, not exposed to package users."""
+
+from typing import Self
+
+from pydantic import BaseModel
+
+
+class _JsonlFileInputMixIn(BaseModel):
+    """
+    A mixin class for models that are used at the top-level for entries in .jsonl files.
+
+    This class is used to define a common interface for file input models.
+    It is not intended to be used directly.
+    """
+
+    def to_jsonl(self) -> str:
+        """
+        Convert the model to a JSONL string.
+
+        :return: The JSONL string representation of the model.
+        :rtype: str
+        """
+        return self.model_dump_json(exclude_none=True)
+
+    @classmethod
+    def from_jsonl(cls, jsonl: str) -> Self:
+        """
+        Create an object from a JSONL string.
+
+        :param jsonl: The JSONL string to parse.
+        :type jsonl: str
+        :return: The created object.
+        :rtype: Self
+        """
+        return cls.model_validate_json(jsonl)