diaspora-event-sdk 0.0.15__tar.gz → 0.0.16__tar.gz

{diaspora-event-sdk-0.0.15 → diaspora-event-sdk-0.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diaspora-event-sdk
-Version: 0.0.15
+Version: 0.0.16
 Summary: SDK of Diaspora Event Fabric: Resilience-enabling services for science from HPC to edge
 Home-page: https://github.com/globus-labs/diaspora-event-sdk
 License: LICENSE
@@ -136,3 +136,21 @@ It seems that you ran `pip install diaspora-event-sdk` to install the Diaspora E
 
 ### kafka.errors.NoBrokersAvailable and kafka.errors.NodeNotReadyError
 These messages might pop up if `create_key` is called shortly before instanciating a Kafka client. This is because there's a delay for AWS Secret Manager to associate the newly generated credential with MSK. Note that `create_key` is called internally by `kafka_client.py` the first time you create one of these clients. Please wait a while (around 1 minute) and retry.
+
+### kafka.errors.KafkaTimeoutError: KafkaTimeoutError: Failed to update metadata after 60.0 secs.
+**Step 1: Verify Topic Creation and Access:**
+Before interacting with the producer/consumer, ensure that the topic has been successfully created and access is granted to you. Execute the following command:
+
+```python
+from diaspora_event_sdk import Client as GlobusClient
+c = GlobusClient()
+# topic = <the topic you want to use>
+print(c.register_topic(topic)) 
+```
+This should return a `status: no-op` message, indicating that the topic is already registered and accessible.
+
+**Step 2: Wait Automatic Key Creation in KafkaProducer and KafkaConsumer**
+`KafkaProducer` and `KafkaConsumer` would internally call `create_key` if the keys are not found locally (e.g., when you first authenticated with Globus). Behind the sence, the middle service contacts AWS to initialize the asynchronous process of creating and associating the secret. Please wait a while (around 1 minute) and retry.
+
+### ssl.SSLCertVerificationError
+This is commmon on MacOS system, see [this StackOverflow answer](https://stackoverflow.com/a/53310545).

diaspora-event-sdk-0.0.15/readme.md → diaspora-event-sdk-0.0.16/README.md

@@ -125,4 +125,22 @@ Subsequent calls to `retrieve_key` will return the new password from the cache.
 It seems that you ran `pip install diaspora-event-sdk` to install the Diaspora Event SDK without `kafka-python`. Run `pip install kafka-python` to install the necessary dependency for our `KafkaProducer` and `KafkaConsumer` classes.
 
 ### kafka.errors.NoBrokersAvailable and kafka.errors.NodeNotReadyError
-These messages might pop up if `create_key` is called shortly before instanciating a Kafka client. This is because there's a delay for AWS Secret Manager to associate the newly generated credential with MSK. Note that `create_key` is called internally by `kafka_client.py` the first time you create one of these clients. Please wait a while (around 1 minute) and retry.
+These messages might pop up if `create_key` is called shortly before instanciating a Kafka client. This is because there's a delay for AWS Secret Manager to associate the newly generated credential with MSK. Note that `create_key` is called internally by `kafka_client.py` the first time you create one of these clients. Please wait a while (around 1 minute) and retry.
+
+### kafka.errors.KafkaTimeoutError: KafkaTimeoutError: Failed to update metadata after 60.0 secs.
+**Step 1: Verify Topic Creation and Access:**
+Before interacting with the producer/consumer, ensure that the topic has been successfully created and access is granted to you. Execute the following command:
+
+```python
+from diaspora_event_sdk import Client as GlobusClient
+c = GlobusClient()
+# topic = <the topic you want to use>
+print(c.register_topic(topic)) 
+```
+This should return a `status: no-op` message, indicating that the topic is already registered and accessible.
+
+**Step 2: Wait Automatic Key Creation in KafkaProducer and KafkaConsumer**
+`KafkaProducer` and `KafkaConsumer` would internally call `create_key` if the keys are not found locally (e.g., when you first authenticated with Globus). Behind the sence, the middle service contacts AWS to initialize the asynchronous process of creating and associating the secret. Please wait a while (around 1 minute) and retry.
+
+### ssl.SSLCertVerificationError
+This is commmon on MacOS system, see [this StackOverflow answer](https://stackoverflow.com/a/53310545).

{diaspora-event-sdk-0.0.15 → diaspora-event-sdk-0.0.16}/diaspora_event_sdk/sdk/client.py

@@ -1,12 +1,16 @@
-from typing import Optional
 import json
+from typing import Optional
 
-from diaspora_event_sdk.sdk.login_manager import LoginManager, LoginManagerProtocol, requires_login
-from ._environments import TOKEN_EXCHANGE, DIASPORA_RESOURCE_SERVER
+from diaspora_event_sdk.sdk.login_manager import (
+    LoginManager,
+    LoginManagerProtocol,
+    requires_login,
+)
 
+from ._environments import DIASPORA_RESOURCE_SERVER, TOKEN_EXCHANGE
 
-class Client:
 
+class Client:
     def __init__(
         self,
         environment: Optional[str] = None,
@@ -21,9 +25,7 @@ class Client:
             self.login_manager = LoginManager(environment=environment)
             self.login_manager.ensure_logged_in()
 
-        self.web_client = self.login_manager.get_web_client(
-            base_url=TOKEN_EXCHANGE
-        )
+        self.web_client = self.login_manager.get_web_client(base_url=TOKEN_EXCHANGE)
         self.auth_client = self.login_manager.get_auth_client()
         self.subject_openid = self.auth_client.oauth2_userinfo()["sub"]
 
@@ -41,20 +43,26 @@ class Client:
             raise Exception("should not happen")
 
         tokens = self.login_manager._token_storage.get_token_data(
-            DIASPORA_RESOURCE_SERVER)
-        tokens['access_key'], tokens['secret_key'] = resp['access_key'], resp['secret_key']
+            DIASPORA_RESOURCE_SERVER
+        )
+        tokens["access_key"], tokens["secret_key"] = (
+            resp["access_key"],
+            resp["secret_key"],
+        )
         with self.login_manager._access_lock:
             self.login_manager._token_storage._connection.executemany(
                 "REPLACE INTO token_storage(namespace, resource_server, token_data_json) "
                 "VALUES(?, ?, ?)",
                 [
-                    (self.login_manager._token_storage.namespace,
-                     DIASPORA_RESOURCE_SERVER,
-                     json.dumps(tokens))
+                    (
+                        self.login_manager._token_storage.namespace,
+                        DIASPORA_RESOURCE_SERVER,
+                        json.dumps(tokens),
+                    )
                 ],
             )
             self.login_manager._token_storage._connection.commit()
-        return {"username": self.subject_openid, "password": tokens['secret_key']}
+        return {"username": self.subject_openid, "password": tokens["secret_key"]}
 
     @requires_login
     def retrieve_key(self):
@@ -62,29 +70,30 @@ class Client:
         Attempt to retrieve the key from local token storage, and call create_key if local key is not found
         """
         tokens = self.login_manager._token_storage.get_token_data(
-            DIASPORA_RESOURCE_SERVER)
+            DIASPORA_RESOURCE_SERVER
+        )
         if tokens is None or "access_key" not in tokens or "secret_key" not in tokens:
             return self.create_key()
         else:
-            return {"username": self.subject_openid, "password": tokens['secret_key']}
+            return {"username": self.subject_openid, "password": tokens["secret_key"]}
 
     @requires_login
     def list_topics(self):
         """
-        Retrieves the list of topics associated with the user's OpenID. 
+        Retrieves the list of topics associated with the user's OpenID.
         """
         return self.web_client.list_topics(self.subject_openid)
 
     @requires_login
     def register_topic(self, topic):
         """
-        Registers a new topic under the user's OpenID. 
+        Registers a new topic under the user's OpenID.
         """
         return self.web_client.register_topic(self.subject_openid, topic)
 
     @requires_login
     def unregister_topic(self, topic):
         """
-        Unregisters a topic from the user's OpenID. 
+        Unregisters a topic from the user's OpenID.
         """
         return self.web_client.unregister_topic(self.subject_openid, topic)

diaspora-event-sdk-0.0.16/diaspora_event_sdk/version.py

@@ -0,0 +1 @@
+__version__ = "0.0.16"

{diaspora-event-sdk-0.0.15 → diaspora-event-sdk-0.0.16}/diaspora_event_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diaspora-event-sdk
-Version: 0.0.15
+Version: 0.0.16
 Summary: SDK of Diaspora Event Fabric: Resilience-enabling services for science from HPC to edge
 Home-page: https://github.com/globus-labs/diaspora-event-sdk
 License: LICENSE
@@ -136,3 +136,21 @@ It seems that you ran `pip install diaspora-event-sdk` to install the Diaspora E
 
 ### kafka.errors.NoBrokersAvailable and kafka.errors.NodeNotReadyError
 These messages might pop up if `create_key` is called shortly before instanciating a Kafka client. This is because there's a delay for AWS Secret Manager to associate the newly generated credential with MSK. Note that `create_key` is called internally by `kafka_client.py` the first time you create one of these clients. Please wait a while (around 1 minute) and retry.
+
+### kafka.errors.KafkaTimeoutError: KafkaTimeoutError: Failed to update metadata after 60.0 secs.
+**Step 1: Verify Topic Creation and Access:**
+Before interacting with the producer/consumer, ensure that the topic has been successfully created and access is granted to you. Execute the following command:
+
+```python
+from diaspora_event_sdk import Client as GlobusClient
+c = GlobusClient()
+# topic = <the topic you want to use>
+print(c.register_topic(topic)) 
+```
+This should return a `status: no-op` message, indicating that the topic is already registered and accessible.
+
+**Step 2: Wait Automatic Key Creation in KafkaProducer and KafkaConsumer**
+`KafkaProducer` and `KafkaConsumer` would internally call `create_key` if the keys are not found locally (e.g., when you first authenticated with Globus). Behind the sence, the middle service contacts AWS to initialize the asynchronous process of creating and associating the secret. Please wait a while (around 1 minute) and retry.
+
+### ssl.SSLCertVerificationError
+This is commmon on MacOS system, see [this StackOverflow answer](https://stackoverflow.com/a/53310545).

{diaspora-event-sdk-0.0.15 → diaspora-event-sdk-0.0.16}/diaspora_event_sdk.egg-info/SOURCES.txt

@@ -1,6 +1,6 @@
 LICENSE
 MANIFEST.in
-readme.md
+README.md
 setup.py
 tox.ini
 diaspora_event_sdk/__init__.py

{diaspora-event-sdk-0.0.15 → diaspora-event-sdk-0.0.16}/setup.py

@@ -19,7 +19,7 @@ def parse_version():
     return version_string
 
 directory = Path(__file__).parent
-long_description = (directory / "readme.md").read_text()
+long_description = (directory / "README.md").read_text()
 
 setup(
     name='diaspora-event-sdk',

diaspora-event-sdk-0.0.15/diaspora_event_sdk/version.py

@@ -1 +0,0 @@
-__version__ = "0.0.15"