unique-six 0.1.3__tar.gz

unique_six-0.1.3/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.3
+Name: unique-six
+Version: 0.1.3
+Summary: Unique Six API client
+Author: Ahmed Jellouli, Azeez Raheem
+Author-email: Ahmed Jellouli <ahmed.jellouli.ext@unique.ch>, Azeez Raheem <azeez.raheem.ext@unique.ai>
+License: Proprietary
+Requires-Dist: pydantic>=2.12.4
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: unique-toolkit>=1.50.4
+Requires-Dist: cryptography>=46.0.5
+Requires-Dist: pyopenssl>=25.0.0
+Requires-Dist: requests>=2.32.0
+Requires-Dist: urllib3>=2.0.0
+Requires-Python: >=3.12, <4
+Description-Content-Type: text/markdown
+
+# Unique Six Connector
+
+A Python connector library for the [Six API](https://api.six-group.com/web/), providing easy access to end of day history, free text search, intraday history, intraday snapshot and entity listing.
+
+
+## Installation
+
+```bash
+poetry add unique_six
+```
+
+Or using pip:
+
+```bash
+pip install unique_six
+```
+
+```bash
+# Clone the repository
+git clone <repository_url>
+cd unique_six
+
+# Install dependencies
+poetry install
+
+# Run linting
+poetry run ruff check .
+
+# Run formatting
+poetry run ruff format .
+```
+
+
+## License
+
+Proprietary
+
+## Authors
+
+- Ahmed Jellouli <ahmed.jellouli.ext@unique.ch>
+
+## Support
+
+For issues and questions, please contact the maintainers or refer to the [Six API documentation](https://developer.six-group.com/en/home.html).

unique_six-0.1.3/README.md

@@ -0,0 +1,44 @@
+# Unique Six Connector
+
+A Python connector library for the [Six API](https://api.six-group.com/web/), providing easy access to end of day history, free text search, intraday history, intraday snapshot and entity listing.
+
+
+## Installation
+
+```bash
+poetry add unique_six
+```
+
+Or using pip:
+
+```bash
+pip install unique_six
+```
+
+```bash
+# Clone the repository
+git clone <repository_url>
+cd unique_six
+
+# Install dependencies
+poetry install
+
+# Run linting
+poetry run ruff check .
+
+# Run formatting
+poetry run ruff format .
+```
+
+
+## License
+
+Proprietary
+
+## Authors
+
+- Ahmed Jellouli <ahmed.jellouli.ext@unique.ch>
+
+## Support
+
+For issues and questions, please contact the maintainers or refer to the [Six API documentation](https://developer.six-group.com/en/home.html).

unique_six-0.1.3/pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "unique_six"
+version = "0.1.3"
+description = "Unique Six API client"
+authors = [
+    { name = "Ahmed Jellouli", email = "ahmed.jellouli.ext@unique.ch" },
+    { name = "Azeez Raheem", email = "azeez.raheem.ext@unique.ai" },
+]
+readme = "README.md"
+license = { text = "Proprietary" }
+requires-python = ">=3.12,<4"
+dependencies = [
+    "pydantic>=2.12.4",
+    "python-dotenv>=1.0.1",
+    "unique-toolkit>=1.50.4",
+    "cryptography>=46.0.5",
+    "pyopenssl>=25.0.0",
+    "requests>=2.32.0",
+    "urllib3>=2.0.0",
+]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.12.10",
+    "pytest>=8.0.0",
+    "pytest-cov>=4.1.0",
+    "pytest-mock>=3.12.0",
+    "responses>=0.25.0",
+    "deptry>=0.24.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.7.19,<0.8"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = ""
+
+[tool.uv]
+constraint-dependencies = ["lxml>=5.0.0"]
+
+[tool.uv.sources]
+unique-toolkit = { path = "../../unique_toolkit", editable = true }
+
+[tool.ruff]
+target-version = "py311"
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.deptry]
+known_first_party = ["unique_six"]
+extend_exclude = ["tests", "conftest.py"]
+
+[tool.deptry.per_rule_ignores]
+DEP002 = ["python-dotenv", "unique-toolkit", "pyopenssl"]
+
+[tool.pytest.ini_options]
+addopts = "--strict-markers"
+asyncio_mode = "auto"
+markers = [
+    "unit: for unit tests",
+    "integration: for integration tests that require API credentials",
+    "serial",
+    "asyncio: for async tests",
+    "ai: AI-authored test",
+]
+filterwarnings = [
+    "ignore:DeprecationWarning",
+]

unique_six-0.1.3/unique_six/__init__.py

@@ -0,0 +1,13 @@
+from unique_six.client import (
+    SixApiClient,
+)
+from unique_six.exception import (
+    SixApiException,
+    raise_errors_from_api_response,
+)
+
+__all__ = [
+    "SixApiClient",
+    "SixApiException",
+    "raise_errors_from_api_response",
+]

unique_six-0.1.3/unique_six/client.py

@@ -0,0 +1,137 @@
+import re
+import urllib.parse
+import urllib.request
+from typing import Any, Callable, ParamSpec, TypeVar
+
+import requests
+
+from unique_six.http_adapter import InMemoryCertAdapter
+from unique_six.schema import (
+    BaseRequestParams,
+    BaseResponsePayload,
+)
+from unique_six.schema.end_of_day_history import (
+    EndOfDayHistoryRequestParams,
+    EndOfDayHistoryResponsePayload,
+)
+from unique_six.schema.entity_base import (
+    EntityBaseByListingRequestParams,
+    EntityBaseByListingResponsePayload,
+)
+from unique_six.schema.free_text_search import (
+    FreeTextEntitiesSearchResponsePayload,
+    FreeTextInstrumentsSearchResponsePayload,
+    FreeTextMarketsSearchResponsePayload,
+    FreeTextSearchEntitiesRequestParams,
+    FreeTextSearchInstrumentsRequestParams,
+    FreeTextSearchMarketsRequestParams,
+)
+from unique_six.schema.intraday_history import (
+    IntradayHistorySummaryRequestParams,
+    IntradayHistorySummaryResponsePayload,
+)
+from unique_six.schema.intraday_snapshot import (
+    IntradaySnapshotRequestParams,
+    IntradaySnapshotResponsePayload,
+)
+
+API_URL = "https://api.six-group.com/web/"
+
+
+def split_cert_chain(cert: str) -> list[str]:
+    return re.findall(".*?-----END CERTIFICATE-----", cert, re.DOTALL)
+
+
+class SixApiClient:
+    def __init__(self, cert: str, key: str) -> None:
+        self._session = requests.Session()
+        self._session.headers = {"accept": "application/json"}
+        self._url = API_URL
+
+        certs = [c.encode("utf-8") for c in split_cert_chain(cert)]
+        cert_adapter = InMemoryCertAdapter(
+            certs[0],
+            key.encode("utf-8"),
+            certs[1:],
+        )
+        self._session.mount(self._url, cert_adapter)
+
+        # Endpoints
+        self.end_of_day_history = endpoint(
+            self,
+            "v1/listings/marketData/endOfDayHistory",
+            EndOfDayHistoryRequestParams,
+            EndOfDayHistoryResponsePayload,
+        )
+        self.free_text_search_instruments = endpoint(
+            self,
+            "v1/search/freeTextSearch/instruments",
+            FreeTextSearchInstrumentsRequestParams,
+            FreeTextInstrumentsSearchResponsePayload,
+        )
+        self.free_text_search_entities = endpoint(
+            self,
+            "v1/search/freeTextSearch/entities",
+            FreeTextSearchEntitiesRequestParams,
+            FreeTextEntitiesSearchResponsePayload,
+        )
+        self.free_text_search_markets = endpoint(
+            self,
+            "v1/search/freeTextSearch/markets",
+            FreeTextSearchMarketsRequestParams,
+            FreeTextMarketsSearchResponsePayload,
+        )
+        self.intraday_history_summary = endpoint(
+            self,
+            "v1/listings/marketData/intradayHistory/summary",
+            IntradayHistorySummaryRequestParams,
+            IntradayHistorySummaryResponsePayload,
+        )
+        self.intraday_snapshot = endpoint(
+            self,
+            "v1/listings/marketData/intradaySnapshot",
+            IntradaySnapshotRequestParams,
+            IntradaySnapshotResponsePayload,
+        )
+        self.entity_base_by_listing = endpoint(
+            self,
+            "v1/listings/referenceData/entityBase",
+            EntityBaseByListingRequestParams,
+            EntityBaseByListingResponsePayload,
+        )
+
+    def request(self, end_point: str, params: dict[str, Any]) -> dict[str, Any]:
+        complete_url = f"{self._url}{end_point}?{urllib.parse.urlencode(params)}"
+        response = self._session.get(complete_url)
+        response.raise_for_status()
+        return response.json()
+
+
+ResponseType = TypeVar("ResponseType", bound=BaseResponsePayload)
+RequestType = TypeVar("RequestType", bound=BaseRequestParams)
+RequestConstructorSpec = ParamSpec("RequestConstructorSpec")
+
+
+def endpoint(
+    client: SixApiClient,
+    url: str,
+    params: Callable[RequestConstructorSpec, RequestType],
+    response_type: type[ResponseType],
+) -> Callable[RequestConstructorSpec, ResponseType]:
+    def endpoint_f(
+        *args: RequestConstructorSpec.args,
+        **kwargs: RequestConstructorSpec.kwargs,
+    ) -> ResponseType:
+        return response_type.model_validate(
+            client.request(
+                url,
+                params(*args, **kwargs).model_dump(
+                    exclude_unset=True,
+                    by_alias=True,
+                    exclude_defaults=True,
+                    mode="json",
+                ),
+            )
+        )
+
+    return endpoint_f

unique_six-0.1.3/unique_six/exception.py

@@ -0,0 +1,29 @@
+from unique_six.schema.common.base.response import (
+    BaseResponsePayload,
+    ErrorDetail,
+)
+
+
+def error_to_str(error: ErrorDetail) -> str:
+    error_str = f"Error {error.code}: {error.category}"
+    if error.message:
+        error_str += f": {error.message}"
+    return error_str
+
+
+class SixApiException(Exception):
+    def __init__(self, errors: list[ErrorDetail]) -> None:
+        self.errors = errors
+
+    def __str__(self) -> str:
+        if len(self.errors) == 1:
+            return error_to_str(self.errors[0])
+        else:
+            return "Errors:\n" + "\n".join(
+                [error_to_str(error) for error in self.errors]
+            )
+
+
+def raise_errors_from_api_response(response: BaseResponsePayload) -> None:
+    if response.errors is not None and len(response.errors) > 0:
+        raise SixApiException(response.errors)

unique_six-0.1.3/unique_six/get_creds.sh

@@ -0,0 +1,110 @@
+#!/bin/bash
+
+set -euo pipefail
+
+show_usage() {
+	cat <<EOF
+Usage: $0 --cert|-c CERT_FILE --key|-k KEY_FILE [--output|-o OUTPUT_FILE]
+
+Encode certificate and key files into a base64-encoded string
+
+Options:
+  -c, --cert CERT_FILE    Path to the certificate file
+  -k, --key KEY_FILE      Path to the private key file  
+  -o, --output OUTPUT_FILE Output file to write the result (if not specified, prints to stdout)
+  -h, --help              Show this help message
+
+Examples:
+  $0 --cert cert.pem --key key.pem
+  $0 -c /path/to/cert.crt -k /path/to/private.key
+  $0 -c cert.pem -k key.pem -o encoded_creds.txt
+EOF
+}
+
+get_creds() {
+	local cert_path="$1"
+	local key_path="$2"
+
+	if [[ ! -f "$cert_path" ]]; then
+		echo "Error: Certificate file not found: $cert_path" >&2
+		exit 1
+	fi
+
+	if [[ ! -f "$key_path" ]]; then
+		echo "Error: Key file not found: $key_path" >&2
+		exit 1
+	fi
+
+	if ! cert_content=$(cat "$cert_path" 2>/dev/null); then
+		echo "Error reading certificate file: $cert_path" >&2
+		exit 1
+	fi
+
+	if ! key_content=$(cat "$key_path" 2>/dev/null); then
+		echo "Error reading key file: $key_path" >&2
+		exit 1
+	fi
+
+	cert_escaped=$(printf '%s' "$cert_content" | tr -d '\n')
+	key_escaped=$(printf '%s' "$key_content" | tr -d '\n')
+
+	content="[\"$cert_escaped\",\"$key_escaped\"]"
+	echo -n "$content" | base64
+}
+
+cert_path=""
+key_path=""
+output_file=""
+
+while [[ $# -gt 0 ]]; do
+	case $1 in
+	-c | --cert)
+		cert_path="$2"
+		shift 2
+		;;
+	-k | --key)
+		key_path="$2"
+		shift 2
+		;;
+	-o | --output)
+		output_file="$2"
+		shift 2
+		;;
+	-h | --help)
+		show_usage
+		exit 0
+		;;
+	*)
+		echo "Error: Unknown option $1" >&2
+		show_usage
+		exit 1
+		;;
+	esac
+done
+
+if [[ -z "$cert_path" ]]; then
+	echo "Error: Certificate file path is required" >&2
+	show_usage
+	exit 1
+fi
+
+if [[ -z "$key_path" ]]; then
+	echo "Error: Key file path is required" >&2
+	show_usage
+	exit 1
+fi
+
+if ! encoded_creds=$(get_creds "$cert_path" "$key_path"); then
+	echo "Error processing files" >&2
+	exit 1
+fi
+
+if [[ -n "$output_file" ]]; then
+	if ! echo "$encoded_creds" >"$output_file"; then
+		echo "Error writing to output file: $output_file" >&2
+		exit 1
+	fi
+	echo "Encoded credentials written to: $output_file"
+else
+	echo "$encoded_creds"
+fi

