From 15d734d65296f3a7af3d294dde6a49b339dc4f34 Mon Sep 17 00:00:00 2001 From: Haochen Pan <haochenpan@uchicago.edu> Date: Sun, 2 Jun 2024 10:34:17 -0400 Subject: [PATCH 1/3] bump to 0.3.1 --- README.md | 25 +++++++++++-------------- diaspora_event_sdk/version.py | 2 +- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4dc57b8..4ddf3ba 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,26 @@ -# Diaspora: Hybrid Event-Driven Architecture for Distributed Scientific Computing +# Diaspora Event Fabric SDK -## 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: +## Installation Guide +### Recommended Method: With `kafka-python` +To integrate with Diaspora Event Fabric using `KafkaProducer` and `KafkaConsumer`, install the SDK with `kafka-python`: ```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 languages), 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: +For other Kafka client libraries (e.g., `confluent-kafka-python`, `aiokafka`), install the SDK without `kafka-python`: ```bash pip install diaspora-event-sdk ``` -Note: This method does not include dependencies for `KafkaProducer` and `KafkaConsumer` classes mentioned in the QuickStart +Note: This does not include `KafkaProducer` and `KafkaConsumer` dependencies. -## Use Diaspora Event Fabric SDK +## Using Diaspora Event Fabric SDK +Check our [Notebook](DiasporaDemo.ipynb) for a quickstart and demonstration. -**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. +<!-- **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. +**Troubleshooting and Credential Management**: Consult our [TrobleShooting Guide](docs/troubleshooting.md) for solving common issues and tips on managing keys effectively. --> <!-- **Advanced Consumers with Faust**: Explore the [Faust Streaming Guide](docs/faust_weather_app.md) for advanced event streaming with Faust. --> -**Advanced Consumer Functions**: See our [Colab example](https://colab.research.google.com/drive/1tPKfxU2qPsLvNTreF6nKINU62k7pQWxa?usp=sharing) for demonstration. +<!-- **Advanced Consumer Functions**: See our [Colab example](https://colab.research.google.com/drive/1tPKfxU2qPsLvNTreF6nKINU62k7pQWxa?usp=sharing) for demonstration. --> diff --git a/diaspora_event_sdk/version.py b/diaspora_event_sdk/version.py index 493f741..260c070 100644 --- a/diaspora_event_sdk/version.py +++ b/diaspora_event_sdk/version.py @@ -1 +1 @@ -__version__ = "0.3.0" +__version__ = "0.3.1" From 7044c31508332a8ee6998edf00849d9c24ce94f6 Mon Sep 17 00:00:00 2001 From: Haochen Pan <haochenpan@uchicago.edu> Date: Sun, 2 Jun 2024 10:47:41 -0400 Subject: [PATCH 2/3] Create release.yml --- .github/workflows/release.yml | 38 +++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..3d6911a --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,38 @@ +name: release + +on: + push: + tags: + - 'v*.*.*' # Trigger on version tags + +jobs: + pypi-publish: + name: Upload release to PyPI + runs-on: ubuntu-latest + environment: + name: pypi + url: https://pypi.org/project/diaspora-event-sdk + permissions: + id-token: write # IMPORTANT: this permission is mandatory for trusted publishing + + steps: + - name: Check out code + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: '3.11' # Specify the Python version you need + + - name: Install build tools + run: | + python -m pip install --upgrade pip + pip install setuptools wheel twine + + - name: Build package + run: python setup.py sdist bdist_wheel + + - name: Publish package distributions to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + + From 46892185c284f6682c27cf5c6a8ec0e2659ddb8c Mon Sep 17 00:00:00 2001 From: Haochen Pan <haochenpan@uchicago.edu> Date: Sun, 2 Jun 2024 10:47:50 -0400 Subject: [PATCH 3/3] Update release.yml --- .github/workflows/release.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3d6911a..97da866 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -34,5 +34,3 @@ jobs: - name: Publish package distributions to PyPI uses: pypa/gh-action-pypi-publish@release/v1 - -