Release 8.0.0

.github/workflows/test_installability.yml

@@ -20,7 +20,7 @@ jobs:
         python-version: ${{ matrix.python-version }}
 
     - name: Install the current SDK version from PyPI
-      run: pip install exabel-data-sdk --no-cache-dir
+      run: pip install exabel --no-cache-dir
 
     - name: Post to Slack
       uses: ravsamhq/notify-slack-action@2.5.0

README.md

@@ -5,10 +5,10 @@ A Python SDK which provides easy access to Exabel APIs.
 ## Installation
 
 ```shell
-pip install exabel-data-sdk
+pip install exabel
 ```
 
-or download from [PyPI](https://pypi.org/project/exabel-data-sdk/).
+or download from [PyPI](https://pypi.org/project/exabel/).
 
 The SDK requires Python 3.10 or later.
 
@@ -18,10 +18,10 @@ For installation with support for exporting data from a various SQL based data s
 
 ```shell
 # Install the Exabel Python SDK with Snowflake support:
-pip install exabel-data-sdk[snowflake]
+pip install exabel[snowflake]
 
 # Or install multiple data sources at the same time:
-pip install exabel-data-sdk[snowflake,bigquery,athena]
+pip install exabel[snowflake,bigquery,athena]
 ```
 
 Supported data sources are:
@@ -40,7 +40,7 @@ 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_data_sdk/examples).
+[Examples of usage](https://github.com/Exabel/python-sdk/tree/main/exabel/examples).
 
 ## Exabel API documentation
 

autoformat.sh

@@ -2,5 +2,5 @@
 
 # Autoformats all Python files with isort and black.
 
-ruff check --fix exabel_data_sdk
-ruff format exabel_data_sdk
+ruff check --fix exabel
+ruff format exabel

exabel_data_sdk/client/api/api_client/calendar_api_client.py → exabel/client/api/api_client/calendar_api_client.py

@@ -1,9 +1,11 @@
 from abc import ABC, abstractmethod
 
-from exabel_data_sdk.stubs.exabel.api.data.v1.calendar_service_pb2 import (
+from exabel.stubs.exabel.api.data.v1.calendar_service_pb2 import (
     BatchCreateFiscalPeriodsRequest,
     BatchCreateFiscalPeriodsResponse,
+    CompanyCalendar,
     DeleteFiscalPeriodRequest,
+    GetCompanyCalendarRequest,
     ListCompaniesWithFiscalPeriodsRequest,
     ListCompaniesWithFiscalPeriodsResponse,
     ListFiscalPeriodsRequest,
@@ -14,6 +16,10 @@
 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

exabel_data_sdk/client/api/api_client/data_set_api_client.py → exabel/client/api/api_client/data_set_api_client.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2 import (
+from exabel.stubs.exabel.api.data.v1.all_pb2 import (
     CreateDataSetRequest,
     DataSet,
     DeleteDataSetRequest,

exabel_data_sdk/client/api/api_client/derived_signal_api_client.py → exabel/client/api/api_client/derived_signal_api_client.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from exabel_data_sdk.stubs.exabel.api.analytics.v1.all_pb2 import (
+from exabel.stubs.exabel.api.analytics.v1.all_pb2 import (
     CreateDerivedSignalRequest,
     DeleteDerivedSignalRequest,
     DerivedSignal,

exabel_data_sdk/client/api/api_client/entity_api_client.py → exabel/client/api/api_client/entity_api_client.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2 import (
+from exabel.stubs.exabel.api.data.v1.all_pb2 import (
     CreateEntityRequest,
     CreateEntityTypeRequest,
     DeleteEntitiesRequest,

exabel_data_sdk/client/api/api_client/exabel_api_group.py → exabel/client/api/api_client/exabel_api_group.py

@@ -1,6 +1,6 @@
 from enum import Enum, auto
 
-from exabel_data_sdk.client.client_config import ClientConfig
+from exabel.client.client_config import ClientConfig
 
 
 class ExabelApiGroup(Enum):

exabel_data_sdk/client/api/api_client/grpc/base_grpc_client.py → exabel/client/api/api_client/grpc/base_grpc_client.py

@@ -2,8 +2,8 @@
 
 import grpc
 
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.client_config import ClientConfig
+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
 

exabel_data_sdk/client/api/api_client/grpc/calendar_grpc_client.py → exabel/client/api/api_client/grpc/calendar_grpc_client.py

@@ -1,18 +1,20 @@
-from exabel_data_sdk.client.api.api_client.calendar_api_client import CalendarApiClient
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.data.v1.calendar_service_pb2 import (
+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_data_sdk.stubs.exabel.api.data.v1.calendar_service_pb2_grpc import CalendarServiceStub
+from exabel.stubs.exabel.api.data.v1.calendar_service_pb2_grpc import CalendarServiceStub
 
 
 class CalendarGrpcClient(CalendarApiClient, BaseGrpcClient):
@@ -24,6 +26,12 @@ 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

exabel_data_sdk/client/api/api_client/grpc/data_set_grpc_client.py → exabel/client/api/api_client/grpc/data_set_grpc_client.py

@@ -1,9 +1,9 @@
-from exabel_data_sdk.client.api.api_client.data_set_api_client import DataSetApiClient
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2 import (
+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,
@@ -12,7 +12,7 @@
     ListDataSetsResponse,
     UpdateDataSetRequest,
 )
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2_grpc import DataSetServiceStub
+from exabel.stubs.exabel.api.data.v1.all_pb2_grpc import DataSetServiceStub
 
 
 class DataSetGrpcClient(DataSetApiClient, BaseGrpcClient):

exabel_data_sdk/client/api/api_client/grpc/derived_signal_grpc_client.py → exabel/client/api/api_client/grpc/derived_signal_grpc_client.py

@@ -1,16 +1,16 @@
-from exabel_data_sdk.client.api.api_client.derived_signal_api_client import DerivedSignalApiClient
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.analytics.v1.all_pb2 import (
+from exabel.client.api.api_client.derived_signal_api_client import DerivedSignalApiClient
+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.analytics.v1.all_pb2 import (
     CreateDerivedSignalRequest,
     DeleteDerivedSignalRequest,
     DerivedSignal,
     GetDerivedSignalRequest,
     UpdateDerivedSignalRequest,
 )
-from exabel_data_sdk.stubs.exabel.api.analytics.v1.all_pb2_grpc import DerivedSignalServiceStub
+from exabel.stubs.exabel.api.analytics.v1.all_pb2_grpc import DerivedSignalServiceStub
 
 
 class DerivedSignalGrpcClient(DerivedSignalApiClient, BaseGrpcClient):

exabel_data_sdk/client/api/api_client/grpc/entity_grpc_client.py → exabel/client/api/api_client/grpc/entity_grpc_client.py

@@ -1,9 +1,9 @@
-from exabel_data_sdk.client.api.api_client.entity_api_client import EntityApiClient
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2 import (
+from exabel.client.api.api_client.entity_api_client import EntityApiClient
+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 (
     CreateEntityRequest,
     CreateEntityTypeRequest,
     DeleteEntitiesRequest,
@@ -22,7 +22,7 @@
     UpdateEntityRequest,
     UpdateEntityTypeRequest,
 )
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2_grpc import EntityServiceStub
+from exabel.stubs.exabel.api.data.v1.all_pb2_grpc import EntityServiceStub
 
 
 class EntityGrpcClient(EntityApiClient, BaseGrpcClient):

exabel_data_sdk/client/api/api_client/grpc/holiday_grpc_client.py → exabel/client/api/api_client/grpc/holiday_grpc_client.py

@@ -1,18 +1,18 @@
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.api_client.holiday_api_client import HolidayApiClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.data.v1.holiday_messages_pb2 import HolidaySpecification
-from exabel_data_sdk.stubs.exabel.api.data.v1.holiday_service_pb2 import (
+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.api_client.holiday_api_client import HolidayApiClient
+from exabel.client.api.error_handler import handle_grpc_error
+from exabel.client.client_config import ClientConfig
+from exabel.stubs.exabel.api.data.v1.holiday_messages_pb2 import HolidaySpecification
+from exabel.stubs.exabel.api.data.v1.holiday_service_pb2 import (
     CreateHolidaySpecificationRequest,
     DeleteHolidaySpecificationRequest,
     GetHolidaySpecificationRequest,
     ListHolidaySpecificationsRequest,
     ListHolidaySpecificationsResponse,
     UpdateHolidaySpecificationRequest,
 )
-from exabel_data_sdk.stubs.exabel.api.data.v1.holiday_service_pb2_grpc import HolidayServiceStub
+from exabel.stubs.exabel.api.data.v1.holiday_service_pb2_grpc import HolidayServiceStub
 
 
 class HolidayGrpcClient(HolidayApiClient, BaseGrpcClient):

exabel_data_sdk/client/api/api_client/grpc/kpi_grpc_client.py → exabel/client/api/api_client/grpc/kpi_grpc_client.py

@@ -1,8 +1,8 @@
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.api_client.kpi_api_client import KpiApiClient
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.analytics.v1.kpi_service_pb2 import (
+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.api_client.kpi_api_client import KpiApiClient
+from exabel.client.client_config import ClientConfig
+from exabel.stubs.exabel.api.analytics.v1.kpi_service_pb2 import (
     ListCompanyBaseModelResultsRequest,
     ListCompanyBaseModelResultsResponse,
     ListCompanyHierarchicalModelResultsRequest,
@@ -16,7 +16,7 @@
     ListKpiScreenResultsRequest,
     ListKpiScreenResultsResponse,
 )
-from exabel_data_sdk.stubs.exabel.api.analytics.v1.kpi_service_pb2_grpc import KpiServiceStub
+from exabel.stubs.exabel.api.analytics.v1.kpi_service_pb2_grpc import KpiServiceStub
 
 
 class KpiGrpcClient(KpiApiClient, BaseGrpcClient):

exabel_data_sdk/client/api/api_client/grpc/library_grpc_client.py → exabel/client/api/api_client/grpc/library_grpc_client.py

@@ -1,11 +1,11 @@
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.api_client.library_api_client import LibraryApiClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.management.v1.all_pb2_grpc import LibraryServiceStub
-from exabel_data_sdk.stubs.exabel.api.management.v1.folder_messages_pb2 import Folder
-from exabel_data_sdk.stubs.exabel.api.management.v1.library_service_pb2 import (
+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.api_client.library_api_client import LibraryApiClient
+from exabel.client.api.error_handler import handle_grpc_error
+from exabel.client.client_config import ClientConfig
+from exabel.stubs.exabel.api.management.v1.all_pb2_grpc import LibraryServiceStub
+from exabel.stubs.exabel.api.management.v1.folder_messages_pb2 import Folder
+from exabel.stubs.exabel.api.management.v1.library_service_pb2 import (
     CreateFolderRequest,
     DeleteFolderRequest,
     GetFolderRequest,

exabel_data_sdk/client/api/api_client/grpc/namespace_grpc_client.py → exabel/client/api/api_client/grpc/namespace_grpc_client.py

@@ -1,13 +1,13 @@
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.api_client.namespace_api_client import NamespaceApiClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2 import (
+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.api_client.namespace_api_client import NamespaceApiClient
+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 (
     ListNamespacesRequest,
     ListNamespacesResponse,
 )
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2_grpc import NamespaceServiceStub
+from exabel.stubs.exabel.api.data.v1.all_pb2_grpc import NamespaceServiceStub
 
 
 class NamespaceGrpcClient(NamespaceApiClient, BaseGrpcClient):

exabel_data_sdk/client/api/api_client/grpc/prediction_model_grpc_client.py → exabel/client/api/api_client/grpc/prediction_model_grpc_client.py

@@ -1,15 +1,15 @@
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.api_client.prediction_model_api_client import (
+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.api_client.prediction_model_api_client import (
     PredictionModelApiClient,
 )
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.analytics.v1.all_pb2 import (
+from exabel.client.api.error_handler import handle_grpc_error
+from exabel.client.client_config import ClientConfig
+from exabel.stubs.exabel.api.analytics.v1.all_pb2 import (
     CreatePredictionModelRunRequest,
     PredictionModelRun,
 )
-from exabel_data_sdk.stubs.exabel.api.analytics.v1.all_pb2_grpc import PredictionModelServiceStub
+from exabel.stubs.exabel.api.analytics.v1.all_pb2_grpc import PredictionModelServiceStub
 
 
 class PredictionModelGrpcClient(PredictionModelApiClient, BaseGrpcClient):

exabel_data_sdk/client/api/api_client/grpc/relationship_grpc_client.py → exabel/client/api/api_client/grpc/relationship_grpc_client.py

@@ -1,9 +1,9 @@
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.api_client.relationship_api_client import RelationshipApiClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2 import (
+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.api_client.relationship_api_client import RelationshipApiClient
+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 (
     CreateRelationshipRequest,
     CreateRelationshipTypeRequest,
     DeleteRelationshipRequest,
@@ -19,7 +19,7 @@
     UpdateRelationshipRequest,
     UpdateRelationshipTypeRequest,
 )
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2_grpc import RelationshipServiceStub
+from exabel.stubs.exabel.api.data.v1.all_pb2_grpc import RelationshipServiceStub
 
 
 class RelationshipGrpcClient(RelationshipApiClient, BaseGrpcClient):

exabel_data_sdk/client/api/api_client/grpc/signal_grpc_client.py → exabel/client/api/api_client/grpc/signal_grpc_client.py

@@ -1,9 +1,9 @@
-from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
-from exabel_data_sdk.client.api.api_client.grpc.base_grpc_client import BaseGrpcClient
-from exabel_data_sdk.client.api.api_client.signal_api_client import SignalApiClient
-from exabel_data_sdk.client.api.error_handler import handle_grpc_error
-from exabel_data_sdk.client.client_config import ClientConfig
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2 import (
+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.api_client.signal_api_client import SignalApiClient
+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 (
     CreateSignalRequest,
     DeleteSignalRequest,
     FilterDerivedSignalsRequest,
@@ -14,7 +14,7 @@
     Signal,
     UpdateSignalRequest,
 )
-from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2_grpc import SignalServiceStub
+from exabel.stubs.exabel.api.data.v1.all_pb2_grpc import SignalServiceStub
 
 
 class SignalGrpcClient(SignalApiClient, BaseGrpcClient):