From 9dca0cebdde9a61074f47364f44a6eb5deceef99 Mon Sep 17 00:00:00 2001 From: Achille Roussel Date: Fri, 1 Mar 2024 16:02:23 -0800 Subject: [PATCH] rename from dispatch-sdk-python to dispatch-py Signed-off-by: Achille Roussel --- .github/workflows/pypi.yml | 2 +- README.md | 18 +++++++++--------- docs/index.md | 4 ++-- examples/getting_started/app.py | 2 +- pyproject.toml | 4 ++-- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml index 8f4724d1..275df600 100644 --- a/.github/workflows/pypi.yml +++ b/.github/workflows/pypi.yml @@ -88,7 +88,7 @@ jobs: runs-on: ubuntu-latest environment: name: pypi - url: https://pypi.org/p/dispatch-functions + url: https://pypi.org/p/dispatch-py permissions: contents: read id-token: write diff --git a/README.md b/README.md index 331560df..4e2438e7 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,19 @@

-# Dispatch SDK for Python +# dispatch-py -[![Docs](https://github.com/stealthrocket/dispatch-sdk-python/actions/workflows/docs.yml/badge.svg?branch=)](https://github.com/stealthrocket/dispatch-sdk-python/actions/workflows/docs.yml) -[![PyPI](https://github.com/stealthrocket/dispatch-sdk-python/actions/workflows/pypi.yml/badge.svg?branch=)](https://github.com/stealthrocket/dispatch-sdk-python/actions/workflows/pypi.yml) -[![Test](https://github.com/stealthrocket/dispatch-sdk-python/actions/workflows/test.yml/badge.svg?branch=)](https://github.com/stealthrocket/dispatch-sdk-python/actions/workflows/test.yml) -[![PyPI version](https://badge.fury.io/py/dispatch-functions.svg)](https://badge.fury.io/py/dispatch-functions) +[![Docs](https://github.com/stealthrocket/dispatch-py/actions/workflows/docs.yml/badge.svg?branch=)](https://github.com/stealthrocket/dispatch-py/actions/workflows/docs.yml) +[![PyPI](https://github.com/stealthrocket/dispatch-py/actions/workflows/pypi.yml/badge.svg?branch=)](https://github.com/stealthrocket/dispatch-py/actions/workflows/pypi.yml) +[![Test](https://github.com/stealthrocket/dispatch-py/actions/workflows/test.yml/badge.svg?branch=)](https://github.com/stealthrocket/dispatch-py/actions/workflows/test.yml) +[![PyPI version](https://badge.fury.io/py/dispatch-py.svg)](https://badge.fury.io/py/dispatch-py) [![Reference](https://img.shields.io/badge/API-Reference-lightblue.svg)](https://python.stealthrocket.cloud/main/reference/dispatch/) -This package implements the Dispatch SDK for Python. +Python package to develop applications with the Dispatch platform. [fastapi]: https://fastapi.tiangolo.com/tutorial/first-steps/ [ngrok]: https://ngrok.com/ -[pypi]: https://pypi.org/project/dispatch-functions/ +[pypi]: https://pypi.org/project/dispatch-py/ [signup]: https://docs.stealthrocket.cloud/stateful-functions/getting-started - [What is Dispatch?](#what-is-dispatch) @@ -39,9 +39,9 @@ To get started, follow the instructions to [sign up for Dispatch][signup] 🚀. ## Installation -This package is published on [PyPI][pypi] as **dispatch-functions**, to install: +This package is published on [PyPI][pypi] as **dispatch-py**, to install: ```sh -pip install dispatch-functions +pip install dispatch-py ``` ## Usage diff --git a/docs/index.md b/docs/index.md index 3113224d..f0244557 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,8 +3,8 @@ This is the API reference for the Python SDK of Dispatch. - Tutorials and guides: [docs.stealthrocket.cloud][docs]. -- Source: [stealthrocket/dispatch-sdk-python][github]. +- Source: [stealthrocket/dispatch-py][github]. [docs]: https://docs.stealthrocket.cloud -[github]: https://github.com/stealthrocket/dispatch-sdk-python +[github]: https://github.com/stealthrocket/dispatch-py diff --git a/examples/getting_started/app.py b/examples/getting_started/app.py index ec2f2c66..5f47b43b 100644 --- a/examples/getting_started/app.py +++ b/examples/getting_started/app.py @@ -28,7 +28,7 @@ ## Install dependencies -pip install dispatch-functions[fastapi] requests uvicorn[standard] +pip install dispatch-py[fastapi] requests uvicorn[standard] # Launch the example diff --git a/pyproject.toml b/pyproject.toml index e850c35e..a9d36b6f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,8 +3,8 @@ requires = ["setuptools >= 61.0", "wheel", "setuptools-git-versioning<2"] build-backend = "setuptools.build_meta" [project] -name = "dispatch-functions" -description = "Python SDK for Dispatch Stateful Functions" +name = "dispatch-py" +description = "Develop reliable distributed systems on the Dispatch platform." readme = "README.md" dynamic = ["version"] requires-python = ">= 3.11"