diaspora-event-sdk 0.1.1__tar.gz → 0.1.2__tar.gz

diaspora-event-sdk-0.1.2/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: diaspora-event-sdk
+Version: 0.1.2
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: globus-sdk<4,>=3.20.1
+Provides-Extra: kafka-python
+Requires-Dist: kafka-python; extra == "kafka-python"
+Requires-Dist: aws-msk-iam-sasl-signer-python; extra == "kafka-python"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: tox; extra == "test"
+Requires-Dist: check-manifest; extra == "test"
+
+# Diaspora: Resilience-enabling services for science from HPC to edge
+
+## Event Fabric SDK Installation Guide
+### Recommended Method: Use with `kafka-python`
+For easy integration with Diaspora Event Fabric, use the `KafkaProducer` and `KafkaConsumer` classes from our SDK. This requires the `kafka-python` library.
+
+To install the Event Fabric SDK and `kafka-python,` with the following command:
+```bash
+pip install "diaspora-event-sdk[kafka-python]"
+```
+
+### Alternative Installation: Without Kafka Client Library
+To use alternative Kafka client libraries (e.g., `confluent-kafka-python`, `aiokafka`, and libraries for other programming laguages), you can install the SDK without the `kafka-python` dependency. This option still provides topic-level access control (authorization) and login credential management features.
+
+To install the SDK without `kafka-python`, use:
+```bash
+pip install diaspora-event-sdk
+```
+Note: This method does not include dependencies for `KafkaProducer` and `KafkaConsumer` classes mentioned in the QuickStart
+
+## Use Diaspora Event Fabric SDK
+
+**Getting Started**: Visit our [QuickStart Guide](docs/quickstart.md) for details on using the SDK with the kafka-python library and instructions for other Kafka clients.
+
+**Troubleshooting and Credential Management**: Consult our [TrobleShooting Guide](docs/troubleshooting.md) for solving common issues and tips on managing keys effectively.
+
+**Advanced Usage**: Explore the [Faust Streaming Guide](docs/faust_weather_app.md) for advanced event streaming with Faust.

diaspora-event-sdk-0.1.2/README.md

@@ -0,0 +1,27 @@
+# Diaspora: Resilience-enabling services for science from HPC to edge
+
+## Event Fabric SDK Installation Guide
+### Recommended Method: Use with `kafka-python`
+For easy integration with Diaspora Event Fabric, use the `KafkaProducer` and `KafkaConsumer` classes from our SDK. This requires the `kafka-python` library.
+
+To install the Event Fabric SDK and `kafka-python,` with the following command:
+```bash
+pip install "diaspora-event-sdk[kafka-python]"
+```
+
+### Alternative Installation: Without Kafka Client Library
+To use alternative Kafka client libraries (e.g., `confluent-kafka-python`, `aiokafka`, and libraries for other programming laguages), you can install the SDK without the `kafka-python` dependency. This option still provides topic-level access control (authorization) and login credential management features.
+
+To install the SDK without `kafka-python`, use:
+```bash
+pip install diaspora-event-sdk
+```
+Note: This method does not include dependencies for `KafkaProducer` and `KafkaConsumer` classes mentioned in the QuickStart
+
+## Use Diaspora Event Fabric SDK
+
+**Getting Started**: Visit our [QuickStart Guide](docs/quickstart.md) for details on using the SDK with the kafka-python library and instructions for other Kafka clients.
+
+**Troubleshooting and Credential Management**: Consult our [TrobleShooting Guide](docs/troubleshooting.md) for solving common issues and tips on managing keys effectively.
+
+**Advanced Usage**: Explore the [Faust Streaming Guide](docs/faust_weather_app.md) for advanced event streaming with Faust.

{diaspora-event-sdk-0.1.1 → diaspora-event-sdk-0.1.2}/diaspora_event_sdk/sdk/kafka_client.py

@@ -10,7 +10,7 @@ kafka_available = True
 try:
     from kafka import KafkaProducer as KProd  # type: ignore[import,import-not-found]
     from kafka import KafkaConsumer as KCons  # type: ignore[import,import-not-found]
-    from aws_msk_iam_sasl_signer import MSKAuthTokenProvider
+    from aws_msk_iam_sasl_signer import MSKAuthTokenProvider  # type: ignore[import,import-not-found]
     import os
 
     class MSKTokenProvider:
@@ -56,6 +56,7 @@ if kafka_available:
     class KafkaConsumer(KCons):
         def __init__(self, *topics, **configs):
             super().__init__(*topics, **get_diaspora_config(configs))
