spotlight-sdk 0.0.0__tar.gz

spotlight-sdk-0.0.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.1
+Name: spotlight-sdk
+Version: 0.0.0
+Summary: Spotlight Python SDK
+Home-page: https://spotlight.dev
+Author: Spotlight
+Author-email: hello@spotlight.dev
+License: UNKNOWN
+Description: # Spotlight: The OTC Commodity Research Platform
+        
+        ## Overview
+        
+        **[Spotlight](https://spotlight.dev/)** is the world's first OTC commodity research platform. Stay on top of market
+        trends, discover new product opportunities, and win more sales.
+        
+        The [Spotlight SDK](https://pypi.org/project/spotlight-sdk/) enables you to programmatically query dataset configurations and data.
+        
+        ## Installation
+        
+        Set the following environment variables for your username and password for
+        the [Spotlight platform](https://app.spotlight.dev/).
+        
+        ```text
+        SPOTLIGHT_USER=<username>
+        SPOTLIGHT_PWD=<password>
+        ```
+        
+        ## Support
+        
+        If you need help or have feedback, please email us at [support@spotlight.dev](mailto:support@spotlight.dev).
+        
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown

spotlight-sdk-0.0.0/README.md

@@ -0,0 +1,22 @@
+# Spotlight: The OTC Commodity Research Platform
+
+## Overview
+
+**[Spotlight](https://spotlight.dev/)** is the world's first OTC commodity research platform. Stay on top of market
+trends, discover new product opportunities, and win more sales.
+
+The [Spotlight SDK](https://pypi.org/project/spotlight-sdk/) enables you to programmatically query dataset configurations and data.
+
+## Installation
+
+Set the following environment variables for your username and password for
+the [Spotlight platform](https://app.spotlight.dev/).
+
+```text
+SPOTLIGHT_USER=<username>
+SPOTLIGHT_PWD=<password>
+```
+
+## Support
+
+If you need help or have feedback, please email us at [support@spotlight.dev](mailto:support@spotlight.dev).

spotlight-sdk-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

spotlight-sdk-0.0.0/setup.py

@@ -0,0 +1,50 @@
+import subprocess
+
+import setuptools
+
+try:
+    import pypandoc
+
+    long_description = pypandoc.convert_file('README.md', 'rst')
+except(IOError, ImportError):
+    long_description = open('README.md').read()
+
+
+def get_tag():
+    tag = subprocess.getoutput('git tag --sort=version:refname | tail -n1')
+    commits = subprocess.getoutput(f'git rev-list {tag}..HEAD --count')
+    return f'{tag}.{commits}'
+
+
+setuptools.setup(
+    name="spotlight-sdk",
+    version=get_tag(),
+    author="Spotlight",
+    author_email="hello@spotlight.dev",
+    description="Spotlight Python SDK",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://spotlight.dev",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent"
+    ],
+    python_requires=">=3.7",
+    packages=setuptools.find_packages(
+        include=['spotlight*'],
+        exclude=['tests.*']
+    ),
+    install_requires=[
+        "requests==2.28.1",
+        "aiohttp>=3.8.4",
+        "pandas>=2.0.1",
+        "duckdb>=0.7.1",
+        "trycast>=1.0.0",
+        "pydash>=7.0.3",
+        "cachetools>=5.3.0",
+        "pydantic>=1.10.7",
+        "aiocache>=0.12.1",
+        "backoff>=2.2.1",
+        "asyncstdlib>=3.10.7"
+    ]
+)

spotlight-sdk-0.0.0/spotlight/__init__.py

@@ -0,0 +1,3 @@
+"""
+Spotlight software development kit.
+"""

spotlight-sdk-0.0.0/spotlight/api/auth/__init__.py

@@ -0,0 +1,9 @@
+"""
+Auth API.
+"""
+from spotlight.api.auth.asynchronous import (
+    async_login,
+    async_refresh_token,
+    async_exchange_token,
+)
+from spotlight.api.auth.synchronous import login, refresh_token, exchange_token

spotlight-sdk-0.0.0/spotlight/api/auth/__util.py

@@ -0,0 +1,49 @@
+from typing import Optional
+
+from spotlight.core.common.config import EnvironmentConfig
+
+config = EnvironmentConfig()
+
+
+def _login_request_info(
+    username: str, password: str, scope: Optional[str] = None
+) -> dict:
+    data = {
+        "client_id": "spotlight-api",
+        "grant_type": "password",
+        "username": username,
+        "password": password,
+    }
+    if scope is not None:
+        data.update({"scope": scope})
+
+    return {
+        "url": f"{config.get_url('keycloak')}/protocol/openid-connect/token",
+        "data": data,
+    }
+
+
+def _refresh_token_request_info(refresh_token: Optional[str] = None) -> dict:
+    return {
+        "url": f"{config.get_url('keycloak')}/protocol/openid-connect/token",
+        "data": {
+            "client_id": "spotlight-api",
+            "grant_type": "refresh_token",
+            "refresh_token": refresh_token,
+        },
+    }
+
+
+def _token_exchange_request_info(requested_subject: str, subject_token: str) -> dict:
+    data = {
+        "client_id": "spotlight-api",
+        "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
+        "requested_subject": requested_subject,
+        "subject_token": subject_token,
+        "scope": "offline_access",
+    }
+
+    return {
+        "url": f"{config.get_url('keycloak')}/protocol/openid-connect/token",
+        "data": data,
+    }

spotlight-sdk-0.0.0/spotlight/api/auth/asynchronous.py

@@ -0,0 +1,69 @@
+"""
+Asynchronous auth API requests.
+"""
+from typing import Optional
+
+import aiohttp
+from requests import Response
+
+from spotlight.api.auth.__util import (
+    _login_request_info,
+    _refresh_token_request_info,
+    _token_exchange_request_info,
+)
+from spotlight.core.common.function import build_response_obj
+
+
+async def async_login(
+    username: str, password: str, scope: Optional[str] = None
+) -> Response:
+    """
+    Asynchronously login.
+
+    Args:
+        username (str): Username
+        password (str): Password
+        scope (Optional[str]): Token scope, such as 'offline_access'
+
+    Returns:
+        dict: Authentication/authorization response
+    """
+    request_info = _login_request_info(username, password, scope)
+    async with aiohttp.ClientSession() as session:
+        async with session.post(**request_info) as response:
+            return await build_response_obj(response)
+
+
+async def async_refresh_token(token: Optional[str]) -> Response:
+    """
+    Asynchronously refresh token. To get an offline access token, initial authentication (login) needs to use the scope
+    'offline_access', then an offline token can be created using the refresh_token in the authentication response.
+    [Stack overflow reference](https://stackoverflow.com/questions/69207734/keycloak-offline-access-token-with-refresh-token-grant-type).
+
+    Args:
+        token (str): Refresh token
+
+    Returns:
+        dict: Authentication/authorization response
+    """
+    request_info = _refresh_token_request_info(token)
+    async with aiohttp.ClientSession() as session:
+        async with session.post(**request_info) as response:
+            return await build_response_obj(response)
+
+
+async def async_exchange_token(requested_subject: str, subject_token: str) -> Response:
+    """
+    Asynchronously exchange token.
+
+    Args:
+        requested_subject (str): Request subject (Username or ID)
+        subject_token (str): Token to swap
+
+    Returns:
+        dict: Authentication/authorization response
+    """
+    request_info = _token_exchange_request_info(requested_subject, subject_token)
+    async with aiohttp.ClientSession() as session:
+        async with session.post(**request_info) as response:
+            return await build_response_obj(response)

spotlight-sdk-0.0.0/spotlight/api/auth/synchronous.py

@@ -0,0 +1,60 @@
+"""
+Auth API requests.
+"""
+from typing import Optional
+
+import requests
+from requests import Response
+
+from spotlight.api.auth.__util import (
+    _login_request_info,
+    _refresh_token_request_info,
+    _token_exchange_request_info,
+)
+
+
+def login(username: str, password: str, scope: Optional[str] = None) -> Response:
+    """
+    Login.
+
+    Args:
+        username (str): Username
+        password (str): Password
+        scope (Optional[str]): Token scope, such as 'offline_access'
+
+    Returns:
+        dict: Authentication/authorization response
+    """
+    request_info = _login_request_info(username, password, scope)
+    return requests.post(**request_info)
+
+
+def refresh_token(token: Optional[str]) -> Response:
+    """
+    Refresh token. To get an offline access token, initial authentication (login) needs to use the scope
+    'offline_access', then an offline token can be created using the refresh_token in the authentication response.
+    [Stack overflow reference](https://stackoverflow.com/questions/69207734/keycloak-offline-access-token-with-refresh-token-grant-type).
+
+    Args:
+        token (str): Refresh token
+
+    Returns:
+        dict: Authentication/authorization response
+    """
+    request_info = _refresh_token_request_info(token)
+    return requests.post(**request_info)
+
+
+def exchange_token(requested_subject: str, subject_token: str) -> Response:
+    """
+    Exchange token.
+
+    Args:
+        requested_subject (str): Request subject (Username or ID)
+        subject_token (str): Token to swap
+
+    Returns:
+        dict: Authentication/authorization response
+    """
+    request_info = _token_exchange_request_info(requested_subject, subject_token)
+    return requests.post(**request_info)

spotlight-sdk-0.0.0/spotlight/api/data/__init__.py

@@ -0,0 +1,17 @@
+"""
+Data API query functions for timeseries data.
+"""
+from spotlight.api.data.asynchronous import (
+    async_query_timeseries,
+    async_query_dataset_csv,
+    async_query_distinct_fields,
+    _async_query_timeseries,
+    _async_query_distinct_fields,
+)
+from spotlight.api.data.synchronous import (
+    query_timeseries,
+    query_dataset_csv,
+    query_distinct_fields,
+    _query_timeseries,
+    _query_distinct_fields,
+)

spotlight-sdk-0.0.0/spotlight/api/data/__util.py

@@ -0,0 +1,13 @@
+from spotlight.api.data.model import TimeseriesQueryRequest, DistinctQueryRequest
+
+
+def _query_timeseries_request_info(request: TimeseriesQueryRequest) -> dict:
+    return {"endpoint": f"data/v1.1/timeseries", "json": request.request_dict()}
+
+
+def _query_dataset_csv_request_info(id: str, request: TimeseriesQueryRequest) -> dict:
+    return {"endpoint": f"data/v1.1/{id}.csv", "json": request.request_dict()}
+
+
+def _query_distinct_fields_request_info(request: DistinctQueryRequest) -> dict:
+    return {"endpoint": f"data/v1.1/distinct", "json": request.request_dict()}

spotlight-sdk-0.0.0/spotlight/api/data/asynchronous.py

@@ -0,0 +1,82 @@
+import pandas as pd
+from requests import Response
+
+from spotlight.api.data.__util import (
+    _query_dataset_csv_request_info,
+    _query_timeseries_request_info,
+    _query_distinct_fields_request_info,
+)
+from spotlight.api.data.model import TimeseriesQueryRequest, DistinctQueryRequest
+from spotlight.core.common.decorators import async_data_request
+from spotlight.core.common.requests import __async_get_request, __async_post_request
+
+
+async def _async_query_timeseries(request: TimeseriesQueryRequest):
+    """
+    Asynchronously query timeseries dataset by timeseries query request.
+
+    Args:
+        request (TimeseriesQueryRequest): Timeseries query request
+
+    Returns:
+        Response: Response
+    """
+    request_info = _query_timeseries_request_info(request)
+    return await __async_post_request(**request_info)
+
+
+async def _async_query_distinct_fields(request: DistinctQueryRequest):
+    """
+    Asynchronously query dataset for distinct values of a specified field.
+
+    Args:
+        request (DistinctQueryRequest): Distinct query request
+
+    Returns:
+        Response: Response
+    """
+    request_info = _query_distinct_fields_request_info(request)
+    return await __async_post_request(**request_info)
+
+
+@async_data_request
+async def async_query_timeseries(request: TimeseriesQueryRequest) -> pd.DataFrame:
+    """
+    Asynchronously query timeseries dataset by timeseries query request.
+
+    Args:
+        request (TimeseriesQueryRequest): Timeseries query request
+
+    Returns:
+        pd.DataFrame: Timeseries DataFrame
+    """
+    return await _async_query_timeseries(request)
+
+
+async def async_query_dataset_csv(id: str, request: TimeseriesQueryRequest) -> Response:
+    """
+    Asynchronously query dataset CSV by ID.
+
+    Args:
+        id (str): Dataset ID
+        request (TimeseriesQueryRequest): Timeseries query request
+
+    Returns:
+        Response: HTTP response object
+    """
+    request_info = _query_dataset_csv_request_info(id, request)
+    return await __async_get_request(**request_info)
+
+
+@async_data_request
+async def async_query_distinct_fields(request: DistinctQueryRequest) -> pd.DataFrame:
+    """
+    Asynchronously query dataset for distinct values of a specified field.
+
+    Args:
+        request (DistinctQueryRequest): Distinct query request
+
+    Returns:
+        pd.DataFrame: Timeseries DataFrame
+    """
+    return await _async_query_distinct_fields(request)

spotlight-sdk-0.0.0/spotlight/api/data/model.py

@@ -0,0 +1,47 @@
+"""
+Data classes for API requests.
+"""
+from typing import List, Optional, Any
+
+from pydantic import Field
+
+from spotlight.core.common.base import Base
+from spotlight.core.common.enum import Order, ComparisonOperator, LogicalOperator
+
+
+class Sort(Base):
+    field: str
+    order: Order
+
+
+class Filter(Base):
+    field: str
+    operator: ComparisonOperator
+    value: Any
+
+
+class WhereClause(Base):
+    filter: Optional[Filter] = Field(default=None)
+    operator: Optional[LogicalOperator] = Field(default=None)
+    left: Optional["WhereClause"] = Field(default=None)
+    right: Optional["WhereClause"] = Field(default=None)
+
+
+class TimeseriesQueryRequest(Base):
+    id: Optional[str] = Field(default=None)
+    dataset_name: Optional[str] = Field(default=None)
+    reference_name: Optional[str] = Field(default=None)
+    page: Optional[int] = Field(default=None)
+    limit: Optional[int] = Field(default=None)
+    fields: Optional[List[str]] = Field(default=None)
+    sort: Optional[List[Sort]] = Field(default=None)
+    where: Optional[WhereClause] = Field(default=None)
+
+
+class DistinctQueryRequest(Base):
+    id: Optional[str] = Field(default=None)
+    dataset_name: Optional[str] = Field(default=None)
+    reference_name: Optional[str] = Field(default=None)
+    field: str = Field(default=None)
+    sort: Optional[List[Sort]] = Field(default=None)
+    where: Optional[WhereClause] = Field(default=None)

spotlight-sdk-0.0.0/spotlight/api/data/synchronous.py

@@ -0,0 +1,82 @@
+import pandas as pd
+from requests import Response
+
+from spotlight.api.data.__util import (
+    _query_dataset_csv_request_info,
+    _query_timeseries_request_info,
+    _query_distinct_fields_request_info,
+)
+from spotlight.api.data.model import TimeseriesQueryRequest, DistinctQueryRequest
+from spotlight.core.common.decorators import data_request
+from spotlight.core.common.requests import __get_request, __post_request
+
+
+def _query_timeseries(request: TimeseriesQueryRequest):
+    """
+    Query timeseries dataset by timeseries query request.
+
+    Args:
+        request (TimeseriesQueryRequest): Timeseries query request
+
+    Returns:
+        Response: Response
+    """
+    request_info = _query_timeseries_request_info(request)
+    return __post_request(**request_info)
+
+
+def _query_distinct_fields(request: DistinctQueryRequest):
+    """
+    Query dataset for distinct values of a specified field.
+
+    Args:
+        request (DistinctQueryRequest): Distinct query request
+
+    Returns:
+        Response: Response
+    """
+    request_info = _query_distinct_fields_request_info(request)
+    return __post_request(**request_info)
+
+
+@data_request
+def query_timeseries(request: TimeseriesQueryRequest) -> pd.DataFrame:
+    """
+    Query timeseries dataset by timeseries query request.
+
+    Args:
+        request (TimeseriesQueryRequest): Timeseries query request
+
+    Returns:
+        pd.DataFrame: Timeseries DataFrame
+    """
+    return _query_timeseries(request)
+
+
+def query_dataset_csv(id: str, request: TimeseriesQueryRequest) -> Response:
+    """
+    Query dataset CSV by ID.
+
+    Args:
+        id (str): Dataset ID
+        request (TimeseriesQueryRequest): Timeseries query request
+
+    Returns:
+        Response: HTTP response object
+    """
+    request_info = _query_dataset_csv_request_info(id, request)
+    return __get_request(**request_info)
+
+
+@data_request
+def query_distinct_fields(request: DistinctQueryRequest) -> pd.DataFrame:
+    """
+    Query dataset for distinct values of a specified field.
+
+    Args:
+        request (DistinctQueryRequest): Distinct query request
+
+    Returns:
+        pd.DataFrame: Timeseries DataFrame
+    """
+    return _query_distinct_fields(request)

spotlight-sdk-0.0.0/spotlight/api/dataset/__init__.py

@@ -0,0 +1,16 @@
+from spotlight.api.dataset.asynchronous import (
+    async_get_dataset,
+    async_get_datasets,
+    async_create_dataset,
+    async_update_dataset,
+    async_delete_dataset,
+    async_search_datasets,
+)
+from spotlight.api.dataset.synchronous import (
+    get_dataset,
+    get_datasets,
+    create_dataset,
+    update_dataset,
+    delete_dataset,
+    search_datasets,
+)

spotlight-sdk-0.0.0/spotlight/api/dataset/__util.py

@@ -0,0 +1,29 @@
+from spotlight.api.dataset.model import DatasetRequest
+from spotlight.api.dataset.model import SearchRequest
+
+
+def _get_dataset_request_info(id: str) -> dict:
+    return {"endpoint": f"config/dataset/{id}"}
+
+
+def _get_datasets_request_info() -> dict:
+    return {"endpoint": f"config/dataset"}
+
+
+def _search_datasets_request_info(request: SearchRequest) -> dict:
+    return {
+        "endpoint": f"config/dataset/search",
+        "json": request.request_dict(),
+    }
+
+
+def _create_dataset_request_info(request: DatasetRequest) -> dict:
+    return {"endpoint": f"config/dataset", "json": request.request_dict()}
+
+
+def _update_dataset_request_info(id: str, request: DatasetRequest) -> dict:
+    return {"endpoint": f"config/dataset/{id}", "json": request.request_dict()}
+
+
+def _delete_dataset_request_info(id: str) -> dict:
+    return {"endpoint": f"config/dataset/{id}"}

spotlight-sdk-0.0.0/spotlight/api/dataset/abstract/__init__.py

@@ -0,0 +1,16 @@
+from spotlight.api.dataset.abstract.asynchronous import (
+    async_get_abstract_dataset,
+    async_get_abstract_datasets,
+    async_search_abstract_datasets,
+    async_create_abstract_dataset,
+    async_update_abstract_dataset,
+    async_delete_abstract_dataset,
+)
+from spotlight.api.dataset.abstract.synchronous import (
+    get_abstract_dataset,
+    get_abstract_datasets,
+    search_abstract_datasets,
+    create_abstract_dataset,
+    update_abstract_dataset,
+    delete_abstract_dataset,
+)

spotlight-sdk-0.0.0/spotlight/api/dataset/abstract/__util.py

@@ -0,0 +1,34 @@
+from spotlight.api.dataset.abstract.model import AbstractDatasetRequest
+from spotlight.api.dataset.model import SearchRequest
+
+
+def _get_abstract_dataset_request_info(id: str) -> dict:
+    return {"endpoint": f"config/dataset/abstract/{id}"}
+
+
+def _get_abstract_datasets_request_info() -> dict:
+    return {"endpoint": f"config/dataset/abstract"}
+
+
+def _search_abstract_datasets_request_info(request: SearchRequest) -> dict:
+    return {
+        "endpoint": f"config/dataset/abstract/search",
+        "json": request.request_dict(),
+    }
+
+
+def _create_abstract_dataset_request_info(request: AbstractDatasetRequest) -> dict:
+    return {"endpoint": f"config/dataset/abstract", "json": request.request_dict()}
+
+
+def _update_abstract_dataset_request_info(
+    id: str, request: AbstractDatasetRequest
+) -> dict:
+    return {
+        "endpoint": f"config/dataset/abstract/{id}",
+        "json": request.request_dict(),
+    }
+
+
+def _delete_abstract_dataset_request_info(id: str) -> dict:
+    return {"endpoint": f"config/dataset/abstract/{id}"}