rcrewai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 238ca2da0ed667c87b39f231b6894b255149a50fa387dcc46c24ad45ce1b43d0
+  data.tar.gz: 8b297c1c3aeee3c90cc4ae2f11dfe789b9d81461a866c1d0e3ac7bf5e4be0269
+SHA512:
+  metadata.gz: 305fdb4e2a01c16a0100dc14acb2171e66b9584d46aa94f61b64427e3951590a8c7d90eac0fe8df25216ecdf8b04684f0131255f5426206793725e6e874b88d0
+  data.tar.gz: faee1733ba9df9e40cbb74cfd756c0c95e3cdc5a4b25e59f0e712e24f9a32778c295a2de84b1d57f45bde53ec43d09f5442eb8a4ab32365fc117f4341410f812

data/CHANGELOG.md

@@ -0,0 +1,108 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2025-01-12
+
+### Added
+
+#### Core Features
+- **Intelligent Agent System**: AI agents with reasoning loops, memory, and tool usage capabilities
+- **Multi-LLM Support**: Complete implementations for OpenAI, Anthropic, Google Gemini, Azure OpenAI, and Ollama
+- **Advanced Task Orchestration**: Sequential, hierarchical, and async/concurrent execution modes
+- **Human-in-the-Loop Integration**: Interactive approval workflows, real-time guidance, and collaborative decision making
+
+#### Agent Capabilities
+- Reasoning loops with configurable iterations and timeouts
+- Short-term and long-term memory systems
+- Tool usage with intelligent selection
+- Manager agents with delegation capabilities
+- Human interaction support (approval, guidance, reviews)
+
+#### Task System
+- Task dependencies and context sharing
+- Retry logic with exponential backoff
+- Async/concurrent execution with dependency management
+- Human confirmation and review points
+- Callback support and error handling
+
+#### Tool Ecosystem
+- **Web Search**: DuckDuckGo integration for research
+- **File Operations**: Read/write files with security controls
+- **SQL Database**: Secure database querying with connection management
+- **Email Integration**: SMTP email sending with attachment support
+- **Code Execution**: Sandboxed code execution environment
+- **PDF Processing**: Text extraction and document processing
+- **Custom Tool Framework**: Easy framework for building specialized tools
+
+#### Orchestration Modes
+- **Sequential Process**: Tasks execute one after another with dependency resolution
+- **Hierarchical Process**: Manager agents coordinate and delegate to specialist agents
+- **Async Execution**: Parallel task processing with intelligent dependency management
+- **Human Oversight**: Interactive workflows with human collaboration points
+
+#### LLM Provider Support
+- **OpenAI**: GPT-4, GPT-3.5-turbo, and legacy completion models
+- **Anthropic**: Claude-3 Opus/Sonnet/Haiku, Claude-2.1/2.0
+- **Google**: Gemini Pro, Gemini Pro Vision, Gemini 1.5 models
+- **Azure OpenAI**: Full compatibility with Azure OpenAI deployments
+- **Ollama**: Local LLM support with model management
+
+#### Human-in-the-Loop Features
+- Task execution confirmation workflows
+- Tool usage approval systems
+- Real-time human guidance during agent reasoning
+- Final answer review and revision capabilities
+- Error recovery with human intervention options
+- Session tracking and interaction history
+
+#### Production Features
+- Comprehensive error handling and recovery
+- Security controls and input validation
+- Detailed logging and debugging support
+- Memory management and cleanup
+- Configuration validation and environment variable support
+- CLI interface for crew management
+
+#### Development & Testing
+- Comprehensive test suite with >90% coverage
+- RSpec tests for all core components
+- Mock LLM responses for reliable testing
+- WebMock/VCR for HTTP interaction testing
+- Continuous Integration setup
+- Code quality checks with RuboCop
+
+### Technical Details
+
+#### Dependencies
+- **thor**: CLI framework for command-line interface
+- **zeitwerk**: Code loading and autoloading
+- **faraday**: HTTP client for API interactions
+- **concurrent-ruby**: Thread-safe concurrent execution
+- **nokogiri**: HTML/XML parsing for web scraping
+- **pdf-reader**: PDF text extraction capabilities
+- **mail**: SMTP email functionality
+
+#### Architecture
+- Modular design with clear separation of concerns
+- Plugin-based tool system for extensibility
+- Event-driven human interaction system
+- Thread-safe concurrent execution
+- Memory-efficient resource management
+- Flexible configuration system
+
+### Documentation
+- Complete API documentation with examples
+- Human-in-the-loop integration guide
+- LLM provider configuration examples
+- Production deployment guidelines
+- CLI usage documentation
+- Real-world use cases and examples
+
+[Unreleased]: https://github.com/gkosmo/rcrewAI/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/gkosmo/rcrewAI/releases/tag/v0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 gkosmo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,328 @@
+# RCrewAI
+
+![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=for-the-badge&logo=ruby&logoColor=white)
+![AI](https://img.shields.io/badge/AI-Agents-blue?style=for-the-badge)
+![Production Ready](https://img.shields.io/badge/Production-Ready-green?style=for-the-badge)
+
+Build powerful AI agent crews in Ruby that work together to accomplish complex tasks.
+
+RCrewAI is a Ruby implementation of the CrewAI framework, allowing you to create autonomous AI agents that collaborate to solve problems and complete tasks with human oversight and enterprise-grade features.
+
+## 🚀 Features
+
+- **🤖 Intelligent Agents**: AI agents with reasoning loops, memory, and tool usage capabilities
+- **🔗 Multi-LLM Support**: OpenAI, Anthropic (Claude), Google (Gemini), Azure OpenAI, and Ollama
+- **🛠️ Rich Tool Ecosystem**: Web search, file operations, SQL, email, code execution, PDF processing, and custom tools
+- **🧠 Agent Memory**: Short-term and long-term memory for learning from past executions
+- **🤝 Human-in-the-Loop**: Interactive approval workflows, human guidance, and collaborative decision making
+- **⚡ Advanced Task System**: Dependencies, retries, async/concurrent execution, and context sharing
+- **🏗️ Hierarchical Teams**: Manager agents that coordinate and delegate tasks to specialist agents
+- **🔒 Production Ready**: Security controls, error handling, logging, monitoring, and sandboxing
+- **🎯 Flexible Orchestration**: Sequential, hierarchical, and concurrent execution modes
+- **💎 Ruby-First Design**: Built specifically for Ruby developers with idiomatic patterns
+
+## 📦 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rcrewai'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install rcrewai
+```
+
+## 🏃‍♂️ Quick Start
+
+```ruby
+require 'rcrewai'
+
+# Configure your LLM provider
+RCrewAI.configure do |config|
+  config.llm_provider = :openai  # or :anthropic, :google, :azure, :ollama
+  config.temperature = 0.1
+end
+
+# Create intelligent agents with specialized tools
+researcher = RCrewAI::Agent.new(
+  name: "researcher",
+  role: "Senior Research Analyst",
+  goal: "Uncover cutting-edge developments in AI",
+  backstory: "Expert at finding and analyzing the latest tech trends",
+  tools: [RCrewAI::Tools::WebSearch.new],
+  verbose: true
+)
+
+writer = RCrewAI::Agent.new(
+  name: "writer", 
+  role: "Tech Content Strategist",
+  goal: "Create compelling technical content",
+  backstory: "Skilled at transforming research into engaging articles",
+  tools: [RCrewAI::Tools::FileWriter.new]
+)
+
+# Create crew with sequential process
+crew = RCrewAI::Crew.new("ai_research_crew")
+crew.add_agent(researcher)
+crew.add_agent(writer)
+
+# Define tasks with dependencies
+research_task = RCrewAI::Task.new(
+  name: "research_ai_trends",
+  description: "Research the latest developments in AI for 2024",
+  agent: researcher,
+  expected_output: "Comprehensive report on AI trends with key insights"
+)
+
+writing_task = RCrewAI::Task.new(
+  name: "write_article",
+  description: "Write an engaging 1000-word article about AI trends",
+  agent: writer,
+  context: [research_task],  # Uses research results as context
+  expected_output: "Publication-ready article saved as ai_trends.md"
+)
+
+crew.add_task(research_task)
+crew.add_task(writing_task)
+
+# Execute - agents will reason, search, and produce real results!
+results = crew.execute
+puts "✅ Crew completed #{results[:completed_tasks]}/#{results[:total_tasks]} tasks"
+```
+
+## 🎯 Key Capabilities
+
+### 🧠 Advanced Agent Intelligence
+- **Multi-step Reasoning**: Complex problem decomposition and solving
+- **Tool Selection**: Intelligent tool usage based on task requirements  
+- **Context Awareness**: Memory-driven decision making from past executions
+- **Learning Capability**: Short-term and long-term memory systems
+
+### 🛠️ Comprehensive Tool Ecosystem
+- **Web Search**: DuckDuckGo integration for research
+- **File Operations**: Read/write files with security controls
+- **SQL Database**: Secure database querying with connection management
+- **Email Integration**: SMTP email sending with attachment support
+- **Code Execution**: Sandboxed code execution environment
+- **PDF Processing**: Text extraction and document processing
+- **Custom Tools**: Extensible framework for building specialized tools
+
+### 🤝 Human-in-the-Loop Integration
+- **Interactive Approval**: Human confirmation for sensitive operations
+- **Real-time Guidance**: Human input during agent reasoning processes
+- **Task Confirmation**: Human approval before executing critical tasks
+- **Result Validation**: Human review and revision of agent outputs
+- **Error Recovery**: Human intervention when agents encounter failures
+
+### 🏗️ Enterprise-Grade Orchestration  
+- **Hierarchical Teams**: Manager agents coordinate and delegate to specialists
+- **Async Execution**: Parallel task processing with intelligent dependency management
+- **Delegation Systems**: Automatic task assignment based on agent capabilities
+- **Process Types**: Sequential, hierarchical, and consensual execution modes
+
+## 🔧 LLM Provider Support
+
+```ruby
+# OpenAI (GPT-4, GPT-3.5, etc.)
+RCrewAI.configure do |config|
+  config.llm_provider = :openai
+  config.openai_api_key = ENV['OPENAI_API_KEY']
+  config.model = 'gpt-4'
+end
+
+# Anthropic Claude
+RCrewAI.configure do |config|
+  config.llm_provider = :anthropic
+  config.anthropic_api_key = ENV['ANTHROPIC_API_KEY'] 
+  config.model = 'claude-3-sonnet-20240229'
+end
+
+# Google Gemini
+RCrewAI.configure do |config|
+  config.llm_provider = :google
+  config.google_api_key = ENV['GOOGLE_API_KEY']
+  config.model = 'gemini-pro'
+end
+
+# Azure OpenAI
+RCrewAI.configure do |config|
+  config.llm_provider = :azure
+  config.azure_api_key = ENV['AZURE_OPENAI_API_KEY']
+  config.azure_endpoint = ENV['AZURE_OPENAI_ENDPOINT']
+  config.model = 'gpt-4'
+end
+
+# Local Ollama
+RCrewAI.configure do |config|
+  config.llm_provider = :ollama
+  config.ollama_url = 'http://localhost:11434'
+  config.model = 'llama2'
+end
+```
+
+## 💡 Examples
+
+### Hierarchical Team with Human Oversight
+
+```ruby
+# Create a hierarchical crew with manager coordination
+crew = RCrewAI::Crew.new("enterprise_team", process: :hierarchical)
+
+# Manager agent coordinates the team
+manager = RCrewAI::Agent.new(
+  name: "project_manager",
+  role: "Senior Project Manager", 
+  goal: "Coordinate team execution efficiently",
+  manager: true,
+  allow_delegation: true
+)
+
+# Specialist agents with human-in-the-loop capabilities
+data_analyst = RCrewAI::Agent.new(
+  name: "data_analyst",
+  role: "Senior Data Analyst",
+  goal: "Analyze data with human validation",
+  tools: [RCrewAI::Tools::SqlDatabase.new],
+  human_input: true,                      # Enable human interaction
+  require_approval_for_tools: true,       # Human approves SQL queries
+  require_approval_for_final_answer: true # Human validates analysis
+)
+
+crew.add_agent(manager)
+crew.add_agent(data_analyst)
+
+# Execute with async/hierarchical coordination
+results = crew.execute(async: true, max_concurrency: 2)
+```
+
+### Async/Concurrent Execution
+
+```ruby
+# Tasks that can run in parallel
+research_task = RCrewAI::Task.new(
+  name: "market_research",
+  description: "Research market trends",
+  async: true
+)
+
+analysis_task = RCrewAI::Task.new(
+  name: "competitive_analysis", 
+  description: "Analyze competitors",
+  async: true
+)
+
+crew.add_task(research_task)
+crew.add_task(analysis_task)
+
+# Execute with parallel processing
+results = crew.execute(
+  async: true,
+  max_concurrency: 4,
+  timeout: 300
+)
+```
+
+## 🛠️ CLI Usage
+
+```bash
+# Create a new crew
+$ rcrewai new my_research_crew --process sequential
+
+# Create agents with tools
+$ rcrewai agent new researcher \
+  --role "Senior Research Analyst" \
+  --tools web_search,file_writer \
+  --human-input
+
+# Create tasks with dependencies  
+$ rcrewai task new research \
+  --description "Research latest AI developments" \
+  --agent researcher \
+  --async
+
+# Run crews
+$ rcrewai run --crew my_research_crew --async
+```
+
+## 📚 Examples & Documentation
+
+- **[Getting Started Guide](docs/tutorials/getting-started.md)**: Learn the basics
+- **[Human-in-the-Loop Example](examples/human_in_the_loop_example.rb)**: Interactive AI workflows
+- **[Hierarchical Teams](examples/hierarchical_crew_example.rb)**: Manager coordination
+- **[Async Execution](examples/async_execution_example.rb)**: Performance optimization
+- **[API Documentation](docs/api/)**: Complete API reference
+
+## 🎯 Use Cases
+
+RCrewAI excels in scenarios requiring:
+
+- **🔍 Research & Analysis**: Multi-source research with data correlation
+- **📝 Content Creation**: Collaborative content development workflows  
+- **🏢 Business Intelligence**: Data analysis and strategic planning
+- **🛠️ Development Workflows**: Code analysis, testing, and documentation
+- **📊 Data Processing**: ETL workflows with validation
+- **🤖 Customer Support**: Intelligent routing and response generation
+- **🎯 Decision Making**: Multi-criteria analysis with human oversight
+
+## 🏗️ Architecture
+
+RCrewAI provides a flexible, production-ready architecture:
+
+```
+┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
+│   Crew Layer    │    │  Human Layer    │    │   Tool Layer    │
+│                 │    │                 │    │                 │
+│ • Orchestration │    │ • Approvals     │    │ • Web Search    │
+│ • Process Types │    │ • Guidance      │    │ • File Ops      │
+│ • Async Exec    │    │ • Reviews       │    │ • SQL Database  │
+│ • Dependencies  │    │ • Interventions │    │ • Email         │
+└─────────────────┘    └─────────────────┘    └─────────────────┘
+         │                        │                        │
+         └──────────────┬─────────────────┬─────────────────┘
+                        │                 │
+              ┌─────────────────┐    ┌─────────────────┐
+              │   Agent Layer   │    │   LLM Layer     │
+              │                 │    │                 │
+              │ • Reasoning     │    │ • OpenAI        │
+              │ • Memory        │    │ • Anthropic     │
+              │ • Tool Usage    │    │ • Google        │
+              │ • Delegation    │    │ • Azure         │
+              └─────────────────┘    └─────────────────┘
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 📄 License
+
+RCrewAI is released under the [MIT License](LICENSE).
+
+## 📞 Support
+
+- **Documentation**: [https://gkosmo.github.io/rcrewAI/](https://gkosmo.github.io/rcrewAI/)
+- **Issues**: [GitHub Issues](https://github.com/gkosmo/rcrewAI/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/gkosmo/rcrewAI/discussions)
+
+## 🌟 Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=gkosmo/rcrewAI&type=Date)](https://star-history.com/#gkosmo/rcrewAI&Date)
+
+---
+
+Made with ❤️ by the RCrewAI community

data/Rakefile

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+# Default task
+task default: [:spec, :rubocop]
+
+# RSpec task
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = "--color --format documentation"
+end
+
+# RuboCop task
+RuboCop::RakeTask.new do |task|
+  task.options = ["--display-cop-names", "--display-style-guide"]
+end
+
+# Test with coverage
+desc "Run specs with coverage report"
+task :spec_coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task[:spec].invoke
+end
+
+# Clean coverage files
+desc "Clean coverage files"
+task :clean_coverage do
+  FileUtils.rm_rf("coverage/")
+end
+
+# Build and install gem locally
+desc "Build and install gem locally"
+task :install_local do
+  sh "gem build rcrewai.gemspec"
+  sh "gem install rcrewai-*.gem"
+  FileUtils.rm(Dir.glob("rcrewai-*.gem"))
+end
+
+# Run all tests and checks
+desc "Run all tests and code quality checks"
+task :ci do
+  puts "Running RSpec tests..."
+  Rake::Task[:spec].invoke
+  
+  puts "\nRunning RuboCop..."
+  Rake::Task[:rubocop].invoke
+  
+  puts "\nAll checks passed! ✅"
+end
+
+# Console task for development
+desc "Start interactive console with gem loaded"
+task :console do
+  require "irb"
+  require_relative "lib/rcrewai"
+  IRB.start
+end
+
+# Generate documentation
+desc "Generate documentation"
+task :docs do
+  sh "yard doc lib/**/*.rb"
+  puts "Documentation generated in doc/ directory"
+end
+
+# Benchmark task
+desc "Run performance benchmarks"
+task :benchmark do
+  require_relative "lib/rcrewai"
+  
+  # Simple benchmark example
+  require "benchmark"
+  
+  RCrewAI.configure do |config|
+    config.llm_provider = :openai
+    config.api_key = "test-key"
+  end
+  
+  agent = RCrewAI::Agent.new(
+    name: "benchmark_agent",
+    role: "Test Agent",
+    goal: "Run benchmarks"
+  )
+  
+  task = RCrewAI::Task.new(
+    name: "benchmark_task",
+    description: "Test task",
+    agent: agent
+  )
+  
+  crew = RCrewAI::Crew.new("benchmark_crew")
+  crew.add_agent(agent)
+  crew.add_task(task)
+  
+  puts "\nBenchmarking crew creation and setup..."
+  result = Benchmark.measure do
+    100.times do
+      test_crew = RCrewAI::Crew.new("test_#{rand(1000)}")
+      test_agent = RCrewAI::Agent.new(
+        name: "test_agent",
+        role: "Test Agent",
+        goal: "Test performance"
+      )
+      test_crew.add_agent(test_agent)
+    end
+  end
+  
+  puts "Created 100 crews with agents in: #{result.real.round(4)}s"
+end
+
+# Development setup
+desc "Set up development environment"
+task :setup do
+  puts "Setting up development environment..."
+  
+  # Install dependencies
+  sh "bundle install"
+  
+  # Create necessary directories
+  FileUtils.mkdir_p("spec/vcr_cassettes") unless Dir.exist?("spec/vcr_cassettes")
+  FileUtils.mkdir_p("coverage") unless Dir.exist?("coverage")
+  FileUtils.mkdir_p("doc") unless Dir.exist?("doc")
+  
+  puts "\n✅ Development environment set up successfully!"
+  puts "\nRun 'rake spec' to run tests"
+  puts "Run 'rake console' to start an interactive session"
+  puts "Run 'rake ci' to run all checks"
+end

data/bin/rcrewai

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rcrewai"
+
+RCrewAI::CLI.start(ARGV)

data/docs/_config.yml

@@ -0,0 +1,59 @@
+title: RCrewAI Documentation
+description: Build AI agent crews in Ruby - Documentation and Tutorials
+baseurl: "/rcrewAI"
+url: "https://gkosmo.github.io"
+theme: jekyll-theme-minimal
+
+# Build settings
+markdown: kramdown
+highlighter: rouge
+
+# Navigation
+navigation:
+  - title: Home
+    url: /
+  - title: Getting Started
+    url: /tutorials/getting-started
+  - title: Tutorials
+    url: /tutorials/
+  - title: API Reference
+    url: /api/
+  - title: Examples
+    url: /examples/
+  - title: GitHub
+    url: https://github.com/gkosmo/rcrewAI
+
+# Plugins
+plugins:
+  - jekyll-seo-tag
+  - jekyll-sitemap
+
+# Collections
+collections:
+  tutorials:
+    output: true
+    permalink: /tutorials/:name
+  api:
+    output: true
+    permalink: /api/:name
+  examples:
+    output: true
+    permalink: /examples/:name
+
+# Defaults
+defaults:
+  - scope:
+      path: ""
+      type: "tutorials"
+    values:
+      layout: "tutorial"
+  - scope:
+      path: ""
+      type: "api"
+    values:
+      layout: "api"
+  - scope:
+      path: ""
+      type: "examples"
+    values:
+      layout: "example"

data/docs/_layouts/api.html

@@ -0,0 +1,16 @@
+---
+layout: default
+---
+
+<article class="api-documentation">
+    <header class="api-header">
+        <h1>{{ page.title }}</h1>
+        {% if page.description %}
+            <p class="lead">{{ page.description }}</p>
+        {% endif %}
+    </header>
+
+    <div class="api-content">
+        {{ content }}
+    </div>
+</article>