unique_six-0.1.3/unique_six/http_adapter.py

@@ -0,0 +1,47 @@
+from typing import Iterable
+
+from cryptography.hazmat.primitives.serialization import load_pem_private_key
+from cryptography.x509 import load_pem_x509_certificate
+from requests.adapters import HTTPAdapter
+from urllib3.contrib.pyopenssl import (
+    PyOpenSSLContext,
+)
+from urllib3.util.ssl_ import PROTOCOL_TLS_CLIENT
+
+
+class InMemoryCertAdapter(HTTPAdapter):
+    def __init__(
+        self,
+        cert: bytes,
+        key: bytes,
+        chain_certs: Iterable[bytes] | None = None,
+        *args,
+        **kwargs,
+    ) -> None:
+        self._chain_certs = tuple(chain_certs) if chain_certs else None
+        self._cert = cert
+        self._key = key
+        super().__init__(*args, **kwargs)
+
+    def init_poolmanager(self, *args, **kwargs):
+        context = self._create_ssl_context()
+        kwargs["ssl_context"] = context
+        return super().init_poolmanager(*args, **kwargs)
+
+    def _create_ssl_context(self) -> PyOpenSSLContext:
+        context = PyOpenSSLContext(PROTOCOL_TLS_CLIENT)
+        context.set_default_verify_paths()
+
+        context._ctx.use_certificate(load_pem_x509_certificate(self._cert))
+        if self._chain_certs is not None:
+            for c in self._chain_certs:
+                context._ctx.add_extra_chain_cert(load_pem_x509_certificate(c))
+
+        context._ctx.use_privatekey(
+            load_pem_private_key(self._key, password=None)  # type: ignore
+        )
+
+        # Throw an exception if the private key is not valid
+        context._ctx.check_privatekey()
+
+        return context

