Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cofin/litestar-saq
SAQ Plugin for Litestar
https://github.com/cofin/litestar-saq
litestar litestar-api litestar-framework saq
Last synced: about 2 months ago
JSON representation
SAQ Plugin for Litestar
- Host: GitHub
- URL: https://github.com/cofin/litestar-saq
- Owner: cofin
- License: mit
- Created: 2023-10-04T03:31:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-03T21:11:28.000Z (3 months ago)
- Last Synced: 2024-10-14T09:54:11.136Z (2 months ago)
- Topics: litestar, litestar-api, litestar-framework, saq
- Language: Python
- Homepage:
- Size: 472 KB
- Stars: 18
- Watchers: 1
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-litestar - `litestar-saq` - A plugin for the [SAQ job queuing framework](https://github.com/tobymao/saq)<sup>*</sup> (Third-Party Extensions / General)
README
# Litestar SAQ
> [!IMPORTANT]
> This plugin currently contains minimal features and is a work-in-progress
## Installation
```shell
pip install litestar-saq
```
## Usage
Here is a basic application that demonstrates how to use the plugin.
```python
from __future__ import annotations
from litestar import Litestar
from litestar_saq import QueueConfig, SAQConfig, SAQPlugin
saq = SAQPlugin(config=SAQConfig(redis_url="redis://localhost:6397/0", queue_configs=[QueueConfig(name="samples")]))
app = Litestar(plugins=[saq])
```
You can start a background worker with the following command now:
```shell
litestar --app-dir=examples/ --app basic:app workers run
Using Litestar app from env: 'basic:app'
Starting SAQ Workers ──────────────────────────────────────────────────────────────────
INFO - 2023-10-04 17:39:03,255 - saq - worker - Worker starting: Queue>>, name='samples'>
INFO - 2023-10-04 17:39:06,545 - saq - worker - Worker shutting down
```
You can also start the process for only specific queues. This is helpful if you want separated processes working on different queues instead of combining them.
```shell
litestar --app-dir=examples/ --app basic:app workers run --queues sample
Using Litestar app from env: 'basic:app'
Starting SAQ Workers ──────────────────────────────────────────────────────────────────
INFO - 2023-10-04 17:39:03,255 - saq - worker - Worker starting: Queue>>, name='samples'>
INFO - 2023-10-04 17:39:06,545 - saq - worker - Worker shutting down
```
If you are starting the process for only specific queues and still want to read from the other queues or enqueue a task into another queue that was not initialized in your worker or is found somewhere else, you can do so like here
```
import os
from saq import Queue
def get_queue_directly(queue_name: str, redis_url: str) -> Queue:
return Queue.from_url(redis_url, name=queue_name)
redis_url = os.getenv("REDIS_URL")
queue = get_queue_directly("queue-in-other-process", redis_url)
# Get queue info
info = await queue.info(jobs=True)
# Enqueue new task
queue.enqueue(
....
)
```