Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kiwamizamurai/tsumugi
Tsumugi🧵⚙️ A lightweight and type-safe workflow engine for Rust
https://github.com/kiwamizamurai/tsumugi
lightweight orchestration rust workflow workflow-engine
Last synced: 1 day ago
JSON representation
Tsumugi🧵⚙️ A lightweight and type-safe workflow engine for Rust
- Host: GitHub
- URL: https://github.com/kiwamizamurai/tsumugi
- Owner: kiwamizamurai
- Created: 2025-01-05T12:05:39.000Z (3 days ago)
- Default Branch: main
- Last Pushed: 2025-01-05T12:11:05.000Z (3 days ago)
- Last Synced: 2025-01-05T13:19:17.165Z (3 days ago)
- Topics: lightweight, orchestration, rust, workflow, workflow-engine
- Language: Rust
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tsumugi (紡)
[](https://crates.io/crates/tsumugi)
[](https://docs.rs/tsumugi)
[](LICENSE)
A lightweight and simple workflow engine for Rust, designed for building type-safe and maintainable workflows. The name "Tsumugi" (紡) means "to spin" or "to weave" in Japanese, representing how this engine elegantly weaves together different tasks into a robust workflow.
## Features
- 🪶 **Lightweight**: Minimal dependencies, focused on core workflow functionality
- 🎯 **Type-safe**: Generic type system for workflow data
- ⚡ **Async First**: Built with async-trait for asynchronous workflows
- 🛠️ **Configurable**: Per-step timeout settings (default: 30s)
- 📊 **Context Aware**: Type-safe context for data sharing between steps
- 🔄 **Error Handling**: Built-in timeout handling and error hooks
- 🔍 **Tracing**: Basic execution logging and step tracking
## Quick Start
Add to your `Cargo.toml`:
```toml
[dependencies]
tsumugi = "0.1"
async-trait = "0.1"
```
Create a simple workflow:
```rust
use tsumugi::prelude::*;
use async_trait::async_trait;
// Define your step
define_step!(DataLoadStep);
#[async_trait]
impl Step for DataLoadStep {
async fn execute(&self, ctx: &mut Context) -> Result, WorkflowError> {
println!("Loading data...");
ctx.insert("data", "Hello, World!".to_string());
Ok(None)
}
}
// Create and run workflow
#[tokio::main]
async fn main() -> Result<(), Box> {
let workflow = Workflow::builder()
.add::()
.start_with_type::()
.build()?;
let mut ctx = Context::new();
workflow.execute(&mut ctx).await?;
Ok(())
}
```
## Core Concepts
### Steps
Steps are the building blocks of workflows. Each step:
- Implements the `Step` trait with generic type parameter
- Can access and modify the workflow context
- Can specify the next step to execute via return value
- Has configurable timeout settings (default: 30s)
- Supports `on_success` and `on_failure` hooks
### Context
The `Context` type provides:
- Type-safe data storage with generic type parameter
- Key-value based data sharing between steps
- Basic execution tracking (elapsed time)
- Metadata storage for additional information
### Error Handling
Built-in error handling with:
- Step-specific errors (StepError, Timeout, StepNotFound, Configuration)
- Basic timeout handling with configurable duration (default: 30s)
- Error hooks with `on_success` and `on_failure` callbacks
- Error propagation with detailed error types
## Examples
Check out the [examples](examples/) directory for more complex use cases:
- [Simple Workflow](examples/simple_workflow.rs) - Basic workflow demonstration
- [Order Processing](examples/order_workflow.rs) - Complex business workflow
- [User Scoring](examples/user_scoring_workflow.rs) - Data processing pipeline
# tsumugi