42 releases
0.5.5 | Sep 25, 2023 |
---|---|
0.5.3 | Feb 28, 2023 |
0.4.0-rcn.11 | Oct 7, 2021 |
0.4.0-rc5 | Nov 19, 2020 |
0.2.5 | Mar 24, 2020 |
#86 in Asynchronous
7,871 downloads per month
Used in tourniquet-celery
1MB
5.5K
SLoC
A Rust implementation of Celery for producing and consuming asynchronous tasks with a distributed message queue.
We welcome contributions from everyone regardless of your experience level with Rust. For complete beginners, see HACKING_QUICKSTART.md.
If you already know the basics of Rust but are new to Celery, check out the Rusty Celery Book or the original Python Celery Project.
Quick start
Define tasks by decorating functions with the task
attribute.
use celery::prelude::*;
#[celery::task]
fn add(x: i32, y: i32) -> TaskResult<i32> {
Ok(x + y)
}
Create an app with the app
macro
and register your tasks with it:
let my_app = celery::app!(
broker = AMQPBroker { std::env::var("AMQP_ADDR").unwrap() },
tasks = [add],
task_routes = [
"*" => "celery",
],
).await?;
Then send tasks to a queue with
my_app.send_task(add::new(1, 2)).await?;
And consume tasks as a worker from a queue with
my_app.consume().await?;
Examples
The examples/
directory contains:
- a simple Celery app implemented in Rust using an AMQP broker (
examples/celery_app.rs
), - the same Celery app implemented in Python (
examples/celery_app.py
), - and a Beat app implemented in Rust (
examples/beat_app.rs
).
Prerequisites
If you already have an AMQP broker running you can set the environment variable AMQP_ADDR
to your broker's URL (e.g., amqp://localhost:5672//
, where
the second slash at the end is the name of the default vhost).
Otherwise simply run the helper script:
./scripts/brokers/amqp.sh
This will download and run the official RabbitMQ image (RabbitMQ is a popular AMQP broker).
Run the examples
Run Rust Celery app
You can consume tasks with:
cargo run --example celery_app consume
And you can produce tasks with:
cargo run --example celery_app produce [task_name]
Current supported tasks for this example are: add
, buggy_task
, long_running_task
and bound_task
Run Python Celery app
Similarly, you can consume or produce tasks from Python by running
python examples/celery_app.py consume [task_name]
or
python examples/celery_app.py produce
You'll need to have Python 3 installed, along with the requirements listed in the requirements.txt
file. You'll also have to provide a task name. This example implements 4 tasks: add
, buggy_task
, long_running_task
and bound_task
Run Rust Beat app
You can start the Rust beat with:
cargo run --example beat_app
And then you can consume tasks from Rust or Python as explained above.
Road map and current state
✅ = Supported and mostly stable, although there may be a few incomplete features.
⚠️ = Partially implemented and under active development.
🔴 = Not supported yet but on-deck to be implemented soon.
Core
Status | Tracking | |
---|---|---|
Protocol | ⚠️ | |
Producers | ✅ | |
Consumers | ✅ | |
Brokers | ✅ | |
Beat | ✅ | |
Backends | 🔴 | |
Baskets | 🔴 |
Brokers
Status | Tracking | |
---|---|---|
AMQP | ✅ | |
Redis | ✅ |
Backends
Status | Tracking | |
---|---|---|
RPC | 🔴 | |
Redis | 🔴 |
Dependencies
~18–32MB
~492K SLoC