+
 else:
     # Create dummy classes that issue a warning when instantiated
     class KafkaProducer:  # type: ignore[no-redef]

{diaspora-event-sdk-0.1.1 → diaspora-event-sdk-0.1.2}/diaspora_event_sdk/sdk/login_manager/manager.py

@@ -22,7 +22,7 @@ log = logging.getLogger(__name__)
 def _get_diaspora_all_scope() -> str:
     return os.getenv(
         "DIASPORA_SCOPE",
-        f"https://auth.globus.org/scopes/{DIASPORA_RESOURCE_SERVER}/action_all"
+        f"https://auth.globus.org/scopes/{DIASPORA_RESOURCE_SERVER}/action_all",
     )
 
 
@@ -57,8 +57,7 @@ class LoginManager:
     }
 
     def __init__(self, *, environment: str | None = None) -> None:
-        self._token_storage = get_token_storage_adapter(
-            environment=environment)
+        self._token_storage = get_token_storage_adapter(environment=environment)
         self._access_lock = threading.Lock()
 
     @property

{diaspora-event-sdk-0.1.1 → diaspora-event-sdk-0.1.2}/diaspora_event_sdk/sdk/web_client.py

@@ -7,7 +7,6 @@ from ._environments import TOKEN_EXCHANGE
 
 
 class WebClient(globus_sdk.BaseClient):
-
     def __init__(
         self,
         *,
@@ -25,13 +24,21 @@ class WebClient(globus_sdk.BaseClient):
         self.user_app_name = app_name
 
     def create_key(self, subject: UUID_LIKE_T) -> globus_sdk.GlobusHTTPResponse:
-        return self.post("/v2/create_key", headers={"Subject": str(subject)})
+        return self.post("/v1/create_key", headers={"Subject": str(subject)})
 
     def list_topics(self, subject: UUID_LIKE_T) -> globus_sdk.GlobusHTTPResponse:
-        return self.get("/v2/list_topics", headers={"Subject": str(subject)})
-
-    def register_topic(self, subject: UUID_LIKE_T, topic: str) -> globus_sdk.GlobusHTTPResponse:
-        return self.post("/v2/register_topic", headers={"Subject": str(subject), "Topic": topic})
-
-    def unregister_topic(self, subject: UUID_LIKE_T, topic: str) -> globus_sdk.GlobusHTTPResponse:
-        return self.post("/v2/unregister_topic", headers={"Subject": str(subject), "Topic": topic})
+        return self.get("/v1/list_topics", headers={"Subject": str(subject)})
+
+    def register_topic(
+        self, subject: UUID_LIKE_T, topic: str
+    ) -> globus_sdk.GlobusHTTPResponse:
+        return self.post(
+            "/v1/register_topic", headers={"Subject": str(subject), "Topic": topic}
+        )
+
+    def unregister_topic(
+        self, subject: UUID_LIKE_T, topic: str
+    ) -> globus_sdk.GlobusHTTPResponse:
+        return self.post(
+            "/v1/unregister_topic", headers={"Subject": str(subject), "Topic": topic}
+        )

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

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

diaspora-event-sdk-0.1.2/diaspora_event_sdk.egg-info/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: diaspora-event-sdk
+Version: 0.1.2
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: globus-sdk<4,>=3.20.1
+Provides-Extra: kafka-python
+Requires-Dist: kafka-python; extra == "kafka-python"
+Requires-Dist: aws-msk-iam-sasl-signer-python; extra == "kafka-python"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: tox; extra == "test"
+Requires-Dist: check-manifest; extra == "test"
+
+# Diaspora: Resilience-enabling services for science from HPC to edge
+
+## Event Fabric SDK Installation Guide
+### Recommended Method: Use with `kafka-python`
+For easy integration with Diaspora Event Fabric, use the `KafkaProducer` and `KafkaConsumer` classes from our SDK. This requires the `kafka-python` library.
+
+To install the Event Fabric SDK and `kafka-python,` with the following command:
+```bash
+pip install "diaspora-event-sdk[kafka-python]"
+```
+
+### Alternative Installation: Without Kafka Client Library
+To use alternative Kafka client libraries (e.g., `confluent-kafka-python`, `aiokafka`, and libraries for other programming laguages), you can install the SDK without the `kafka-python` dependency. This option still provides topic-level access control (authorization) and login credential management features.
+
+To install the SDK without `kafka-python`, use:
+```bash
+pip install diaspora-event-sdk
+```
+Note: This method does not include dependencies for `KafkaProducer` and `KafkaConsumer` classes mentioned in the QuickStart
+
+## Use Diaspora Event Fabric SDK
+
+**Getting Started**: Visit our [QuickStart Guide](docs/quickstart.md) for details on using the SDK with the kafka-python library and instructions for other Kafka clients.
+
+**Troubleshooting and Credential Management**: Consult our [TrobleShooting Guide](docs/troubleshooting.md) for solving common issues and tips on managing keys effectively.
+
+**Advanced Usage**: Explore the [Faust Streaming Guide](docs/faust_weather_app.md) for advanced event streaming with Faust.

{diaspora-event-sdk-0.1.1 → diaspora-event-sdk-0.1.2}/tests/unit/test_client.py

@@ -1,20 +1,31 @@
 import pytest
-from unittest.mock import Mock, patch
+from unittest.mock import Mock
 from unittest.mock import MagicMock
 from diaspora_event_sdk import Client
 from diaspora_event_sdk.sdk.web_client import WebClient
 from diaspora_event_sdk.sdk.login_manager import LoginManager
 
+
 @pytest.fixture
-def mock_login_manager(): # TODO
+def mock_login_manager():  # TODO
     login_manager = Mock(spec=LoginManager())
     login_manager.get_web_client.return_value = Mock(spec=WebClient)
     login_manager.get_auth_client.return_value = Mock(
-        oauth2_userinfo=lambda: {"sub": "test_sub"})
+        oauth2_userinfo=lambda: {"sub": "test_sub"}
+    )
     login_manager._token_storage.get_token_data.return_value = {
-        'access_key': 'test_access', 'secret_key': 'test_secret'}
+        "username": "test_sub",
+        "access_key": "test_access",
+        "secret_key": "test_secret",
+        "endpoint": "test_endpoint",
+    }
     login_manager.get_web_client.return_value.create_key.return_value = {
-        "status": "success", "access_key": "new_access", "secret_key": "new_secret"}
+        "status": "success",
+        "username": "test_sub",
+        "access_key": "new_access",
+        "secret_key": "new_secret",
+        "endpoint": "new_endpoint",
+    }
 
     # Use MagicMock for _access_lock
     login_manager._access_lock = MagicMock()
