Merge branch 'main' into tm-basic-event-structure

src/crewai/cli/cli.py

@@ -260,10 +260,18 @@ def deploy_remove(uuid: Optional[str]):
     deploy_cmd.remove_crew(uuid=uuid)
 
 
+@tool.command(name="create")
+@click.argument("handle")
+def tool_create(handle: str):
+    tool_cmd = ToolCommand()
+    tool_cmd.create(handle)
+
+
 @tool.command(name="install")
 @click.argument("handle")
 def tool_install(handle: str):
     tool_cmd = ToolCommand()
+    tool_cmd.login()
     tool_cmd.install(handle)
 
 
@@ -272,6 +280,7 @@ def tool_install(handle: str):
 @click.option("--private", "is_public", flag_value=False)
 def tool_publish(is_public: bool):
     tool_cmd = ToolCommand()
+    tool_cmd.login()
     tool_cmd.publish(is_public)
 
 

src/crewai/cli/command.py

@@ -1,4 +1,5 @@
-from typing import Dict, Any
+import requests
+from requests.exceptions import JSONDecodeError
 from rich.console import Console
 from crewai.cli.plus_api import PlusAPI
 from crewai.cli.utils import get_auth_token
@@ -27,14 +28,44 @@ class PlusAPIMixin:
             console.print("Run 'crewai signup' to sign up/login.", style="bold green")
             raise SystemExit
 
-    def _handle_plus_api_error(self, json_response: Dict[str, Any]) -> None:
+    def _validate_response(self, response: requests.Response) -> None:
         """
         Handle and display error messages from API responses.
 
         Args:
-            json_response (Dict[str, Any]): The JSON response containing error information.
+            response (requests.Response): The response from the Plus API
         """
-        error = json_response.get("error", "Unknown error")
-        message = json_response.get("message", "No message provided")
-        console.print(f"Error: {error}", style="bold red")
-        console.print(f"Message: {message}", style="bold red")
+        try:
+            json_response = response.json()
+        except (JSONDecodeError, ValueError):
+            console.print(
+                "Failed to parse response from Enterprise API failed. Details:",
+                style="bold red",
+            )
+            console.print(f"Status Code: {response.status_code}")
+            console.print(f"Response:\n{response.content}")
+            raise SystemExit
+
+        if response.status_code == 422:
+            console.print(
+                "Failed to complete operation. Please fix the following errors:",
+                style="bold red",
+            )
+            for field, messages in json_response.items():
+                for message in messages:
+                    console.print(
+                        f"* [bold red]{field.capitalize()}[/bold red] {message}"
+                    )
+            raise SystemExit
+
+        if not response.ok:
+            console.print(
+                "Request to Enterprise API failed. Details:", style="bold red"
+            )
+            details = (
+                json_response.get("error")
+                or json_response.get("message")
+                or response.content
+            )
+            console.print(f"{details}")
+            raise SystemExit

src/crewai/cli/deploy/main.py

@@ -79,11 +79,8 @@ class DeployCommand(BaseCommand, PlusAPIMixin):
             self._standard_no_param_error_message()
             return
 
-        json_response = response.json()
-        if response.status_code == 200:
-            self._display_deployment_info(json_response)
-        else:
-            self._handle_plus_api_error(json_response)
+        self._validate_response(response)
+        self._display_deployment_info(response.json())
 
     def create_crew(self, confirm: bool = False) -> None:
         """
@@ -106,12 +103,10 @@ class DeployCommand(BaseCommand, PlusAPIMixin):
 
         self._confirm_input(env_vars, remote_repo_url, confirm)
         payload = self._create_payload(env_vars, remote_repo_url)
-
         response = self.plus_api_client.create_crew(payload)
-        if response.status_code == 201:
-            self._display_creation_success(response.json())
-        else:
-            self._handle_plus_api_error(response.json())
+
+        self._validate_response(response)
+        self._display_creation_success(response.json())
 
     def _confirm_input(
         self, env_vars: Dict[str, str], remote_repo_url: str, confirm: bool
@@ -218,11 +213,8 @@ class DeployCommand(BaseCommand, PlusAPIMixin):
             self._standard_no_param_error_message()
             return
 
-        json_response = response.json()
-        if response.status_code == 200:
-            self._display_crew_status(json_response)
-        else:
-            self._handle_plus_api_error(json_response)
+        self._validate_response(response)
+        self._display_crew_status(response.json())
 
     def _display_crew_status(self, status_data: Dict[str, str]) -> None:
         """
@@ -253,10 +245,8 @@ class DeployCommand(BaseCommand, PlusAPIMixin):
             self._standard_no_param_error_message()
             return
 
