Release v4.1.0 (#137)

Author: ivarurdalen

.pylintrc

@@ -171,7 +171,7 @@ String getSlackUser() {
 
 String getChannel() {
   if (ON_MAIN) {
-    return '#jenkins-ci'
+    return '#build-notifications'
   }
   return "@${getSlackUser()}"
 }

Jenkinsfile

@@ -5,16 +5,17 @@ name = "pypi"
 
 [packages]
 black = "*"
-google-api-core = ">1.31.3"
+google-api-core = "*"
 google-cloud-bigquery = "*"
-googleapis-common-protos = ">=1.56.0*"
+googleapis-common-protos = "*"
 grpcio = "*"
 isort = "*"
 mypy = "*"
 openpyxl = "*"
 pandas = "*"
 protobuf = "*"
-pycodestyle = "*"
+pyathena = "*"
+pyarrow = "*"
 pylint = "*"
 requests = "*"
 setuptools = "*"

Pipfile

@@ -21,12 +21,13 @@ For installation with support for exporting data from a various SQL based data s
 pip install exabel-data-sdk[snowflake]
 
 # Or install multiple data sources at the same time:
-pip install exabel-data-sdk[snowflake,bigquery]
+pip install exabel-data-sdk[snowflake,bigquery,athena]
 ```
 
 Supported data sources are:
 * Snowflake: `snowflake`
 * Google BigQuery: `bigquery`
+* AWS Athena: `athena`
 
 ## Getting started
 

Pipfile.lock

@@ -1 +1 @@
-4.0.0
+4.1.0

README.md

@@ -3,6 +3,8 @@
 from exabel_data_sdk.client.api.api_client.exabel_api_group import ExabelApiGroup
 from exabel_data_sdk.client.client_config import ClientConfig
 
+SIXTEEN_MEGABYTES_IN_BYTES = 16 * 1024 * 1024
+
 
 class BaseGrpcClient:
     """
@@ -12,17 +14,23 @@ class BaseGrpcClient:
     def __init__(self, config: ClientConfig, api_group: ExabelApiGroup):
         self.config = config
         self.metadata = [("x-client-name", config.client_name)]
-        host = api_group.get_host(config)
-        port = api_group.get_port(config)
+        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),),
+        }
         if config.api_key == "NO_KEY":
             # Use an insecure channel. This can be used for local testing.
-            self.channel = grpc.insecure_channel(host + ":" + str(port))
+            self.channel = grpc.insecure_channel(**common_kwargs)
         else:
             assert config.api_key is not None
             self.metadata.append(("x-api-key", config.api_key))
             self.channel = grpc.secure_channel(
-                host + ":" + str(port),
-                grpc.ssl_channel_credentials(root_certificates=config.root_certificates),
+                credentials=grpc.ssl_channel_credentials(
+                    root_certificates=config.root_certificates
+                ),
+                **common_kwargs,
             )
         for header in self.config.extra_headers:
             self.metadata.append(header)

VERSION

@@ -0,0 +1,67 @@
+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.tag_api_client import TagApiClient
+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 (
+    AddEntitiesRequest,
+    AddEntitiesResponse,
+    CreateTagRequest,
+    DeleteTagRequest,
+    GetTagRequest,
+    ListTagEntitiesRequest,
+    ListTagEntitiesResponse,
+    ListTagsRequest,
+    ListTagsResponse,
+    RemoveEntitiesRequest,
+    RemoveEntitiesResponse,
+    Tag,
+    UpdateTagRequest,
+)
+from exabel_data_sdk.stubs.exabel.api.analytics.v1.all_pb2_grpc import TagServiceStub
+
+
+class TagGrpcClient(TagApiClient, BaseGrpcClient):
+    """
+    Client which sends tag requests to the Exabel Analytics API with gRPC.
+    """
+
+    def __init__(self, config: ClientConfig):
+        super().__init__(config, ExabelApiGroup.ANALYTICS_API)
+        self.stub = TagServiceStub(self.channel)
+
+    @handle_grpc_error
+    def create_tag(self, request: CreateTagRequest) -> Tag:
+        return self.stub.CreateTag(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def get_tag(self, request: GetTagRequest) -> Tag:
+        return self.stub.GetTag(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def update_tag(self, request: UpdateTagRequest) -> Tag:
+        return self.stub.UpdateTag(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def delete_tag(self, request: DeleteTagRequest) -> None:
+        return self.stub.DeleteTag(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def list_tags(self, request: ListTagsRequest) -> ListTagsResponse:
+        return self.stub.ListTags(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def add_entities(self, request: AddEntitiesRequest) -> AddEntitiesResponse:
+        return self.stub.AddEntities(request, metadata=self.metadata, timeout=self.config.timeout)
+
+    @handle_grpc_error
+    def remove_entities(self, request: RemoveEntitiesRequest) -> RemoveEntitiesResponse:
+        return self.stub.RemoveEntities(
+            request, metadata=self.metadata, timeout=self.config.timeout
+        )
+
+    @handle_grpc_error
+    def list_entities(self, request: ListTagEntitiesRequest) -> ListTagEntitiesResponse:
+        return self.stub.ListTagEntities(
+            request, metadata=self.metadata, timeout=self.config.timeout
+        )

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

@@ -17,6 +17,8 @@
 )
 from exabel_data_sdk.stubs.exabel.api.data.v1.all_pb2_grpc import TimeSeriesServiceStub
 
+FIVE_MINUTES_IN_SECONDS = 5 * 60
+
 
 class TimeSeriesGrpcClient(TimeSeriesApiClient, BaseGrpcClient):
     """
@@ -51,8 +53,12 @@ def update_time_series(self, request: UpdateTimeSeriesRequest) -> TimeSeries:
 
     @handle_grpc_error
     def import_time_series(self, request: ImportTimeSeriesRequest) -> ImportTimeSeriesResponse:
+        # Import requests at 1 MB can take a long time to complete, so we increase the timeout if
+        # not already set to at least five minutes.
         return self.stub.ImportTimeSeries(
-            request, metadata=self.metadata, timeout=self.config.timeout
+            request,
+            metadata=self.metadata,
+            timeout=max(self.config.timeout, FIVE_MINUTES_IN_SECONDS),
         )
 
     @handle_grpc_error

exabel_data_sdk/client/api/api_client/grpc/tag_grpc_client.py

@@ -0,0 +1,55 @@
+from abc import ABC, abstractmethod
+
+from exabel_data_sdk.stubs.exabel.api.analytics.v1.all_pb2 import (
+    AddEntitiesRequest,
+    AddEntitiesResponse,
+    CreateTagRequest,
+    DeleteTagRequest,
+    GetTagRequest,
+    ListTagEntitiesRequest,
+    ListTagEntitiesResponse,
+    ListTagsRequest,
+    ListTagsResponse,
+    RemoveEntitiesRequest,
+    RemoveEntitiesResponse,
+    Tag,
+    UpdateTagRequest,
+)
+
+
+class TagApiClient(ABC):
+    """
+    Superclass for clients that send tag requests to the Exabel Analytics API.
+    """
+
+    @abstractmethod
+    def create_tag(self, request: CreateTagRequest) -> Tag:
+        """Create a tag."""
+
+    @abstractmethod
+    def get_tag(self, request: GetTagRequest) -> Tag:
+        """Get a tag."""
+
+    @abstractmethod
+    def update_tag(self, request: UpdateTagRequest) -> Tag:
+        """Update a tag."""
+
+    @abstractmethod
+    def delete_tag(self, request: DeleteTagRequest) -> None:
+        """Delete a tag."""
+
+    @abstractmethod
+    def list_tags(self, request: ListTagsRequest) -> ListTagsResponse:
+        """List all tags accessible to user."""
+
+    @abstractmethod
+    def add_entities(self, request: AddEntitiesRequest) -> AddEntitiesResponse:
+        """Add entities to a tag."""
+
+    @abstractmethod
+    def remove_entities(self, request: RemoveEntitiesRequest) -> RemoveEntitiesResponse:
+        """Remove entities from a tag."""
+
+    @abstractmethod
+    def list_entities(self, request: ListTagEntitiesRequest) -> ListTagEntitiesResponse:
+        """List entities in a tag."""