diaspora-event-sdk 0.0.10__py3-none-any.whl → 0.0.11__py3-none-any.whl

diaspora_event_sdk/__init__.py

@@ -10,8 +10,7 @@ from diaspora_event_sdk.sdk.client import Client  # Globus client
 from diaspora_event_sdk.sdk.kafka_client import kafka_available
 
 if kafka_available:
-    from diaspora_event_sdk.sdk.kafka_client import KafkaProducer, KafkaConsumer, KafkaAdmin, NewTopic
-    __all__ = ("Client", "KafkaProducer", "KafkaConsumer",
-               "KafkaAdmin", "NewTopic")
+    from diaspora_event_sdk.sdk.kafka_client import KafkaProducer, KafkaConsumer
+    __all__ = ("Client", "KafkaProducer", "KafkaConsumer")
 else:
     __all__ = ("Client")

diaspora_event_sdk/sdk/kafka_client.py

@@ -8,8 +8,7 @@ from .client import Client
 # If kafka-python is not installed, Kafka functionality is not available through diaspora-event-sdk.
 kafka_available = True
 try:
-    from kafka import KafkaProducer, KafkaConsumer, KafkaAdminClient
-    from kafka.admin import NewTopic
+    from kafka import KafkaProducer, KafkaConsumer
 except ImportError:
     kafka_available = False
 