@@ -40,12 +51,20 @@ def test_logout(client):
 
 def test_create_key(client):
     result = client.create_key()
-    assert result == {"username": "test_sub", "password": "new_secret"}
+    assert result == {
+        "access_key": "new_access",
+        "secret_key": "new_secret",
+        "endpoint": "new_endpoint",
+    }
 
 
 def test_retrieve_key_existing(client):
     result = client.retrieve_key()
-    assert result == {"username": "test_sub", "password": "test_secret"}
+    assert result == {
+        "access_key": "test_access",
+        "secret_key": "test_secret",
+        "endpoint": "test_endpoint",
+    }
 
 
 def test_retrieve_key_missing(client, mock_login_manager):
@@ -53,14 +72,15 @@ def test_retrieve_key_missing(client, mock_login_manager):
     # the second call returns scope, resource_server, access_token, refresh_token, etc.
     mock_login_manager._token_storage.get_token_data.side_effect = [
         None,
-        {'scope': 'scope', 'resource_server': 'resource_server'}
+        {"scope": "scope", "resource_server": "resource_server"},
     ]
 
     # should internally call create_key
     result = client.retrieve_key()
 
-    assert result["username"] == "test_sub"
-    assert result["password"] == "new_secret"
+    assert result["access_key"] == "new_access"
+    assert result["secret_key"] == "new_secret"
+    assert result["endpoint"] == "new_endpoint"
 
 
 def test_list_topics(client):

diaspora-event-sdk-0.1.1/PKG-INFO