unique_six-0.1.3/unique_six/schema/__init__.py

@@ -0,0 +1,61 @@
+from unique_six.schema.common.base import (
+    BaseAPIModel,
+    BaseRequestParams,
+    BaseResponsePayload,
+)
+from unique_six.schema.common.entity import (
+    EntityStatus,
+    EntityType,
+)
+from unique_six.schema.common.instrument import (
+    ContractType,
+    ContractUnitType,
+    CurrentCouponType,
+    ExerciseType,
+    InstrumentStatus,
+    InstrumentType,
+    InstrumentUnitType,
+    MaturityType,
+    OptionType,
+)
+from unique_six.schema.common.language import Language
+from unique_six.schema.common.listing import (
+    ListingIdentifierScheme,
+    ListingStatus,
+)
+from unique_six.schema.common.lookup import LookupStatus
+from unique_six.schema.common.market import (
+    MarketStatus,
+    MarketType,
+    MicType,
+)
+from unique_six.schema.common.price import PriceAdjustment
+from unique_six.schema.common.security import (
+    SecurityType,
+)
+
+__all__ = [
+    "BaseAPIModel",
+    "BaseRequestParams",
+    "BaseResponsePayload",
+    "ListingIdentifierScheme",
+    "InstrumentType",
+    "InstrumentStatus",
+    "InstrumentUnitType",
+    "SecurityType",
+    "Language",
+    "ContractType",
+    "CurrentCouponType",
+    "ContractUnitType",
+    "OptionType",
+    "ExerciseType",
+    "MaturityType",
+    "EntityType",
+    "EntityStatus",
+    "MarketType",
+    "MicType",
+    "MarketStatus",
+    "PriceAdjustment",
+    "ListingStatus",
+    "LookupStatus",
+]