-        if response.status_code == 200:
-            self._display_logs(response.json())
-        else:
-            self._handle_plus_api_error(response.json())
+        self._validate_response(response)
+        self._display_logs(response.json())
 
     def remove_crew(self, uuid: Optional[str]) -> None:
         """

src/crewai/cli/plus_api.py

@@ -27,6 +27,9 @@ class PlusAPI:
         url = urljoin(self.base_url, endpoint)
         return requests.request(method, url, headers=self.headers, **kwargs)
 
+    def login_to_tool_repository(self):
+        return self._make_request("POST", f"{self.TOOLS_RESOURCE}/login")
+
     def get_tool(self, handle: str):
         return self._make_request("GET", f"{self.TOOLS_RESOURCE}/{handle}")
 

src/crewai/cli/templates/crew/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Your Name <you@example.com>"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<=3.13"
-crewai = { extras = ["tools"], version = ">=0.66.0,<1.0.0" }
+crewai = { extras = ["tools"], version = ">=0.67.1,<1.0.0" }
 
 
 [tool.poetry.scripts]

src/crewai/cli/templates/flow/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Your Name <you@example.com>"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<=3.13"
-crewai = { extras = ["tools"], version = ">=0.66.0,<1.0.0" }
+crewai = { extras = ["tools"], version = ">=0.67.1,<1.0.0" }
 asyncio = "*"
 
 [tool.poetry.scripts]

src/crewai/cli/templates/pipeline/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Your Name <you@example.com>"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<=3.13"
-crewai = { extras = ["tools"], version = ">=0.66.0,<1.0.0" }
+crewai = { extras = ["tools"], version = ">=0.67.1,<1.0.0" }
 asyncio = "*"
 
 [tool.poetry.scripts]

src/crewai/cli/templates/pipeline_router/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Your Name <you@example.com>"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<=3.13"
-crewai = { extras = ["tools"], version = ">=0.66.0,<1.0.0" }
+crewai = { extras = ["tools"], version = ">=0.67.1,<1.0.0" }
 
 
 [tool.poetry.scripts]

src/crewai/cli/templates/tool/README.md

@@ -0,0 +1,48 @@
+# {{folder_name}}
+
+{{folder_name}} is a CrewAI Tool. This template is designed to help you create
+custom tools to power up your crews.
+
+## Installing
+
+Ensure you have Python >=3.10 <=3.13 installed on your system. This project
+uses [Poetry](https://python-poetry.org/) for dependency management and package
+handling, offering a seamless setup and execution experience.
+
+First, if you haven't already, install Poetry:
+
+```bash
+pip install poetry
+```
+
+Next, navigate to your project directory and install the dependencies with:
+
+```bash
+crewai install
+```
+
+## Publishing
+
+Collaborate by sharing tools within your organization, or publish them publicly
+to contribute with the community.
+
+```bash
+crewai tool publish {{tool_name}}
+```
+
+Others may install your tool in their crews running:
+
+```bash
+crewai tool install {{tool_name}}
+```
+
+## Support
+
+For support, questions, or feedback regarding the {{crew_name}} tool or CrewAI.
+
+- Visit our [documentation](https://docs.crewai.com)
+- Reach out to us through our [GitHub repository](https://github.com/joaomdmoura/crewai)
+- [Join our Discord](https://discord.com/invite/X4JWnZnxPb)
+- [Chat with our docs](https://chatg.pt/DWjSBZn)
+
+Let's create wonders together with the power and simplicity of crewAI.

src/crewai/cli/templates/tool/pyproject.toml

@@ -0,0 +1,14 @@
+[tool.poetry]
+name = "{{folder_name}}"
+version = "0.1.0"
+description = "Power up your crews with {{folder_name}}"
+authors = ["Your Name <you@example.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = ">=3.10,<=3.13"
+crewai = { extras = ["tools"], version = ">=0.64.0,<1.0.0" }
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

src/crewai/cli/templates/tool/src/{{folder_name}}/tool.py

@@ -0,0 +1,9 @@
+from crewai_tools import BaseTool
+
+class {{class_name}}(BaseTool):
+    name: str = "Name of my tool"
+    description: str = "What this tool does. It's vital for effective utilization."
+
+    def _run(self, argument: str) -> str:
+        # Your tool's logic here
+        return "Tool's result"

src/crewai/cli/tools/main.py

@@ -1,4 +1,5 @@
 import base64
+from pathlib import Path
 import click
 import os
 import subprocess
@@ -9,6 +10,8 @@ from crewai.cli.utils import (
     get_project_name,
     get_project_description,
     get_project_version,
+    tree_copy,
+    tree_find_and_replace,
 )
 from rich.console import Console
 
@@ -24,6 +27,37 @@ class ToolCommand(BaseCommand, PlusAPIMixin):
         BaseCommand.__init__(self)
         PlusAPIMixin.__init__(self, telemetry=self._telemetry)
 
+    def create(self, handle: str):
+        self._ensure_not_in_project()
+
+        folder_name = handle.replace(" ", "_").replace("-", "_").lower()
+        class_name = handle.replace("_", " ").replace("-", " ").title().replace(" ", "")
+
+        project_root = Path(folder_name)
+        if project_root.exists():
+            click.secho(f"Folder {folder_name} already exists.", fg="red")
+            raise SystemExit
+        else:
+            os.makedirs(project_root)
+
+        click.secho(f"Creating custom tool {folder_name}...", fg="green", bold=True)
+
+        template_dir = Path(__file__).parent.parent / "templates" / "tool"
+        tree_copy(template_dir, project_root)
+        tree_find_and_replace(project_root, "{{folder_name}}", folder_name)
+        tree_find_and_replace(project_root, "{{class_name}}", class_name)
+
+        old_directory = os.getcwd()
+        os.chdir(project_root)
+        try:
+            self.login()
+            subprocess.run(["git", "init"], check=True)
+            console.print(
+                f"[green]Created custom tool [bold]{folder_name}[/bold]. Run [bold]cd {project_root}[/bold] to start working.[/green]"
+            )
+        finally:
+            os.chdir(old_directory)
+
     def publish(self, is_public: bool):
         project_name = get_project_name(require=True)
         assert isinstance(project_name, str)
@@ -64,23 +98,8 @@ class ToolCommand(BaseCommand, PlusAPIMixin):
             description=project_description,
             encoded_file=f"data:application/x-gzip;base64,{encoded_tarball}",
         )
-        if publish_response.status_code == 422:
-            console.print(
-                "[bold red]Failed to publish tool. Please fix the following errors:[/bold red]"
-            )
-            for field, messages in publish_response.json().items():
-                for message in messages:
-                    console.print(
-                        f"* [bold red]{field.capitalize()}[/bold red] {message}"
-                    )
 
-            raise SystemExit
-        elif publish_response.status_code != 200:
-            self._handle_plus_api_error(publish_response.json())
-            console.print(
-                "Failed to publish tool. Please try again later.", style="bold red"
-            )
-            raise SystemExit
+        self._validate_response(publish_response)
 
         published_handle = publish_response.json()["handle"]
         console.print(
@@ -103,15 +122,32 @@ class ToolCommand(BaseCommand, PlusAPIMixin):
             )
             raise SystemExit
 
-        self._add_repository_to_poetry(get_response.json())
         self._add_package(get_response.json())
 
         console.print(f"Succesfully installed {handle}", style="bold green")
 
-    def _add_repository_to_poetry(self, tool_details):
-        repository_handle = f"crewai-{tool_details['repository']['handle']}"
-        repository_url = tool_details["repository"]["url"]
-        repository_credentials = tool_details["repository"]["credentials"]
+    def login(self):
+        login_response = self.plus_api_client.login_to_tool_repository()
+
+        if login_response.status_code != 200:
+            console.print(
+                "Failed to authenticate to the tool repository. Make sure you have the access to tools.",
+                style="bold red",
+            )
+            raise SystemExit
+
+        login_response_json = login_response.json()
+        for repository in login_response_json["repositories"]:
+            self._add_repository_to_poetry(
+                repository, login_response_json["credential"]
+            )
+
+        console.print(
+            "Succesfully authenticated to the tool repository.", style="bold green"
+        )
+
+    def _add_repository_to_poetry(self, repository, credentials):
+        repository_handle = f"crewai-{repository['handle']}"
 
         add_repository_command = [
             "poetry",
@@ -119,7 +155,7 @@ class ToolCommand(BaseCommand, PlusAPIMixin):
             "add",
             "--priority=explicit",
             repository_handle,
-            repository_url,
+            repository["url"],
         ]
         add_repository_result = subprocess.run(
             add_repository_command, text=True, check=True
@@ -133,8 +169,8 @@ class ToolCommand(BaseCommand, PlusAPIMixin):
             "poetry",
             "config",
             f"http-basic.{repository_handle}",
-            repository_credentials,
-            '""',
+            credentials["username"],
+            credentials["password"],
         ]
         add_repository_credentials_result = subprocess.run(
             add_repository_credentials_command,
@@ -166,3 +202,16 @@ class ToolCommand(BaseCommand, PlusAPIMixin):
         if add_package_result.stderr:
             click.echo(add_package_result.stderr, err=True)
             raise SystemExit
+
+    def _ensure_not_in_project(self):
+        if os.path.isfile("./pyproject.toml"):
+            console.print(
+                "[bold red]Oops! It looks like you're inside a project.[/bold red]"
+            )
+            console.print(
+                "You can't create a new tool while inside an existing project."
+            )
+            console.print(
+                "[bold yellow]Tip:[/bold yellow] Navigate to a different directory and try again."
+            )
+            raise SystemExit

src/crewai/cli/utils.py

@@ -1,7 +1,10 @@
+import os
+import shutil
 import click
 import re
 import subprocess
 import sys
+import importlib.metadata
 
 from crewai.cli.authentication.utils import TokenManager
 from functools import reduce
@@ -162,29 +165,9 @@ def _get_nested_value(data: Dict[str, Any], keys: List[str]) -> Any:
     return reduce(dict.__getitem__, keys, data)
 
 
-def get_crewai_version(poetry_lock_path: str = "poetry.lock") -> str:
-    """Get the version number of crewai from the poetry.lock file."""
-    try:
-        with open(poetry_lock_path, "r") as f:
-            lock_content = f.read()
-
-        match = re.search(
-            r'\[\[package\]\]\s*name\s*=\s*"crewai"\s*version\s*=\s*"([^"]+)"',
-            lock_content,
-            re.DOTALL,
-        )
-        if match:
-            return match.group(1)
-        else:
-            print("crewai package not found in poetry.lock")
-            return "no-version-found"
-
-    except FileNotFoundError:
-        print(f"Error: {poetry_lock_path} not found.")
-    except Exception as e:
-        print(f"Error reading the poetry.lock file: {e}")
-
-    return "no-version-found"
+def get_crewai_version() -> str:
+    """Get the version number of CrewAI running the CLI"""
+    return importlib.metadata.version("crewai")
 
 
 def fetch_and_json_env_file(env_file_path: str = ".env") -> dict:
@@ -217,3 +200,40 @@ def get_auth_token() -> str:
     if not access_token:
         raise Exception()
     return access_token
+
+
+def tree_copy(source, destination):
+    """Copies the entire directory structure from the source to the destination."""
+    for item in os.listdir(source):
+        source_item = os.path.join(source, item)
+        destination_item = os.path.join(destination, item)
+        if os.path.isdir(source_item):
+            shutil.copytree(source_item, destination_item)
+        else:
+            shutil.copy2(source_item, destination_item)
+
+
+def tree_find_and_replace(directory, find, replace):
+    """Recursively searches through a directory, replacing a target string in
+    both file contents and filenames with a specified replacement string.
+    """
+    for path, dirs, files in os.walk(os.path.abspath(directory), topdown=False):
+        for filename in files:
+            filepath = os.path.join(path, filename)
+
+            with open(filepath, "r") as file:
+                contents = file.read()
+            with open(filepath, "w") as file:
+                file.write(contents.replace(find, replace))
+
+            if find in filename:
+                new_filename = filename.replace(find, replace)
+                new_filepath = os.path.join(path, new_filename)
+                os.rename(filepath, new_filepath)
+
+        for dirname in dirs:
+            if find in dirname:
+                new_dirname = dirname.replace(find, replace)
+                new_dirpath = os.path.join(path, new_dirname)
+                old_dirpath = os.path.join(path, dirname)
+                os.rename(old_dirpath, new_dirpath)

src/crewai/utilities/converter.py

@@ -103,10 +103,12 @@ def convert_to_model(
         return handle_partial_json(
             result, model, bool(output_json), agent, converter_cls
         )
+
     except ValidationError:
         return handle_partial_json(
             result, model, bool(output_json), agent, converter_cls
         )
+
     except Exception as e:
         Printer().print(
             content=f"Unexpected error during model conversion: {type(e).__name__}: {e}. Returning original result.",

src/crewai/utilities/pydantic_schema_parser.py

@@ -1,4 +1,4 @@
-from typing import Type, get_args, get_origin
+from typing import Type, get_args, get_origin, Union
 
 from pydantic import BaseModel
 
@@ -36,7 +36,14 @@ class PydanticSchemaParser(BaseModel):
                 return f"List[\n{nested_schema}\n{' ' * 4 * depth}]"
             else:
                 return f"List[{list_item_type.__name__}]"
-        elif issubclass(field_type, BaseModel):
+        elif get_origin(field_type) is Union:
+            union_args = get_args(field_type)
+            if type(None) in union_args:
+                non_none_type = next(arg for arg in union_args if arg is not type(None))
+                return f"Optional[{self._get_field_type(field.__class__(annotation=non_none_type), depth)}]"
+            else:
+                return f"Union[{', '.join(arg.__name__ for arg in union_args)}]"
+        elif isinstance(field_type, type) and issubclass(field_type, BaseModel):
             return self._get_model_schema(field_type, depth)
         else:
-            return field_type.__name__
+            return getattr(field_type, "__name__", str(field_type))