unique_stock_ticker 0.0.1__tar.gz

unique_stock_ticker-0.0.1/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2025-08-18
+- Initial release of `stock_ticker`.

unique_stock_ticker-0.0.1/LICENSE

@@ -0,0 +1 @@
+`unique_toolkit` is covered by the [`Unique License v1`](https://github.com/Unique-AG/license/releases/tag/unique-license.v1), unless the/a header or a nested LICENSE specifies another license.

unique_stock_ticker-0.0.1/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: unique_stock_ticker
+Version: 0.0.1
+Summary: 
+License: Proprietary
+Author: Martin Fadler
+Author-email: martin.fadler@unique.ch
+Requires-Python: >=3.11,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: numerize (>=0.12,<0.13)
+Requires-Dist: plotly (>=6.3.0,<7.0.0)
+Requires-Dist: pydantic (>=2.8.2,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.10.1,<3.0.0)
+Requires-Dist: pytest (>=8.4.1,<9.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
+Requires-Dist: unique-sdk (>=0.10.0,<0.11.0)
+Requires-Dist: unique-toolkit (>=0.8.12,<0.9.0)
+Description-Content-Type: text/markdown
+
+# Unique stock ticker
+
+stock ticker post processor.
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2025-08-18
+- Initial release of `stock_ticker`.

unique_stock_ticker-0.0.1/README.md

@@ -0,0 +1,3 @@
+# Unique stock ticker
+
+stock ticker post processor.

unique_stock_ticker-0.0.1/pyproject.toml

@@ -0,0 +1,44 @@
+[tool.poetry]
+name = "unique_stock_ticker"
+version = "0.0.1"
+description = ""
+authors = [
+    "Martin Fadler <martin.fadler@unique.ch>",
+    "Sadique Sheik <sadique@unique.ch>",
+    "Fabian Schläpfer <fabian@unique.ch>",
+    "Pascal Hauri <pascal@unique.ch>",
+]
+readme = ["README.md", "CHANGELOG.md"]
+license = "Proprietary"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+typing-extensions = "^4.9.0"
+pydantic = "^2.8.2"
+pydantic-settings = "^2.10.1"
+python-dotenv = "^1.0.1"
+unique-sdk = "^0.10.0"
+unique-toolkit = "^0.8.12"
+plotly = "^6.3.0"
+numerize = "^0.12"
+pytest = "^8.4.1"
+
+
+[tool.poetry.group.dev.dependencies]
+python = "^3.11"
+typing-extensions = "^4.9.0"
+pydantic = "^2.8.2"
+pydantic-settings = "^2.10.1"
+unique-sdk = { path = "../unique_sdk" }
+unique-toolkit = { path = "../unique_toolkit" }
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+target-version = "py311"
+
+[tool.ruff.lint]
+extend-select = ["I"]

unique_stock_ticker-0.0.1/unique_stock_ticker/__init__.py

@@ -0,0 +1,54 @@
+from unique_toolkit.stock_ticker.config import StockTickerConfig
+from unique_toolkit.stock_ticker.detection.config import StockTickerDetectionConfig
+from unique_toolkit.stock_ticker.detection.memory import (
+    StockTickerMemoryConfig,
+    StockTickerMemoryManager,
+    StockTickerMemorySchema,
+)
+from unique_toolkit.stock_ticker.detection.schema import (
+    StockTicker,
+    getStockTickersResponse,
+)
+from unique_toolkit.stock_ticker.detection.service import (
+    StockTickerService,
+    get_stock_ticker_service,
+)
+from unique_toolkit.stock_ticker.integrated import (
+    retrieve_tickers_and_plot_history,
+)
+from unique_toolkit.stock_ticker.plot.backend import (
+    NextPlottingBackend,
+    NextTickerPlotConfig,
+    PlotlyPlottingBackend,
+    PlotlyTickerPlotConfig,
+    PlottingBackend,
+    PlottingBackendName,
+    StockTickerDataRetrievalConfig,
+    find_and_plot_history_for_tickers,
+    find_history_for_tickers,
+    get_plotting_backend,
+)
+
+__all__ = [
+    "StockTickerDetectionConfig",
+    "StockTickerMemoryManager",
+    "StockTickerMemorySchema",
+    "StockTickerMemoryConfig",
+    "getStockTickersResponse",
+    "StockTickerService",
+    "StockTicker",
+    "StockTickerDataRetrievalConfig",
+    "find_and_plot_history_for_tickers",
+    "find_history_for_tickers",
+    "NextPlottingBackend",
+    "PlotlyPlottingBackend",
+    "PlottingBackend",
+    "PlottingBackendName",
+    "PlotlyTickerPlotConfig",
+    "NextTickerPlotConfig",
+    "get_stock_ticker_service",
+    "retrieve_tickers_and_plot_history",
+    "StockTickerDetectionConfig",
+    "get_plotting_backend",
+    "StockTickerConfig",
+]

unique_stock_ticker-0.0.1/unique_stock_ticker/clients/six/__init__.py

@@ -0,0 +1,17 @@
+from unique_stock_ticker.clients.six.client import (
+    SixApiClient,
+    get_six_api_client,
+)
+from unique_stock_ticker.clients.six.exception import (
+    NoCredentialsException,
+    SixApiException,
+    raise_errors_from_api_response,
+)
+
+__all__ = [
+    "SixApiClient",
+    "get_six_api_client",
+    "SixApiException",
+    "raise_errors_from_api_response",
+    "NoCredentialsException",
+]

unique_stock_ticker-0.0.1/unique_stock_ticker/clients/six/client.py

@@ -0,0 +1,151 @@
+import re
+import urllib.parse
+import urllib.request
+from typing import Any, Callable, ParamSpec, TypeVar
+
+import requests
+
+from unique_stock_ticker.clients.six.exception import NoCredentialsException
+from unique_stock_ticker.clients.six.http_adapter import InMemoryCertAdapter
+from unique_stock_ticker.clients.six.schema import (
+    BaseRequestParams,
+    BaseResponsePayload,
+)
+from unique_stock_ticker.clients.six.schema.end_of_day_history import (
+    EndOfDayHistoryRequestParams,
+    EndOfDayHistoryResponsePayload,
+)
+from unique_stock_ticker.clients.six.schema.entity_base import (
+    EntityBaseByListingRequestParams,
+    EntityBaseByListingResponsePayload,
+)
+from unique_stock_ticker.clients.six.schema.free_text_search import (
+    FreeTextEntitiesSearchResponsePayload,
+    FreeTextInstrumentsSearchResponsePayload,
+    FreeTextMarketsSearchResponsePayload,
+    FreeTextSearchEntitiesRequestParams,
+    FreeTextSearchInstrumentsRequestParams,
+    FreeTextSearchMarketsRequestParams,
+)
+from unique_stock_ticker.clients.six.schema.intraday_history import (
+    IntradayHistorySummaryRequestParams,
+    IntradayHistorySummaryResponsePayload,
+)
+from unique_stock_ticker.clients.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
+
+
+def get_six_api_client(company_id: str) -> SixApiClient:
+    from unique_stock_ticker.clients.six.settings import six_api_settings
+
+    creds = six_api_settings.creds_for_company(company_id)
+    if creds is None:
+        raise NoCredentialsException(company_id)
+    return SixApiClient(creds.cert, creds.key)

unique_stock_ticker-0.0.1/unique_stock_ticker/clients/six/exception.py

@@ -0,0 +1,31 @@
+
+
+from unique_toolkit.stock_ticker.clients.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)
+
+
+class NoCredentialsException(Exception): ...

unique_stock_ticker-0.0.1/unique_stock_ticker/clients/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_stock_ticker-0.0.1/unique_stock_ticker/clients/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_stock_ticker-0.0.1/unique_stock_ticker/clients/six/schema/__init__.py

@@ -0,0 +1,61 @@
+from unique_stock_ticker.clients.six.schema.common.base import (
+    BaseAPIModel,
+    BaseRequestParams,
+    BaseResponsePayload,
+)
+from unique_stock_ticker.clients.six.schema.common.entity import (
+    EntityStatus,
+    EntityType,
+)
+from unique_stock_ticker.clients.six.schema.common.instrument import (
+    ContractType,
+    ContractUnitType,
+    CurrentCouponType,
+    ExerciseType,
+    InstrumentStatus,
+    InstrumentType,
+    InstrumentUnitType,
+    MaturityType,
+    OptionType,
+)
+from unique_stock_ticker.clients.six.schema.common.language import Language
+from unique_stock_ticker.clients.six.schema.common.listing import (
+    ListingIdentifierScheme,
+    ListingStatus,
+)
+from unique_stock_ticker.clients.six.schema.common.lookup import LookupStatus
+from unique_stock_ticker.clients.six.schema.common.market import (
+    MarketStatus,
+    MarketType,
+    MicType,
+)
+from unique_stock_ticker.clients.six.schema.common.price import PriceAdjustment
+from unique_stock_ticker.clients.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_stock_ticker-0.0.1/unique_stock_ticker/clients/six/schema/common/base/__init__.py

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

unique_stock_ticker-0.0.1/unique_stock_ticker/clients/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_stock_ticker-0.0.1/unique_stock_ticker/clients/six/schema/common/base/request.py

@@ -0,0 +1,17 @@
+from enum import StrEnum
+
+from pydantic import Field
+
+from unique_stock_ticker.clients.six.schema.common.base.model import BaseAPIModel
+from unique_stock_ticker.clients.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=[])