https://github.com/upstash/qstash-py
Python SDK for Upstash QStash
https://github.com/upstash/qstash-py
qstash sdk-python upstash upstash-sdk
Last synced: 3 months ago
JSON representation
Python SDK for Upstash QStash
- Host: GitHub
- URL: https://github.com/upstash/qstash-py
- Owner: upstash
- License: mit
- Created: 2023-12-19T20:04:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T07:05:26.000Z (5 months ago)
- Last Synced: 2025-06-22T02:50:03.420Z (4 months ago)
- Topics: qstash, sdk-python, upstash, upstash-sdk
- Language: Python
- Homepage: https://docs.upstash.com/qstash
- Size: 235 KB
- Stars: 18
- Watchers: 9
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Upstash Python QStash SDK
> [!NOTE]
> **This project is in GA Stage.**
>
> The Upstash Professional Support fully covers this project. It receives regular updates, and bug fixes.
> The Upstash team is committed to maintaining and improving its functionality.
**QStash** is an HTTP based messaging and scheduling solution for serverless and edge runtimes.
[QStash Documentation](https://upstash.com/docs/qstash)
### Install
```shell
pip install qstash
```
### Usage
You can get your QStash token from the [Upstash Console](https://console.upstash.com/qstash).
#### Publish a JSON message
```python
from qstash import QStash
client = QStash("")
res = client.message.publish_json(
url="https://example.com",
body={"hello": "world"},
headers={
"test-header": "test-value",
},
)
print(res.message_id)
```
#### [Create a scheduled message](https://upstash.com/docs/qstash/features/schedules)
```python
from qstash import QStash
client = QStash("")
schedule_id = client.schedule.create(
destination="https://example.com",
cron="*/5 * * * *",
)
print(schedule_id)
```
#### [Receiving messages](https://upstash.com/docs/qstash/howto/receiving)
```python
from qstash import Receiver
# Keys available from the QStash console
receiver = Receiver(
current_signing_key="CURRENT_SIGNING_KEY",
next_signing_key="NEXT_SIGNING_KEY",
)
# ... in your request handler
signature, body = req.headers["Upstash-Signature"], req.body
receiver.verify(
body=body,
signature=signature,
url="https://example.com", # Optional
)
```
#### Publish a JSON message to LLM Using Custom Providers
```python
from qstash import QStash
from qstash.chat import openai
client = QStash("")
res = client.message.publish_json(
api={"name": "llm", "provider": openai("")},
body={
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "user",
"content": "What is the capital of Turkey?",
}
],
},
callback="https://example-cb.com",
)
print(res.message_id)
```
#### Additional configuration
```python
from qstash import QStash
# Create a client with a custom retry configuration. This is
# for sending messages to QStash, not for sending messages to
# your endpoints.
# The default configuration is:
# {
# "retries": 5,
# "backoff": lambda retry_count: math.exp(retry_count) * 50,
# }
client = QStash(
token="",
retry={
"retries": 1,
"backoff": lambda retry_count: (2 ** retry_count) * 20,
},
)
# Publish to URL
client.message.publish_json(
url="https://example.com",
body={"key": "value"},
# Retry sending message to API 3 times
# https://upstash.com/docs/qstash/features/retry
retries=3,
# Schedule message to be sent 4 seconds from now
delay="4s",
# When message is sent, send a request to this URL
# https://upstash.com/docs/qstash/features/callbacks
callback="https://example.com/callback",
# When message fails to send, send a request to this URL
failure_callback="https://example.com/failure_callback",
# Headers to forward to the endpoint
headers={
"test-header": "test-value",
},
# Enable content-based deduplication
# https://upstash.com/docs/qstash/features/deduplication#content-based-deduplication
content_based_deduplication=True,
)
```
Additional methods are available for managing url groups, schedules, and messages. See the examples folder for more.
### Development
1. Clone the repository
2. Install [Poetry](https://python-poetry.org/docs/#installation)
3. Install dependencies with `poetry install`
4. Create a .env file with `cp .env.example .env` and fill in the `QSTASH_TOKEN`
5. Run tests with `poetry run pytest`
6. Format with `poetry run ruff format .`