unique_six-0.1.3/unique_six/schema/common/base/__init__.py

@@ -0,0 +1,7 @@
+from unique_six.schema.common.base.model import BaseAPIModel
+from unique_six.schema.common.base.request import BaseRequestParams
+from unique_six.schema.common.base.response import (
+    BaseResponsePayload,
+)
+
+__all__ = ["BaseAPIModel", "BaseRequestParams", "BaseResponsePayload"]

unique_six-0.1.3/unique_six/schema/common/base/model.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, ConfigDict
+from pydantic.alias_generators import to_camel
+
+
+class BaseAPIModel(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+        alias_generator=to_camel,
+        use_enum_values=True,
+    )

unique_six-0.1.3/unique_six/schema/common/base/request.py

@@ -0,0 +1,17 @@
+from enum import StrEnum
+
+from pydantic import Field
+
+from unique_six.schema.common.base.model import BaseAPIModel
+from unique_six.schema.common.language import Language
+
+
+class RequestExtension(StrEnum):
+    EXPLAIN = "EXPLAIN"
+    DATA_STATUS = "DATA_STATUS"
+    DATASET_IDS = "DATASET_IDS"
+
+
+class BaseRequestParams(BaseAPIModel):
+    preferred_language: Language = Field(default=Language.EN)
+    extensions: list[RequestExtension] = Field(default=[])