Initial commit for Hugging Face Spaces deployment

.gitignore

@@ -6,9 +6,10 @@ __pycache__/
 *$py.class
 *.so
 .Python
+env/
 build/
 develop-eggs/
-.dist
+dist/
 downloads/
 eggs/
 .eggs/
@@ -24,19 +25,25 @@ wheels/
 
 # Virtual Environment
 venv/
-env/
 ENV/
-.env
-
-# Runtime Temporary files
-tmp/
 
 # IDE
 .idea/
 .vscode/
 *.swp
 *.swo
+
+# Logs
+*.log
+logs/
+
+# Environment variables
+.env
+.env.*
+
+# OS
 .DS_Store
+Thumbs.db
 
 # Project specific
 owl/data
@@ -44,11 +51,6 @@ owl/tmp
 owl/.env
 owl/utils/__pycache__/
 
-# Logs
-*.log
-logs/
-log/
-
 # Coverage reports
 htmlcov/
 .tox/

README.md

@@ -1,3 +1,57 @@
+# 🦉 OWL Multi-Agent Collaboration System
+
+OWL is an advanced multi-agent collaboration system developed based on the CAMEL framework, designed to solve complex problems through agent collaboration.
+
+## Features
+
+- Multi-agent collaboration system
+- Web-based interface
+- Support for various AI models (OpenAI, Qwen, DeepSeek, etc.)
+- Environment variable management
+- Real-time conversation logging
+- Interactive UI with Gradio
+
+## Setup
+
+1. Clone the repository
+2. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+3. Copy the environment template:
+   ```bash
+   cp owl/.env_template owl/.env
+   ```
+4. Configure your API keys in the `.env` file
+5. Run the application:
+   ```bash
+   python app.py
+   ```
+
+## Environment Variables
+
+The following environment variables are required:
+
+- `OPENAI_API_KEY`: Your OpenAI API key
+- `GOOGLE_API_KEY`: Your Google API key
+- `SEARCH_ENGINE_ID`: Your Google Search Engine ID
+- `CHUNKR_API_KEY`: Your Chunkr API key
+- `FIRECRAWL_API_KEY`: Your Firecrawl API key
+
+Optional variables for alternative models:
+- `QWEN_API_KEY`: For Qwen model
+- `DEEPSEEK_API_KEY`: For DeepSeek model
+- `GROQ_API_KEY`: For GROQ model
+- Azure OpenAI API keys
+
+## License
+
+Based on Apache License 2.0 open source license
+
+## Credits
+
+© 2025 CAMEL-AI.org
+
 <h1 align="center">
 	🦉 OWL: Optimized Workforce Learning for General Multi-Agent Assistance in Real-World Task Automation
 </h1>

app.py

@@ -0,0 +1,4 @@
+from owl.webapp import main
+
+if __name__ == "__main__":
+    main() 

owl/webapp.py

@@ -1294,7 +1294,7 @@ def main():
         app = create_ui()
 
         app.queue()
-        app.launch(share=False, favicon_path="../assets/owl-favicon.ico")
+        app.launch(share=True, server_name="0.0.0.0", server_port=7861, favicon_path="../assets/owl-favicon.ico")
     except Exception as e:
         logging.error(f"Error occurred while starting the application: {str(e)}")
         print(f"Error occurred while starting the application: {str(e)}")

requirements.txt

@@ -1,4 +1,15 @@
-camel-ai[all]==0.2.36
-chunkr-ai>=0.0.41
-docx2markdown>=0.1.1
 gradio>=3.50.2
+docx2markdown>=0.1.1
+chunkr-ai>=0.0.41
+camel-ai[all]==0.2.36
+python-dotenv>=1.0.0
+openai>=1.59.7
+httpx>=0.28.0
+pydantic>=1.9
+numpy>=1.26.0
+tiktoken>=0.7.0
+pyyaml>=6.0.2
+colorama>=0.4.6
+psutil>=5.9.8
+docstring-parser>=0.15
+jsonschema>=4.0.0

setup.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+# Script to automate running OWL locally on a Mac
+
+# Check if Python 3 is installed and check version compatibility
+echo "Checking Python version..."
+PYTHON_VERSION=$(python3 --version 2>&1)
+if [[ "$PYTHON_VERSION" =~ "Python 3" ]]; then
+    echo "Python found: $PYTHON_VERSION"
+    # Extract version numbers
+    VERSION_NUM=$(echo $PYTHON_VERSION | cut -d' ' -f2)
+    MAJOR=$(echo $VERSION_NUM | cut -d. -f1)
+    MINOR=$(echo $VERSION_NUM | cut -d. -f2)
+    
+    if [ "$MAJOR" -eq 3 ] && [ "$MINOR" -ge 10 ] && [ "$MINOR" -lt 13 ]; then
+        echo "Python version is compatible!"
+    else
+        echo "Error: OWL requires Python version >=3.10 and <3.13"
+        echo "Your version ($VERSION_NUM) is not compatible."
+        echo ""
+        echo "Please install Python 3.10 using one of these methods:"
+        echo "1. Download from python.org/downloads/"
+        echo "2. Using Homebrew:"
+        echo "   a. Install Homebrew first (if not installed):"
+        echo "      /bin/bash -c \"\$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\""
+        echo "   b. Then install Python 3.10:"
+        echo "      brew install [email protected]"
+        echo ""
+        echo "After installing, run this script again using the correct Python version:"
+        echo "python3.10 setup.sh"
+        exit 1
+    fi
+else
+    echo "Python 3 not found! Please install it from python.org/downloads/ and rerun this script."
+    exit 1
+fi
+
+# Create and activate virtual environment
+echo "Setting up Python virtual environment..."
+python3 -m venv venv
+source venv/bin/activate || { echo "Failed to activate virtual environment!"; exit 1; }
+
+# Install dependencies
+echo "Installing dependencies from requirements.txt..."
+if [ -f "requirements.txt" ]; then
+    pip3 install -r requirements.txt || { echo "Failed to install dependencies!"; exit 1; }
+else
+    echo "No requirements.txt found! Cannot continue."
+    exit 1
+fi
+
+# Run OWL
+echo "Attempting to run OWL..."
+if [ -f "owl/webapp.py" ]; then
+    python3 owl/webapp.py
+else
+    echo "Could not find owl/webapp.py! Please check the repository structure."
+    exit 1
+fi
+
+echo "If you see errors, copy them and ask for help!"