exabel 8.0.0__tar.gz

exabel-8.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Exabel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

exabel-8.0.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: exabel
+Version: 8.0.0
+Summary: Python SDK for the Exabel Data API
+Author: Exabel
+Author-email: Exabel <support@exabel.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: google-api-core>1.31.3
+Requires-Dist: googleapis-common-protos>=1.56.0
+Requires-Dist: grpcio
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: protobuf>=6
+Requires-Dist: requests
+Requires-Dist: tqdm
+Requires-Dist: pyathena ; extra == 'athena'
+Requires-Dist: pyarrow ; extra == 'athena'
+Requires-Dist: sqlalchemy ; extra == 'athena'
+Requires-Dist: google-cloud-bigquery ; extra == 'bigquery'
+Requires-Dist: sqlalchemy-bigquery ; extra == 'bigquery'
+Requires-Dist: snowflake-connector-python[pandas] ; extra == 'snowflake'
+Requires-Dist: snowflake-sqlalchemy ; extra == 'snowflake'
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/Exabel/python-sdk
+Project-URL: Documentation, https://help.exabel.com
+Project-URL: Source, https://github.com/Exabel/python-sdk
+Project-URL: Changelog, https://github.com/Exabel/python-sdk/releases
+Provides-Extra: athena
+Provides-Extra: bigquery
+Provides-Extra: snowflake
+Description-Content-Type: text/markdown
+
+# Exabel Python SDK
+
+A Python SDK which provides easy access to Exabel APIs.
+
+## Installation
+
+```shell
+pip install exabel
+```
+
+or download from [PyPI](https://pypi.org/project/exabel/).
+
+The SDK requires Python 3.10 or later.
+
+### Installation with SQL data source support
+
+For installation with support for exporting data from a various SQL based data sources, add the data source as a pip extra in brackets after the package name:
+
+```shell
+# Install the Exabel Python SDK with Snowflake support:
+pip install exabel[snowflake]
+
+# Or install multiple data sources at the same time:
+pip install exabel[snowflake,bigquery,athena]
+```
+
+Supported data sources are:
+
+* Snowflake: `snowflake`
+* Google BigQuery: `bigquery`
+* AWS Athena: `athena`
+
+## Getting started
+
+To use the SDK against the Data API, Analytics API or Management API, you need an API key provided by Exabel.
+
+The Exabel Export API can be used by authenticating with username and password.
+The first time you run the script a web browser window is opened where you are asked to provide username and password. The script stores an access token in ``~/.exabel``, so you will not be asked again
+until the token expires.
+
+[Export API Developer guide](https://help.exabel.com/docs/exporting-via-exabel-sdk)
+
+[Examples of usage](https://github.com/Exabel/python-sdk/tree/main/exabel/examples).
+
+## Exabel API documentation
+
+### Data API
+
+The Exabel Data API can be used to upload custom data to the Exabel platform. Custom data may include entities, relationships and time series.
+
+[Data API Developer guide](https://help.exabel.com/docs/data-api)
+
+### Export API
+
+The Exabel Export API can be used to export dashboards and signals from the Exabel Platform.
+
+[Export API Developer guide](https://help.exabel.com/docs/exporting-via-exabel-sdk)
+
+### Analytics API
+
+The Exabel Analytics API can be used to manage derived signals and prediction models on the Exabel Platform.
+
+[Analytics API Developer guide](https://help.exabel.com/docs/analytics-api)
+
+### Management API
+
+The Exabel Management API can be used to manage the library on the Exabel Platform.
+
+[Management API Developer guide](https://help.exabel.com/docs/management-api)

exabel-8.0.0/README.md

@@ -0,0 +1,69 @@
+# Exabel Python SDK
+
+A Python SDK which provides easy access to Exabel APIs.
+
+## Installation
+
+```shell
+pip install exabel
+```
+
+or download from [PyPI](https://pypi.org/project/exabel/).
+
+The SDK requires Python 3.10 or later.
+
+### Installation with SQL data source support
+
+For installation with support for exporting data from a various SQL based data sources, add the data source as a pip extra in brackets after the package name:
+
+```shell
+# Install the Exabel Python SDK with Snowflake support:
+pip install exabel[snowflake]
+
+# Or install multiple data sources at the same time:
+pip install exabel[snowflake,bigquery,athena]
+```
+
+Supported data sources are:
+
+* Snowflake: `snowflake`
+* Google BigQuery: `bigquery`
+* AWS Athena: `athena`
+
+## Getting started
+
+To use the SDK against the Data API, Analytics API or Management API, you need an API key provided by Exabel.
+
+The Exabel Export API can be used by authenticating with username and password.
+The first time you run the script a web browser window is opened where you are asked to provide username and password. The script stores an access token in ``~/.exabel``, so you will not be asked again
+until the token expires.
+
+[Export API Developer guide](https://help.exabel.com/docs/exporting-via-exabel-sdk)
+
+[Examples of usage](https://github.com/Exabel/python-sdk/tree/main/exabel/examples).
+
+## Exabel API documentation
+
+### Data API
+
+The Exabel Data API can be used to upload custom data to the Exabel platform. Custom data may include entities, relationships and time series.
+
+[Data API Developer guide](https://help.exabel.com/docs/data-api)
+
+### Export API
+
+The Exabel Export API can be used to export dashboards and signals from the Exabel Platform.
+
+[Export API Developer guide](https://help.exabel.com/docs/exporting-via-exabel-sdk)
+
+### Analytics API
+
+The Exabel Analytics API can be used to manage derived signals and prediction models on the Exabel Platform.
+
+[Analytics API Developer guide](https://help.exabel.com/docs/analytics-api)
+
+### Management API
+
+The Exabel Management API can be used to manage the library on the Exabel Platform.
+
+[Management API Developer guide](https://help.exabel.com/docs/management-api)

exabel-8.0.0/exabel/__init__.py

@@ -0,0 +1 @@
+from .client.exabel_client import ExabelClient

exabel-8.0.0/exabel/client/api/api_client/calendar_api_client.py

@@ -0,0 +1,43 @@
+from abc import ABC, abstractmethod
+
+from exabel.stubs.exabel.api.data.v1.calendar_service_pb2 import (
+    BatchCreateFiscalPeriodsRequest,
+    BatchCreateFiscalPeriodsResponse,
+    CompanyCalendar,
+    DeleteFiscalPeriodRequest,
+    GetCompanyCalendarRequest,
+    ListCompaniesWithFiscalPeriodsRequest,
+    ListCompaniesWithFiscalPeriodsResponse,
+    ListFiscalPeriodsRequest,
+    ListFiscalPeriodsResponse,
+)
+
+
+class CalendarApiClient(ABC):
+    """Superclass for clients that send calendar requests to the Exabel Data API."""
+
+    @abstractmethod
+    def get_company_calendar(self, request: GetCompanyCalendarRequest) -> CompanyCalendar:
+        """Get the fiscal calendar for a company."""
+
+    @abstractmethod
+    def batch_create_fiscal_periods(
+        self, request: BatchCreateFiscalPeriodsRequest
+    ) -> BatchCreateFiscalPeriodsResponse:
+        """Add fiscal periods for a company."""
+
+    @abstractmethod
+    def list_company_fiscal_periods(
+        self, request: ListFiscalPeriodsRequest
+    ) -> ListFiscalPeriodsResponse:
+        """List the fiscal periods for a company."""
+
+    @abstractmethod
+    def delete_fiscal_periods(self, request: DeleteFiscalPeriodRequest) -> None:
+        """Delete fiscal periods for a company."""
+
+    @abstractmethod
+    def list_companies_with_fiscal_periods(
+        self, request: ListCompaniesWithFiscalPeriodsRequest
+    ) -> ListCompaniesWithFiscalPeriodsResponse:
+        """List the companies for which there are uploaded fiscal periods."""

exabel-8.0.0/exabel/client/api/api_client/data_set_api_client.py

@@ -0,0 +1,37 @@
+from abc import ABC, abstractmethod
+
+from exabel.stubs.exabel.api.data.v1.all_pb2 import (
+    CreateDataSetRequest,
+    DataSet,
+    DeleteDataSetRequest,
+    GetDataSetRequest,
+    ListDataSetsRequest,
+    ListDataSetsResponse,
+    UpdateDataSetRequest,
+)
+
+
+class DataSetApiClient(ABC):
+    """
+    Superclass for clients that send data set requests to the Exabel Data API.
+    """
+
+    @abstractmethod
+    def list_data_sets(self, request: ListDataSetsRequest) -> ListDataSetsResponse:
+        """List all data sets."""
+
+    @abstractmethod
+    def get_data_set(self, request: GetDataSetRequest) -> DataSet:
+        """Get a data set."""
+
+    @abstractmethod
+    def create_data_set(self, request: CreateDataSetRequest) -> DataSet:
+        """Create a data set."""
+
+    @abstractmethod
+    def update_data_set(self, request: UpdateDataSetRequest) -> DataSet:
+        """Update a data set."""
+
+    @abstractmethod
+    def delete_data_set(self, request: DeleteDataSetRequest) -> None:
+        """Delete a data set."""

exabel-8.0.0/exabel/client/api/api_client/derived_signal_api_client.py

@@ -0,0 +1,31 @@
+from abc import ABC, abstractmethod
+
+from exabel.stubs.exabel.api.analytics.v1.all_pb2 import (
+    CreateDerivedSignalRequest,
+    DeleteDerivedSignalRequest,
+    DerivedSignal,
+    GetDerivedSignalRequest,
+    UpdateDerivedSignalRequest,
+)
+
+
+class DerivedSignalApiClient(ABC):
+    """
+    Superclass for clients that send derived signal requests to the Exabel Analytics API.
+    """
+
+    @abstractmethod
+    def create_derived_signal(self, request: CreateDerivedSignalRequest) -> DerivedSignal:
+        """Create a derived signal."""
+
+    @abstractmethod
+    def get_derived_signal(self, request: GetDerivedSignalRequest) -> DerivedSignal:
+        """Get a derived signal."""
+
+    @abstractmethod
+    def update_derived_signal(self, request: UpdateDerivedSignalRequest) -> DerivedSignal:
+        """Update a derived signal."""
+
+    @abstractmethod
+    def delete_derived_signal(self, request: DeleteDerivedSignalRequest) -> None:
+        """Delete a derived signal."""

exabel-8.0.0/exabel/client/api/api_client/entity_api_client.py

@@ -0,0 +1,75 @@
+from abc import ABC, abstractmethod
+
+from exabel.stubs.exabel.api.data.v1.all_pb2 import (
+    CreateEntityRequest,
+    CreateEntityTypeRequest,
+    DeleteEntitiesRequest,
+    DeleteEntityRequest,
+    DeleteEntityTypeRequest,
+    Entity,
+    EntityType,
+    GetEntityRequest,
+    GetEntityTypeRequest,
+    ListEntitiesRequest,
+    ListEntitiesResponse,
+    ListEntityTypesRequest,
+    ListEntityTypesResponse,
+    SearchEntitiesRequest,
+    SearchEntitiesResponse,
+    UpdateEntityRequest,
+    UpdateEntityTypeRequest,
+)
+
+
+class EntityApiClient(ABC):
+    """
+    Superclass for clients that send entity requests to the Exabel Data API.
+    """
+
+    @abstractmethod
+    def list_entity_types(self, request: ListEntityTypesRequest) -> ListEntityTypesResponse:
+        """List all known entity types."""
+
+    @abstractmethod
+    def get_entity_type(self, request: GetEntityTypeRequest) -> EntityType:
+        """Get an entity type."""
+
+    @abstractmethod
+    def create_entity_type(self, request: CreateEntityTypeRequest) -> EntityType:
+        """Create an entity type."""
+
+    @abstractmethod
+    def update_entity_type(self, request: UpdateEntityTypeRequest) -> EntityType:
+        """Update an entity type."""
+
+    @abstractmethod
+    def delete_entity_type(self, request: DeleteEntityTypeRequest) -> None:
+        """Delete an entity type."""
+
+    @abstractmethod
+    def list_entities(self, request: ListEntitiesRequest) -> ListEntitiesResponse:
+        """List all entities of a given entity type."""
+
+    @abstractmethod
+    def get_entity(self, request: GetEntityRequest) -> Entity:
+        """Get an entity."""
+
+    @abstractmethod
+    def create_entity(self, request: CreateEntityRequest) -> Entity:
+        """Create an entity."""
+
+    @abstractmethod
+    def update_entity(self, request: UpdateEntityRequest) -> Entity:
+        """Update an entity."""
+
+    @abstractmethod
+    def delete_entity(self, request: DeleteEntityRequest) -> None:
+        """Delete an entity."""
+
+    @abstractmethod
+    def delete_entities(self, request: DeleteEntitiesRequest) -> None:
+        """Delete all entities of a given entity type."""
+
+    @abstractmethod
+    def search_entities(self, request: SearchEntitiesRequest) -> SearchEntitiesResponse:
+        """Search for entities."""

exabel-8.0.0/exabel/client/api/api_client/exabel_api_group.py

@@ -0,0 +1,38 @@
+from enum import Enum, auto
+
+from exabel.client.client_config import ClientConfig
+
+
+class ExabelApiGroup(Enum):
+    """
+    Exabel API groups.
+    """
+
+    # Data API.
+    DATA_API = auto()
+
+    # Analytics API.
+    ANALYTICS_API = auto()
+
+    # Management API.
+    MANAGEMENT_API = auto()
+
+    def get_host(self, config: ClientConfig) -> str:
+        """Return the API host for this API group."""
+        if self == ExabelApiGroup.DATA_API:
+            return config.data_api_host
+        if self == ExabelApiGroup.ANALYTICS_API:
+            return config.analytics_api_host
+        if self == ExabelApiGroup.MANAGEMENT_API:
+            return config.management_api_host
+        raise ValueError(f"Unknown ExabelApiGroup: {self.name}")
+
+    def get_port(self, config: ClientConfig) -> int:
+        """Return the API port for this API group."""
+        if self == ExabelApiGroup.DATA_API:
+            return config.data_api_port
+        if self == ExabelApiGroup.ANALYTICS_API:
+            return config.analytics_api_port
+        if self == ExabelApiGroup.MANAGEMENT_API:
+            return config.management_api_port
+        raise ValueError(f"Unknown ExabelApiGroup: {self.name}")

exabel-8.0.0/exabel/client/api/api_client/grpc/base_grpc_client.py

@@ -0,0 +1,85 @@
+import json
+
+import grpc
+
+from exabel.client.api.api_client.exabel_api_group import ExabelApiGroup
+from exabel.client.client_config import ClientConfig
+
+SIXTEEN_MEGABYTES_IN_BYTES = 16 * 1024 * 1024
+
+# Retry parameters
+DEFAULT_MAX_ATTEMPTS = 5
+DEFAULT_INITIAL_BACKOFF_SECONDS = 0.1
+DEFAULT_MAX_BACKOFF_SECONDS = 5
+DEFAULT_BACKOFF_MULTIPLIER = 2
+
+
+class BaseGrpcClient:
+    """
+    Base class for clients that access the Exabel API with gRPC.
+    """
+
+    def __init__(self, config: ClientConfig, api_group: ExabelApiGroup):
+        self.config = config
+        self.metadata = [("x-client-name", config.client_name)]
+        common_kwargs = {
+            "target": f"{api_group.get_host(config)}:{api_group.get_port(config)}",
+            # When importing time series, we may receive a large amount of precondition failure
+            # violations in the trailing metadata, therefore we increase the maximum metadata size.
+            "options": (
+                ("grpc.max_metadata_size", SIXTEEN_MEGABYTES_IN_BYTES),
+                ("grpc.service_config", self._get_service_config()),
+            ),
+        }
+        if config.api_key == "NO_KEY":
+            # Use an insecure channel. This can be used for local testing.
+            self.channel = grpc.insecure_channel(**common_kwargs)
+        else:
+            if config.access_token is not None:
+                self.metadata.append(("authorization", "Bearer " + config.access_token))
+            else:
+                assert config.api_key is not None
+                self.metadata.append(("x-api-key", config.api_key))
+            self.channel = grpc.secure_channel(
+                credentials=grpc.ssl_channel_credentials(
+                    root_certificates=config.root_certificates
+                ),
+                **common_kwargs,
+            )
+        for header in self.config.extra_headers:
+            self.metadata.append(header)
+
+    def _get_service_config(
+        self,
+        max_attempts: int = DEFAULT_MAX_ATTEMPTS,
+        initial_backoff: float = DEFAULT_INITIAL_BACKOFF_SECONDS,
+        max_backoff: float = DEFAULT_MAX_BACKOFF_SECONDS,
+        backoff_multiplier: int = DEFAULT_BACKOFF_MULTIPLIER,
+    ) -> str:
+        """
+        Returns a JSON string to use for grpc.service_config option when creating a grpc channel
+        """
+        return json.dumps(
+            {
+                "methodConfig": [
+                    {
+                        "name": [{}],
+                        "retryPolicy": {
+                            "maxAttempts": max_attempts,
+                            "initialBackoff": f"{initial_backoff}s",
+                            "maxBackoff": f"{max_backoff}s",
+                            "backoffMultiplier": backoff_multiplier,
+                            "retryableStatusCodes": [
+                                "CANCELLED",
+                                "UNKNOWN",
+                                "DEADLINE_EXCEEDED",
+                                "RESOURCE_EXHAUSTED",
+                                "ABORTED",
+                                "INTERNAL",
+                                "UNAVAILABLE",
+                            ],
+                        },
+                    }
+                ]
+            }
+        )

exabel-8.0.0/exabel/client/api/api_client/grpc/calendar_grpc_client.py

@@ -0,0 +1,61 @@
+from exabel.client.api.api_client.calendar_api_client import CalendarApiClient
+from exabel.client.api.api_client.exabel_api_group import ExabelApiGroup
+from exabel.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
+from exabel.client.api.error_handler import handle_grpc_error
+from exabel.client.client_config import ClientConfig
+from exabel.stubs.exabel.api.data.v1.calendar_service_pb2 import (
+    BatchCreateFiscalPeriodsRequest,
+    BatchCreateFiscalPeriodsResponse,
+    CompanyCalendar,
+    DeleteFiscalPeriodRequest,
+    GetCompanyCalendarRequest,
+    ListCompaniesWithFiscalPeriodsRequest,
+    ListCompaniesWithFiscalPeriodsResponse,
+    ListFiscalPeriodsRequest,
+    ListFiscalPeriodsResponse,
+)
+from exabel.stubs.exabel.api.data.v1.calendar_service_pb2_grpc import CalendarServiceStub
+
+
+class CalendarGrpcClient(CalendarApiClient, BaseGrpcClient):
+    """
+    Client which sends calendar requests to the Exabel Data API with gRPC.
+    """
+
+    def __init__(self, config: ClientConfig):
+        super().__init__(config, ExabelApiGroup.DATA_API)
+        self.stub = CalendarServiceStub(self.channel)
+
+    @handle_grpc_error
+    def get_company_calendar(self, request: GetCompanyCalendarRequest) -> CompanyCalendar:
+        return self.stub.GetCompanyCalendar(
+            request, metadata=self.metadata, timeout=self.config.timeout
+        )
+
+    @handle_grpc_error
+    def batch_create_fiscal_periods(
+        self, request: BatchCreateFiscalPeriodsRequest
+    ) -> BatchCreateFiscalPeriodsResponse:
+        return self.stub.BatchCreateFiscalPeriods(
+            request, metadata=self.metadata, timeout=self.config.timeout
+        )
+
+    @handle_grpc_error
+    def list_company_fiscal_periods(
+        self, request: ListFiscalPeriodsRequest
+    ) -> ListFiscalPeriodsResponse:
+        return self.stub.ListFiscalPeriods(
+            request, metadata=self.metadata, timeout=self.config.timeout
+        )
+
+    @handle_grpc_error
+    def delete_fiscal_periods(self, request: DeleteFiscalPeriodRequest) -> None:
+        self.stub.DeleteFiscalPeriod(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def list_companies_with_fiscal_periods(
+        self, request: ListCompaniesWithFiscalPeriodsRequest
+    ) -> ListCompaniesWithFiscalPeriodsResponse:
+        return self.stub.ListCompaniesWithFiscalPeriods(
+            request, metadata=self.metadata, timeout=self.config.timeout
+        )

exabel-8.0.0/exabel/client/api/api_client/grpc/data_set_grpc_client.py

@@ -0,0 +1,45 @@
+from exabel.client.api.api_client.data_set_api_client import DataSetApiClient
+from exabel.client.api.api_client.exabel_api_group import ExabelApiGroup
+from exabel.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
+from exabel.client.api.error_handler import handle_grpc_error
+from exabel.client.client_config import ClientConfig
+from exabel.stubs.exabel.api.data.v1.all_pb2 import (
+    CreateDataSetRequest,
+    DataSet,
+    DeleteDataSetRequest,
+    GetDataSetRequest,
+    ListDataSetsRequest,
+    ListDataSetsResponse,
+    UpdateDataSetRequest,
+)
+from exabel.stubs.exabel.api.data.v1.all_pb2_grpc import DataSetServiceStub
+
+
+class DataSetGrpcClient(DataSetApiClient, BaseGrpcClient):
+    """
+    Client which sends data set requests to the Exabel Data API with gRPC.
+    """
+
+    def __init__(self, config: ClientConfig):
+        super().__init__(config, ExabelApiGroup.DATA_API)
+        self.stub = DataSetServiceStub(self.channel)
+
+    @handle_grpc_error
+    def list_data_sets(self, request: ListDataSetsRequest) -> ListDataSetsResponse:
+        return self.stub.ListDataSets(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def get_data_set(self, request: GetDataSetRequest) -> DataSet:
+        return self.stub.GetDataSet(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def create_data_set(self, request: CreateDataSetRequest) -> DataSet:
+        return self.stub.CreateDataSet(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def update_data_set(self, request: UpdateDataSetRequest) -> DataSet:
+        return self.stub.UpdateDataSet(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def delete_data_set(self, request: DeleteDataSetRequest) -> None:
+        return self.stub.DeleteDataSet(request, metadata=self.metadata, timeout=self.config.timeout)