@@ -1,47 +0,0 @@
-Metadata-Version: 2.1
-Name: diaspora-event-sdk
-Version: 0.1.1
-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
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: globus-sdk<4,>=3.20.1
-Provides-Extra: kafka-python
-Requires-Dist: kafka-python; extra == "kafka-python"
-Requires-Dist: aws-msk-iam-sasl-signer-python; extra == "kafka-python"
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: coverage; extra == "test"
-Requires-Dist: mypy; extra == "test"
-Requires-Dist: tox; extra == "test"
-Requires-Dist: check-manifest; extra == "test"
-
-<h1>Diaspora Event Fabric: Resilience-enabling services for science from HPC to edge</h1>
-
-## Installation
-### Recommended Installation with Kafka Client Library
-The `KafkaProducer` and `KafkaConsumer` classes within the SDK are designed for seamless integration with Diaspora Event Fabric using pre-configured settings. For utilizing these classes, the `kafka-python` library is necessary.
-
-To install the Diaspora Event SDK along with `kafka-python,` execute:
-```bash
-pip install "diaspora-event-sdk[kafka-python]"
-```
-
-### Installation Without Kafka Client Library
-If you prefer using different client libraries for Kafka communication, you can install the SDK without the kafka-python dependency. The SDK still serves for topic-level access control (authorization) and login credential management (authentication).
-
-To install the SDK without client libraries, simply run:
-```bash
-pip install diaspora-event-sdk
-```
-Note: This does not install the necessary dependency for `KafkaProducer` and `KafkaConsumer` classes.
-
-## Use Diaspora Event Fabric SDK
-
-Please refer to our [QuickStart Guide](docs/quickstart.md) for recommended use with `kafka-python` library as well as steps to use your own Kafka client.
-
-Please refer to our [TrobleShooting Guide](docs/troubleshooting.md) for debugging common problems and effective key management strategies.
-
-[Topic: Use faust to Process Records](docs/faust_weather_app.md)

diaspora-event-sdk-0.1.1/README.md

@@ -1,27 +0,0 @@
-<h1>Diaspora Event Fabric: Resilience-enabling services for science from HPC to edge</h1>
-
-## Installation
-### Recommended Installation with Kafka Client Library
-The `KafkaProducer` and `KafkaConsumer` classes within the SDK are designed for seamless integration with Diaspora Event Fabric using pre-configured settings. For utilizing these classes, the `kafka-python` library is necessary.
-
-To install the Diaspora Event SDK along with `kafka-python,` execute:
-```bash
-pip install "diaspora-event-sdk[kafka-python]"
-```
-
-### Installation Without Kafka Client Library
-If you prefer using different client libraries for Kafka communication, you can install the SDK without the kafka-python dependency. The SDK still serves for topic-level access control (authorization) and login credential management (authentication).
-
-To install the SDK without client libraries, simply run:
-```bash
-pip install diaspora-event-sdk
-```
-Note: This does not install the necessary dependency for `KafkaProducer` and `KafkaConsumer` classes.
-
-## Use Diaspora Event Fabric SDK
-
-Please refer to our [QuickStart Guide](docs/quickstart.md) for recommended use with `kafka-python` library as well as steps to use your own Kafka client.
-
-Please refer to our [TrobleShooting Guide](docs/troubleshooting.md) for debugging common problems and effective key management strategies.
-
-[Topic: Use faust to Process Records](docs/faust_weather_app.md)

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

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

diaspora-event-sdk-0.1.1/diaspora_event_sdk.egg-info/PKG-INFO

@@ -1,47 +0,0 @@
-Metadata-Version: 2.1
-Name: diaspora-event-sdk
-Version: 0.1.1
-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
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: globus-sdk<4,>=3.20.1
-Provides-Extra: kafka-python
-Requires-Dist: kafka-python; extra == "kafka-python"
-Requires-Dist: aws-msk-iam-sasl-signer-python; extra == "kafka-python"
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: coverage; extra == "test"
-Requires-Dist: mypy; extra == "test"
-Requires-Dist: tox; extra == "test"
-Requires-Dist: check-manifest; extra == "test"
-
-<h1>Diaspora Event Fabric: Resilience-enabling services for science from HPC to edge</h1>
-
-## Installation
-### Recommended Installation with Kafka Client Library
-The `KafkaProducer` and `KafkaConsumer` classes within the SDK are designed for seamless integration with Diaspora Event Fabric using pre-configured settings. For utilizing these classes, the `kafka-python` library is necessary.
-
-To install the Diaspora Event SDK along with `kafka-python,` execute:
-```bash
-pip install "diaspora-event-sdk[kafka-python]"
-```
-
-### Installation Without Kafka Client Library
-If you prefer using different client libraries for Kafka communication, you can install the SDK without the kafka-python dependency. The SDK still serves for topic-level access control (authorization) and login credential management (authentication).
-
-To install the SDK without client libraries, simply run:
-```bash
-pip install diaspora-event-sdk
-```
-Note: This does not install the necessary dependency for `KafkaProducer` and `KafkaConsumer` classes.
-
-## Use Diaspora Event Fabric SDK
-
-Please refer to our [QuickStart Guide](docs/quickstart.md) for recommended use with `kafka-python` library as well as steps to use your own Kafka client.
-
-Please refer to our [TrobleShooting Guide](docs/troubleshooting.md) for debugging common problems and effective key management strategies.
-
-[Topic: Use faust to Process Records](docs/faust_weather_app.md)