@@ -25,7 +24,7 @@ def get_diaspora_config(extra_configs: Dict[str, Any] = {}) -> Dict[str, Any]:
         raise RuntimeError("Failed to retrieve Kafka keys") from e
 
     conf = {
-        "bootstrap_servers":  MSK_SCRAM_ENDPOINT,
+        "bootstrap_servers": MSK_SCRAM_ENDPOINT,
         "security_protocol": "SASL_SSL",
         "sasl_mechanism": "SCRAM-SHA-512",
         "api_version": (3, 5, 1),
@@ -37,14 +36,12 @@ def get_diaspora_config(extra_configs: Dict[str, Any] = {}) -> Dict[str, Any]:
 
 
 if kafka_available:
-    class KafkaAdmin(KafkaAdminClient):
-        def __init__(self, **configs):
-            super().__init__(**get_diaspora_config(configs))
 
     class KafkaProducer(KafkaProducer):
         def __init__(self, **configs):
-            configs.setdefault("value_serializer",
-                               lambda v: json.dumps(v).encode('utf-8'))
+            configs.setdefault(
+                "value_serializer", lambda v: json.dumps(v).encode("utf-8")
+            )
             super().__init__(**get_diaspora_config(configs))
 
     class KafkaConsumer(KafkaConsumer):

diaspora_event_sdk/version.py

@@ -1 +1 @@
-__version__ = "0.0.10"
+__version__ = "0.0.11"

{diaspora_event_sdk-0.0.10.dist-info → diaspora_event_sdk-0.0.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diaspora-event-sdk
-Version: 0.0.10
+Version: 0.0.11
 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
@@ -12,29 +12,28 @@ Requires-Dist: kafka-python ; extra == 'kafka-python'
 
 <h1>Diaspora Event Fabric: Resilience-enabling services for science from HPC to edge</h1>
 
-- [Installation Instructions](#installation-instructions)
-  - [Recommended Installation with Kafka Client Library: kafka-python](#recommended-installation-with-kafka-client-library-kafka-python)
-  - [Installation Without Kafka Client Library](#installation-without-kafka-client-library)
+- [Installation](#installation)
+   * [Recommended Installation with Kafka Client Library](#recommended-installation-with-kafka-client-library)
+   * [Installation Without Kafka Client Library](#installation-without-kafka-client-library)
 - [Use Diaspora Event SDK](#use-diaspora-event-sdk)
-  - [Use SDK to communicate with Kafka (kafka-python Required)](#use-sdk-to-communicate-with-kafka-kafka-python-required)
-    - [Register Topic (create topic ACLs)](#register-topic-create-topic-acls)
-    - [Create Topic](#create-topic)
-    - [Start Producer](#start-producer)
-    - [Start Consumer](#start-consumer)
-    - [Delete Topic](#delete-topic)
-    - [Unregister Topic (remove topic ACLs)](#unregister-topic-remove-topic-acls)
-  - [Communicating with Kafka Using Your Preferred Client Library](#communicating-with-kafka-using-your-preferred-client-library)
-    - [Register and Unregister Topic](#register-and-unregister-topic)
-    - [Cluster Connection Details](#cluster-connection-details)
-  - [Advanced Usage](#advanced-usage)
-    - [Password Refresh](#password-refresh)
-  - [Common Issues](#common-issues)
-    - [ImportError: cannot import name 'KafkaAdmin' from 'diaspora\_event\_sdk'](#importerror-cannot-import-name-kafkaadmin-from-diaspora_event_sdk)
-    - [kafka.errors.NoBrokersAvailable: NoBrokersAvailable](#kafkaerrorsnobrokersavailable-nobrokersavailable)
-
-## Installation Instructions
-### Recommended Installation with Kafka Client Library: kafka-python
-If you plan to utilize the `KafkaAdmin`, `KafkaProducer`, and `KafkaConsumer` classes in the SDK, which are extensions of the respective classes from the `kafka-python` library, we recommend installing the SDK with `kafka-python` support. This is especially convenient for tutorial purposes and integrating Kafka functionalities in your projects with out-of-box configurations.
+   * [Use the SDK to communicate with Kafka (kafka-python Required)](#use-the-sdk-to-communicate-with-kafka-kafka-python-required)
+      + [Register Topic (create topic ACLs)](#register-topic-create-topic-acls)
+      + [Start Producer](#start-producer)
+      + [Start Consumer](#start-consumer)
+      + [Unregister Topic (remove topic ACLs)](#unregister-topic-remove-topic-acls)
+   * [Use Your Preferred Kafka Client Library](#use-your-preferred-kafka-client-library)
+      + [Register and Unregister Topic](#register-and-unregister-topic)
+      + [Cluster Connection Details](#cluster-connection-details)
+   * [Advanced Usage](#advanced-usage)
+      + [Password Refresh](#password-refresh)
+- [Common Issues](#common-issues)
+   * [ImportError: cannot import name 'KafkaProducer' from 'diaspora_event_sdk'](#importerror-cannot-import-name-kafkaproducer-from-diaspora_event_sdk)
+   * [kafka.errors.NoBrokersAvailable and kafka.errors.NodeNotReadyError](#kafkaerrorsnobrokersavailable-and-kafkaerrorsnodenotreadyerror)
+
+
+## Installation
+### Recommended Installation with Kafka Client Library
+If you plan to utilize the `KafkaProducer` and `KafkaConsumer` classes in the SDK, which are extensions of the respective classes from the `kafka-python` library, we recommend installing the SDK with `kafka-python` support. This is especially convenient for tutorial purposes and integrating Kafka functionalities in your projects with out-of-box configurations.
 
 To install Diaspora Event SDK with `kafka-python`, run:
 ```bash
@@ -48,10 +47,10 @@ To install the SDK without Kafka support, simply run:
 ```bash
 pip install diaspora-event-sdk
 ```
-Note that this option does not install the necessary dependency for `KafkaAdmin`, `KafkaProducer`, and `KafkaConsumer` below to work.
+Note that this option does not install the necessary dependency for `KafkaProducer` and `KafkaConsumer` below to work.
 
 ## Use Diaspora Event SDK
-### Use SDK to communicate with Kafka (kafka-python Required)
+### Use the SDK to communicate with Kafka (kafka-python Required)
 
 #### Register Topic (create topic ACLs)
 
@@ -64,17 +63,7 @@ topic = "topic-" + c.subject_openid[-12:]
 print(c.register_topic(topic))
 print(c.list_topics())
 ```
-
-#### Create Topic
-
-Now use the KafkaAdmin to create the topic.
-
-```python
-from diaspora_event_sdk import KafkaAdmin, NewTopic 
-admin = KafkaAdmin()
-print(admin.create_topics(new_topics=[
-      NewTopic(name=topic, num_partitions=1, replication_factor=1)]))
-```
+Register a topic also creates it, if the topic previously does not exist.
 
 #### Start Producer
 
@@ -99,13 +88,6 @@ for msg in consumer:
     print(msg)
 ```
 
-#### Delete Topic
-```python
-from diaspora_event_sdk import KafkaAdmin
-admin = KafkaAdmin()
-print(admin.delete_topics(topics=[topic]))
-```
-
 #### Unregister Topic (remove topic ACLs)
 ```python
 from diaspora_event_sdk import Client as GlobusClient
@@ -115,7 +97,7 @@ print(c.unregister_topic(topic))
 print(c.list_topics())
 ```
 
-### Communicating with Kafka Using Your Preferred Client Library
+### Use Your Preferred Kafka Client Library
 
 #### Register and Unregister Topic
 The steps are the same as above by using the `register_topic`, `unregister_topic`, and `list_topics` methods from the `Client` class.
@@ -148,11 +130,11 @@ print(c.create_key())
 ```
 Subsequent calls to `retrieve_key` will return the new password from the cache. This cache is reset with a logout or a new `create_key` call.
 
-### Common Issues
+## Common Issues
 
-#### ImportError: cannot import name 'KafkaAdmin' from 'diaspora_event_sdk'
+### ImportError: cannot import name 'KafkaProducer' from 'diaspora_event_sdk'
 
-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 `KafkaAdmin`, `KafkaProducer`, and `KafkaConsumer` classes.
+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 the first time you create one of these clients. Please wait a while (around 1 minute) and retry.
+### 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.

{diaspora_event_sdk-0.0.10.dist-info → diaspora_event_sdk-0.0.11.dist-info}/RECORD

@@ -1,10 +1,10 @@
-diaspora_event_sdk/__init__.py,sha256=aog9b4ljY5AAdH5z7qEsjceBn5y--ENk8GIYULRpSeo,603
-diaspora_event_sdk/version.py,sha256=-nNlMKS9nph3FR78_ZG9RGKrbxseeNp2K6nMr0pVGaU,23
+diaspora_event_sdk/__init__.py,sha256=HecfCu-giI3bBGXcysQHmzkrX9wbwcXoU4k_uHeJWh0,540
+diaspora_event_sdk/version.py,sha256=OaIl7v-6zEWEY90Jlh6yoBjO3zWX1oX7RsvqrK3o1TU,23
 diaspora_event_sdk/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 diaspora_event_sdk/sdk/_environments.py,sha256=UwzEeBVRuP7ZyqTJagNVA24EiCLuOYiy395q608AwQ0,358
 diaspora_event_sdk/sdk/client.py,sha256=DhUDtdkPRmn8P0fTXWg3x-Gn3p2J3ir0Ki7qeOFyp9I,3396
 diaspora_event_sdk/sdk/decorators.py,sha256=Gel8AyhIjbf4-FNintTNcOqvC9hHH_YwbOH257Nfmf0,884
-diaspora_event_sdk/sdk/kafka_client.py,sha256=BM_mIM3UxA8xhOhygCX02IruOdbW7kUd0iaqxOZCfd4,1721
+diaspora_event_sdk/sdk/kafka_client.py,sha256=bfYKAAbgzRdeMK_gmr84n5653KYboWjO6F4BjgmWExs,1524
 diaspora_event_sdk/sdk/web_client.py,sha256=BgRza0fJudvgRCZ_P9BugFp57oYRWekpBf2KlZYFqUY,1305
 diaspora_event_sdk/sdk/login_manager/__init__.py,sha256=yeqVgjeHLMX0WZJu2feJmq-fbeXvSxWghVV81ygfY-w,239
 diaspora_event_sdk/sdk/login_manager/client_login.py,sha256=gvR4PkIqQpIywNieJQ_u11PHUmdLxQ0Ho-QgPSfu8bw,1798
@@ -16,9 +16,8 @@ diaspora_event_sdk/sdk/login_manager/protocol.py,sha256=RCuo2jy_XkpZvbxnKlDfTKs-
 diaspora_event_sdk/sdk/login_manager/tokenstore.py,sha256=7jRm01rzsbvniaCfYtDDWE3det_1_b6oQkS-YQ2Qjg4,3037
 diaspora_event_sdk/sdk/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 diaspora_event_sdk/sdk/utils/uuid_like.py,sha256=xbxf0YXpDhdii16lwPLWRN21qFekHrNrqODSToMPtCg,470
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-diaspora_event_sdk-0.0.10.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-diaspora_event_sdk-0.0.10.dist-info/METADATA,sha256=iNlzJxmvB23yVbIEiRS_O9TpaOXSqP0SvCnRrJTpAxI,7543
-diaspora_event_sdk-0.0.10.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-diaspora_event_sdk-0.0.10.dist-info/top_level.txt,sha256=OVun-67t3fkLFEIwvJuNINgFFvAc--bClYhXjLhMmvs,25
-diaspora_event_sdk-0.0.10.dist-info/RECORD,,
+diaspora_event_sdk-0.0.11.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+diaspora_event_sdk-0.0.11.dist-info/METADATA,sha256=jPFx9QiJ0uYkRqzWYIxeAiHa_sSRWmAguT-ANlJIp4Y,7049
+diaspora_event_sdk-0.0.11.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+diaspora_event_sdk-0.0.11.dist-info/top_level.txt,sha256=_5Wx8F5rc9mpB093wvCXa6CArtWNXwek2T1LnmkS2vE,19
+diaspora_event_sdk-0.0.11.dist-info/RECORD,,

{diaspora_event_sdk-0.0.10.dist-info → diaspora_event_sdk-0.0.11.dist-info}/top_level.txt

@@ -1,2 +1 @@
 diaspora_event_sdk
-tests