buffalo-workflow 0.1.4

A workflow automation tool

Buffalo

Buffalo is a powerful workflow management tool designed for quickly creating and managing project workflows. It provides a simple and flexible way to define, track, and manage tasks and workflows within projects.

Key Features

• 🚀 Quick project creation and management
• 📋 YAML-based workflow definition
• 🔄 Work status tracking and management
• 📁 Project template support
• 🔍 Flexible work retrieval mechanism
• 💾 Automatic project state saving and loading

Installation

pip install buffalo-workflow

Quick Start

1. Create a workflow template file (e.g., workflow_template.yml):

workflow:
  works:
    - name: "task_1"
      status: not_started
      output_file: "output_1.md"
      comment: "First task"
    - name: "task_2"
      status: not_started
      output_file: "output_2.md"
      comment: "Second task"

2. Use Buffalo to create and manage projects:

from pathlib import Path
from buffalo import Buffalo

# Initialize Buffalo
base_dir = Path("./projects")
template_path = Path("./workflow_template.yml")
buffalo = Buffalo(base_dir, template_path)

# Create a new project
project = buffalo.create_project("my_project")

# Get a pending task
project, work = buffalo.get_a_job("task_1")

# Update task status
buffalo.update_work_status(project.folder_name, work, "in_progress")

Project Structure

my_project/
├── buffalo.yml          # Project configuration file
└── workflow_description.yml  # Workflow description file

Requirements

• Python >= 3.8
• PyYAML >= 5.1
• setuptools >= 42.0.0

License

MIT License

Contributing

Issues and Pull Requests are welcome!

Links

• Homepage
• Issue Tracker