diff --git a/agentstack/__init__.py b/agentstack/__init__.py index 531f904a..269cf4ca 100644 --- a/agentstack/__init__.py +++ b/agentstack/__init__.py @@ -9,8 +9,8 @@ from pathlib import Path from agentstack import conf from agentstack.utils import get_framework -from agentstack.agents import get_agent -from agentstack.tasks import get_task +from agentstack.agents import get_agent, get_all_agents, get_all_agent_names +from agentstack.tasks import get_task, get_all_tasks, get_all_task_names from agentstack.inputs import get_inputs from agentstack import frameworks @@ -22,7 +22,11 @@ "get_tags", "get_framework", "get_agent", + "get_all_agents", + "get_all_agent_names", "get_task", + "get_all_tasks", + "get_all_task_names", "get_inputs", ] diff --git a/agentstack/frameworks/__init__.py b/agentstack/frameworks/__init__.py index 85ae3f67..79dceefc 100644 --- a/agentstack/frameworks/__init__.py +++ b/agentstack/frameworks/__init__.py @@ -16,9 +16,11 @@ CREWAI = 'crewai' LANGGRAPH = 'langgraph' +OPENAI_SWARM = 'openai_swarm' SUPPORTED_FRAMEWORKS = [ CREWAI, LANGGRAPH, + OPENAI_SWARM, ] @@ -58,9 +60,9 @@ def remove_tool(self, tool: ToolConfig, agent_name: str) -> None: """ ... - def get_tool_callables(self, tool_name: str) -> list[Callable]: + def wrap_tool(self, tool_func: Callable) -> Callable: """ - Get a tool by name and return it as a list of framework-native callables. + Wrap a tool function with framework-specific functionality. """ ... @@ -173,7 +175,43 @@ def get_tool_callables(tool_name: str) -> list[Callable]: """ Get a tool by name and return it as a list of framework-native callables. """ - return get_framework_module(get_framework()).get_tool_callables(tool_name) + # TODO: remove after agentops fixes their issue + # wrap method with agentops tool event + def wrap_method(method: Callable) -> Callable: + from inspect import signature + + original_signature = signature(method) + def wrapped_method(*args, **kwargs): + import agentops + tool_event = agentops.ToolEvent(method.__name__) + result = method(*args, **kwargs) + agentops.record(tool_event) + return result + + # Preserve all original attributes + wrapped_method.__name__ = method.__name__ + wrapped_method.__doc__ = method.__doc__ + wrapped_method.__module__ = method.__module__ + wrapped_method.__qualname__ = method.__qualname__ + wrapped_method.__annotations__ = getattr(method, '__annotations__', {}) + wrapped_method.__signature__ = original_signature # type: ignore + return wrapped_method + + tool_funcs = [] + tool_config = ToolConfig.from_tool_name(tool_name) + for tool_func_name in tool_config.tools: + tool_func = getattr(tool_config.module, tool_func_name) + + assert callable(tool_func), f"Tool function {tool_func_name} is not callable." + assert tool_func.__doc__, f"Tool function {tool_func_name} is missing a docstring." + + # First wrap with agentops + agentops_wrapped = wrap_method(tool_func) + # Then apply framework decorators + framework_wrapped = get_framework_module(get_framework()).wrap_tool(agentops_wrapped) + tool_funcs.append(framework_wrapped) + + return tool_funcs def get_agent_method_names() -> list[str]: diff --git a/agentstack/frameworks/crewai.py b/agentstack/frameworks/crewai.py index 1b437d9b..14e5a7c5 100644 --- a/agentstack/frameworks/crewai.py +++ b/agentstack/frameworks/crewai.py @@ -8,6 +8,7 @@ from agentstack.agents import AgentConfig from agentstack.generation import asttools from agentstack import graph + if TYPE_CHECKING: from agentstack.generation import InsertionPoint @@ -19,6 +20,7 @@ class CrewFile(asttools.File): Parses and manipulates the CrewAI entrypoint file. All AST interactions should happen within the methods of this class. """ + def write(self): """ Early versions of the crew entrypoint file used tabs instead of spaces. @@ -65,7 +67,7 @@ def {task.name}(self) -> Task: return Task( config=self.tasks_config['{task.name}'], )""" - + if not self.source[:pos].endswith('\n'): code = '\n\n' + code if not self.source[pos:].startswith('\n'): @@ -95,7 +97,7 @@ def {agent.name}(self) -> Agent: tools=[], # add tools here or use `agentstack tools add verbose=True, )""" - + if not self.source[:pos].endswith('\n'): code = '\n\n' + code if not self.source[pos:].startswith('\n'): @@ -280,7 +282,7 @@ def add_agent(agent: AgentConfig, position: Optional['InsertionPoint'] = None) - """ if position is not None: raise NotImplementedError("Agent insertion points are not supported in CrewAI.") - + with CrewFile(conf.PATH / ENTRYPOINT) as crew_file: crew_file.add_agent_method(agent) @@ -302,52 +304,19 @@ def remove_tool(tool: ToolConfig, agent_name: str): crew_file.remove_agent_tools(agent_name, tool) -def get_tool_callables(tool_name: str) -> list[Callable]: +def wrap_tool(tool_func: Callable) -> Callable: """ - Get a tool implementations for use directly by a CrewAI agent. + Wrap a tool function with framework-specific functionality. """ try: from crewai.tools import tool as _crewai_tool_decorator except ImportError: raise ValidationError("Could not import `crewai`. Is this an AgentStack CrewAI project?") - # TODO: remove after agentops fixes their issue - # wrap method with agentops tool event - def wrap_method(method: Callable) -> Callable: - def wrapped_method(*args, **kwargs): - import agentops - tool_event = agentops.ToolEvent(method.__name__) - result = method(*args, **kwargs) - agentops.record(tool_event) - return result - - # Preserve all original attributes - wrapped_method.__name__ = method.__name__ - wrapped_method.__doc__ = method.__doc__ - wrapped_method.__module__ = method.__module__ - wrapped_method.__qualname__ = method.__qualname__ - wrapped_method.__annotations__ = getattr(method, '__annotations__', {}) - return wrapped_method - - tool_funcs = [] - tool_config = ToolConfig.from_tool_name(tool_name) - for tool_func_name in tool_config.tools: - tool_func = getattr(tool_config.module, tool_func_name) - - assert callable(tool_func), f"Tool function {tool_func_name} is not callable." - assert tool_func.__doc__, f"Tool function {tool_func_name} is missing a docstring." - - # First wrap with agentops - agentops_wrapped = wrap_method(tool_func) - # Then apply CrewAI decorator last so it properly inherits from BaseTool - crewai_wrapped = _crewai_tool_decorator(agentops_wrapped) - tool_funcs.append(crewai_wrapped) - - return tool_funcs + return _crewai_tool_decorator(tool_func) def get_graph() -> list[graph.Edge]: """Get the graph of the user's project.""" log.debug("CrewAI does not support graph generation.") return [] - diff --git a/agentstack/frameworks/langgraph.py b/agentstack/frameworks/langgraph.py index d3e6a38e..224ea62d 100644 --- a/agentstack/frameworks/langgraph.py +++ b/agentstack/frameworks/langgraph.py @@ -18,7 +18,11 @@ GRAPH_NODE_END = 'END' GRAPH_NODE_TOOLS = 'tools' # references the `ToolNode` instance GRAPH_NODE_TOOLS_CONDITION = 'tools_condition' -GRAPH_NODES_SPECIAL = (GRAPH_NODE_START, GRAPH_NODE_END, GRAPH_NODE_TOOLS_CONDITION, ) +GRAPH_NODES_SPECIAL = ( + GRAPH_NODE_START, + GRAPH_NODE_END, + GRAPH_NODE_TOOLS_CONDITION, +) @dataclass @@ -347,7 +351,7 @@ def _get_node_name(node: ast.expr) -> str: for node in nodes: source, target = node.args source_name = _get_node_name(source) - #target_name = _get_node_name(target) + # target_name = _get_node_name(target) if source_name == GRAPH_NODE_TOOLS: # TODO this is a bit brittle nodes.remove(node) # if target_name == GRAPH_NODE_TOOLS: @@ -430,7 +434,7 @@ def add_conditional_edge(self, edge: graph.Edge): else: graph_instance = asttools.find_method_calls(self.get_run_method(), 'StateGraph')[0] _, end = self.get_node_range(graph_instance) - + source, target = edge.source.name, edge.target.name # wrap the node names in quotes if they are not special nodes if edge.source.type != graph.NodeType.SPECIAL: @@ -745,36 +749,12 @@ def remove_tool(tool: ToolConfig, agent_name: str): entrypoint.remove_agent_tools(agent_name, tool) -def get_tool_callables(tool_name: str) -> list[Callable]: +def wrap_tool(tool_func: Callable) -> Callable: """ - Get a tool by name and return it as a list of framework-native callables. + Wrap a tool function with framework-specific functionality. """ - # LangGraph accepts functions as tools, so we can return them directly - tool_funcs = [] - tool_config = ToolConfig.from_tool_name(tool_name) - - # TODO: remove after agentops supports langgraph - # wrap method with agentops tool event - def wrap_method(method: Callable) -> Callable: - @wraps(method) # This preserves the original function's metadata - def wrapped_method(*args, **kwargs): - import agentops - tool_event = agentops.ToolEvent(method.__name__) - result = method(*args, **kwargs) - agentops.record(tool_event) - return result - - return wrapped_method - - for tool_func_name in tool_config.tools: - tool_func = getattr(tool_config.module, tool_func_name) - - assert callable(tool_func), f"Tool function {tool_func_name} is not callable." - assert tool_func.__doc__, f"Tool function {tool_func_name} is missing a docstring." - - tool_funcs.append(wrap_method(tool_func)) - - return tool_funcs + # LangGraph accepts bare functions as tools, so we don't need to do anything here. + return tool_func def get_graph() -> list[graph.Edge]: diff --git a/agentstack/frameworks/new_framework.py.tpl b/agentstack/frameworks/new_framework.py.tpl new file mode 100644 index 00000000..ddf78376 --- /dev/null +++ b/agentstack/frameworks/new_framework.py.tpl @@ -0,0 +1,173 @@ +from typing import TYPE_CHECKING, Optional, Any, Callable +from pathlib import Path +import ast +from agentstack import conf, log +from agentstack.exceptions import ValidationError +from agentstack._tools import ToolConfig +from agentstack.tasks import TaskConfig +from agentstack.agents import AgentConfig +from agentstack.generation import asttools +from agentstack import graph +if TYPE_CHECKING: + from agentstack.generation import InsertionPoint + +NAME: str = "Framework" +ENTRYPOINT: Path = Path('src/.py') + + +class FrameworkFile(asttools.File): + """ + Parses and manipulates the entrypoint file. + All AST interactions should happen within the methods of this class. + """ + + def get_task_methods(self) -> list[ast.FunctionDef]: + """A `task` method is a method decorated with `@task`.""" + pass + + def add_task_method(self, task: TaskConfig) -> None: + """Add a new task method to the entrypoint.""" + pass + + def get_agent_methods(self) -> list[ast.FunctionDef]: + """An `agent` method is a method decorated with `@agent`.""" + pass + + def add_agent_method(self, agent: AgentConfig) -> None: + """Add a new agent method to the entrypoint.""" + pass + + def get_agent_tools(self, agent_name: str) -> ast.List: + """Get the tools used by an agent as AST nodes.""" + pass + + def get_agent_tool_names(self, agent_name: str) -> list[str]: + """Get a list of all tools used by the agent.""" + pass + + def add_agent_tools(self, agent_name: str, tool: ToolConfig) -> None: + """Add new tools to be used by an agent.""" + pass + + def remove_agent_tools(self, agent_name: str, tool: ToolConfig) -> None: + """Remove tools from an agent belonging to `tool`.""" + pass + + +def validate_project() -> None: + """ + Validate that the project is ready to run. + Raises an `agentstack.ValidationError` if the project is not valid. + """ + try: + entrypoint = FrameworkFile(conf.PATH / ENTRYPOINT) + except ValidationError as e: + raise e + + # Add additional validation checks here + # ie. check for a base class, check for a `main` method, etc. + + # The class must have one or more methods decorated with `@task` + if len(entrypoint.get_task_methods()) < 1: + raise ValidationError( + f"`@task` decorated method not found in `{class_node.name}` class in {ENTRYPOINT}.\n" + "Create a new task using `agentstack generate task `." + ) + + # The class must have one or more methods decorated with `@agent` + if len(entrypoint.get_agent_methods()) < 1: + raise ValidationError( + f"`@agent` decorated method not found in `{class_node.name}` class in {ENTRYPOINT}.\n" + "Create a new agent using `agentstack generate agent `." + ) + + +def parse_llm(llm: str) -> tuple[str, str]: + """ + Parse the llm string into a tuple of `provider` and `model`. + """ + provider, model = llm.split('/') + return provider, model + + +def get_task_method_names() -> list[str]: + """ + Get a list of task names (methods with an @task decorator). + """ + entrypoint = FrameworkFile(conf.PATH / ENTRYPOINT) + return [method.name for method in entrypoint.get_task_methods()] + + +def add_task(task: TaskConfig, position: Optional['InsertionPoint'] = None) -> None: + """ + Add a task method to the entrypoint. + """ + if position is not None: + raise NotImplementedError(f"Task insertion points are not supported in {NAME}.") + + with FrameworkFile(conf.PATH / ENTRYPOINT) as entrypoint: + entrypoint.add_task_method(task) + + +def get_agent_method_names() -> list[str]: + """ + Get a list of agent names (methods with an @agent decorator). + """ + entrypoint = FrameworkFile(conf.PATH / ENTRYPOINT) + return [method.name for method in entrypoint.get_agent_methods()] + + +def get_agent_tool_names(agent_name: str) -> list[Any]: + """ + Get a list of tools used by an agent. + """ + with FrameworkFile(conf.PATH / ENTRYPOINT) as entrypoint: + return entrypoint.get_agent_tool_names(agent_name) + + +def add_agent(agent: AgentConfig, position: Optional['InsertionPoint'] = None) -> None: + """ + Add an agent method to the entrypoint. + """ + if position is not None: + raise NotImplementedError(f"Agent insertion points are not supported in {NAME}.") + + with FrameworkFile(conf.PATH / ENTRYPOINT) as entrypoint: + entrypoint.add_agent_method(agent) + + +def add_tool(tool: ToolConfig, agent_name: str): + """ + Add a tool to the entrypoint for the specified agent. + """ + with FrameworkFile(conf.PATH / ENTRYPOINT) as entrypoint: + entrypoint.add_agent_tools(agent_name, tool) + + +def remove_tool(tool: ToolConfig, agent_name: str): + """ + Remove a tool from the entrypoint for the specified agent. + """ + with FrameworkFile(conf.PATH / ENTRYPOINT) as entrypoint: + entrypoint.remove_agent_tools(agent_name, tool) + + +def wrap_tool(tool_func: Callable) -> Callable: + """ + Wrap a tool function with framework-specific functionality. + """ + try: + # import happens at runtime to avoid including the framework as a base dependency. + #from crewai.tools import tool as _framework_tool_decorator + _framework_tool_decorator = lambda x: x + except ImportError: + raise ValidationError(f"Could not import framework. Is this an AgentStack {NAME} project?") + + return _framework_tool_decorator(tool_func) + + +def get_graph() -> list[graph.Edge]: + """Get the graph of the user's project.""" + log.debug(f"{NAME} does not support graph generation.") + return [] + diff --git a/agentstack/frameworks/openai_swarm.py b/agentstack/frameworks/openai_swarm.py new file mode 100644 index 00000000..c4c6e5ad --- /dev/null +++ b/agentstack/frameworks/openai_swarm.py @@ -0,0 +1,309 @@ +from typing import Optional, Any, Callable +from pathlib import Path +import ast +from agentstack import conf, log +from agentstack.exceptions import ValidationError +from agentstack.generation import InsertionPoint +from agentstack._tools import ToolConfig +from agentstack.tasks import TaskConfig +from agentstack.agents import AgentConfig +from agentstack.generation import asttools +from agentstack import graph + + +NAME: str = "OpenAI Swarm" +ENTRYPOINT: Path = Path('src/stack.py') + + +class SwarmFile(asttools.File): + """ + Parses and manipulates the entrypoint file. + All AST interactions should happen within the methods of this class. + """ + + def get_base_class(self) -> ast.ClassDef: + """ + A base class is the first class inside of the file that follows the + naming convention: `Stack` + """ + try: + return asttools.find_class_with_regex(self.tree, r'\w+Stack$')[0] + except IndexError: + raise ValidationError(f"`Stack` class not found in {ENTRYPOINT}") + + def get_run_method(self) -> ast.FunctionDef: + """A method named `run`.""" + try: + base_class = self.get_base_class() + node = asttools.find_method_in_class(base_class, 'run')[0] + assert 'inputs' in (arg.arg for arg in node.args.args) + return node + except IndexError: + raise ValidationError(f"`run` method not found in `{base_class.name} class in {ENTRYPOINT}.") + except AssertionError: + raise ValidationError( + f"Method `run` of `{base_class.name}` must accept `inputs` as a keyword argument." + ) + + def get_task_methods(self) -> list[ast.FunctionDef]: + """A `task` method is a method decorated with `@task`.""" + return asttools.find_decorated_method_in_class(self.get_base_class(), 'task') + + def add_task_method(self, task: TaskConfig): + """Add a new task method to the entrypoint.""" + task_methods = self.get_task_methods() + if task_methods: + # Add after the existing task methods + _, pos = self.get_node_range(task_methods[-1]) + else: + # Add before the `main` method + main_method = self.get_run_method() + pos, _ = self.get_node_range(main_method) + + code = f""" @agentstack.task + def {task.name}(self, messages: list[str] = []) -> Agent: + task_config = agentstack.get_task('{task.name}') + agent = getattr(self, task_config.agent) + messages = [ + *messages, + task_config.prompt, + ] + return agent(messages)""" + + if not self.source[:pos].endswith('\n'): + code = '\n\n' + code + if not self.source[pos:].startswith('\n'): + code += '\n\n' + self.edit_node_range(pos, pos, code) + + # add a new task to the last agent in the stack + existing_agent_methods = self.get_agent_methods() + if not len(existing_agent_methods): + return # no agents to update + + def get_agent_methods(self) -> list[ast.FunctionDef]: + """An `agent` method is a method decorated with `@agent`.""" + return asttools.find_decorated_method_in_class(self.get_base_class(), 'agent') + + def add_agent_method(self, agent: AgentConfig) -> None: + """Add a new agent method to the entrypoint.""" + agent_methods = self.get_agent_methods() + if agent_methods: + # Add after the existing agent methods + _, pos = self.get_node_range(agent_methods[-1]) + else: + # Add before the `main` method + main_method = self.get_run_method() + pos, _ = self.get_node_range(main_method) + + code = f""" @agentstack.agent + def {agent.name}(self, messages: list[str] = []) -> Agent: + agent_config = agentstack.get_agent('{agent.name}') + messages = [ + agent_config.prompt, + *messages, + ] + return Agent( + name=agent_config.name, + model=agent_config.model, + instructions='\\n'.join(messages), + functions=[], + )""" + + if not self.source[:pos].endswith('\n'): + code = '\n\n' + code + if not self.source[pos:].startswith('\n'): + code += '\n\n' + self.edit_node_range(pos, pos, code) + + def get_agent_tools(self, agent_name: str) -> ast.List: + """Get the tools used by an agent as AST nodes.""" + method = asttools.find_method(self.get_agent_methods(), agent_name) + if method is None: + raise ValidationError(f"Agent method `{agent_name}` does not exist in {ENTRYPOINT}") + + # find the `functions` keyword argument to `Agent` inside method + try: + agent_init = asttools.find_method_calls(method, 'Agent')[0] + except IndexError: + raise ValidationError(f"Agent method `{agent_name}` does not instantiate `Agent` in {ENTRYPOINT}") + + tools_kwarg = asttools.find_kwarg_in_method_call(agent_init, 'functions') + + if not tools_kwarg: + raise ValidationError( + f"`@agent` method `{agent_name}` does not have a keyword argument `functions` in {ENTRYPOINT}" + ) + + if not isinstance(tools_kwarg.value, ast.List): + raise ValidationError( + f"`@agent` method `{agent_name}` has a non-list value for the `functions` kwarg in {ENTRYPOINT}" + ) + + return tools_kwarg.value + + def get_agent_tool_nodes(self, agent_name: str) -> list[ast.Starred]: + """ + Get a list of all ast nodes that define agentstack tools used by the agent. + """ + agent_tools_node = self.get_agent_tools(agent_name) + return asttools.find_tool_nodes(agent_tools_node) + + def get_agent_tool_names(self, agent_name: str) -> list[str]: + """Get a list of all tools used by the agent.""" + tool_names: list[str] = [] + for node in self.get_agent_tool_nodes(agent_name): + # ignore type checking here since `get_agent_tool_nodes` is exhaustive + tool_names.append(node.value.slice.value) # type: ignore[attr-defined] + return tool_names + + def add_agent_tools(self, agent_name: str, tool: ToolConfig) -> None: + """Add new tools to be used by an agent.""" + method = asttools.find_method(self.get_agent_methods(), agent_name) + if method is None: + raise ValidationError(f"`@agent` method `{agent_name}` does not exist in {ENTRYPOINT}") + + existing_node: ast.List = self.get_agent_tools(agent_name) + existing_elts: list[ast.expr] = existing_node.elts + + new_tool_nodes: list[ast.expr] = [] + if not tool.name in self.get_agent_tool_names(agent_name): + existing_elts.append(asttools.create_tool_node(tool.name)) + + new_node = ast.List(elts=existing_elts, ctx=ast.Load()) + start, end = self.get_node_range(existing_node) + self.edit_node_range(start, end, new_node) + + def remove_agent_tools(self, agent_name: str, tool: ToolConfig) -> None: + """Remove tools from an agent belonging to `tool`.""" + existing_node: ast.List = self.get_agent_tools(agent_name) + start, end = self.get_node_range(existing_node) + + # modify the existing node to remove any matching tools + for node in self.get_agent_tool_nodes(agent_name): + # ignore type checking here since `get_agent_tool_nodes` is exhaustive + if tool.name == node.value.slice.value: # type: ignore[attr-defined] + existing_node.elts.remove(node) + + self.edit_node_range(start, end, existing_node) + + +def validate_project() -> None: + """ + Validate that the project is ready to run. + Raises an `agentstack.ValidationError` if the project is not valid. + """ + try: + entrypoint = SwarmFile(conf.PATH / ENTRYPOINT) + except ValidationError as e: + raise e + + # A valid project must have a class in the entrypoint file + try: + class_node = entrypoint.get_base_class() + except ValidationError as e: + raise e + + # The class must have a `run` method + try: + entrypoint.get_run_method() + except ValidationError as e: + raise e + + # The class must have one or more methods decorated with `@task` + if len(entrypoint.get_task_methods()) < 1: + raise ValidationError( + f"`@task` decorated method not found in `{class_node.name}` class in {ENTRYPOINT}.\n" + "Create a new task using `agentstack generate task `." + ) + + # The class must have one or more methods decorated with `@agent` + if len(entrypoint.get_agent_methods()) < 1: + raise ValidationError( + f"`@agent` decorated method not found in `{class_node.name}` class in {ENTRYPOINT}.\n" + "Create a new agent using `agentstack generate agent `." + ) + + +def parse_llm(llm: str) -> tuple[str, str]: + """ + Parse the llm string into a tuple of `provider` and `model`. + """ + provider, model = llm.split('/') + return provider, model + + +def get_task_method_names() -> list[str]: + """ + Get a list of task names (methods with an @task decorator). + """ + entrypoint = SwarmFile(conf.PATH / ENTRYPOINT) + return [method.name for method in entrypoint.get_task_methods()] + + +def add_task(task: TaskConfig, position: Optional['InsertionPoint'] = None) -> None: + """ + Add a task method to the entrypoint. + """ + if position is not None: + raise NotImplementedError(f"Task insertion points are not supported in {NAME}.") + + with SwarmFile(conf.PATH / ENTRYPOINT) as entrypoint: + entrypoint.add_task_method(task) + + +def get_agent_method_names() -> list[str]: + """ + Get a list of agent names (methods with an @agent decorator). + """ + entrypoint = SwarmFile(conf.PATH / ENTRYPOINT) + return [method.name for method in entrypoint.get_agent_methods()] + + +def get_agent_tool_names(agent_name: str) -> list[Any]: + """ + Get a list of tools used by an agent. + """ + with SwarmFile(conf.PATH / ENTRYPOINT) as entrypoint: + return entrypoint.get_agent_tool_names(agent_name) + + +def add_agent(agent: AgentConfig, position: Optional[InsertionPoint] = None) -> None: + """ + Add an agent method to the entrypoint. + """ + if position is not None: + raise NotImplementedError(f"Agent insertion points are not supported in {NAME}.") + + with SwarmFile(conf.PATH / ENTRYPOINT) as entrypoint: + entrypoint.add_agent_method(agent) + + +def add_tool(tool: ToolConfig, agent_name: str): + """ + Add a tool to the entrypoint for the specified agent. + """ + with SwarmFile(conf.PATH / ENTRYPOINT) as entrypoint: + entrypoint.add_agent_tools(agent_name, tool) + + +def remove_tool(tool: ToolConfig, agent_name: str): + """ + Remove a tool from the entrypoint for the specified agent. + """ + with SwarmFile(conf.PATH / ENTRYPOINT) as entrypoint: + entrypoint.remove_agent_tools(agent_name, tool) + + +def wrap_tool(tool_func: Callable) -> Callable: + """ + Wrap a tool function with framework-specific functionality. + """ + # Swarm agents accept raw functions as tools, so no wrapping is needed. + return tool_func + + +def get_graph() -> list[graph.Edge]: + """Get the graph of the user's project.""" + log.debug(f"{NAME} does not support graph generation.") + return [] diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/.env.example b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/.env.example new file mode 100644 index 00000000..a642ffe5 --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/.env.example @@ -0,0 +1,4 @@ +#AGENTOPS_API_KEY=... +#OPENAI_API_KEY=... + +# Tools \ No newline at end of file diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/.gitignore b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/.gitignore new file mode 100644 index 00000000..8ce42678 --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/.gitignore @@ -0,0 +1,164 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +.agentops/ diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/LICENSE.md b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/LICENSE.md new file mode 100644 index 00000000..5ea2f54d --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/LICENSE.md @@ -0,0 +1,404 @@ +{%- if cookiecutter.project_metadata.license == "MIT" %} +MIT License + +Copyright (c) {{ cookiecutter.project_metadata.year }} {{ cookiecutter.project_metadata.author_name }} + +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. +{%- endif %} + + +{%- if cookiecutter.project_metadata.license == "Apache-2.0" %} + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {{ cookiecutter.project_metadata.year }} {{ cookiecutter.project_metadata.author_name }} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +{%- endif %} + +{%- if cookiecutter.project_metadata.license == "GNU" %} +GNU GENERAL PUBLIC LICENSE +Version 3, 29 June 2007 + +Copyright © 2007 Free Software Foundation, Inc. + +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +Preamble +The GNU General Public License is a free, copyleft license for software and other kinds of works. + +The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. + +TERMS AND CONDITIONS +0. Definitions. +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on the Program. + +To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. + +1. Source Code. +The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work. + +A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. + +The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +2. Basic Permissions. +All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. +No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. + +4. Conveying Verbatim Copies. +You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. +You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: + +a) The work must carry prominent notices stating that you modified it, and giving a relevant date. +b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”. +c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. +d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. +A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. + +6. Conveying Non-Source Forms. +You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: + +a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. +b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. +c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. +d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. +e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. +A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. + +A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. + +7. Additional Terms. +“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: + +a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or +b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or +c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or +d) Limiting the use for publicity purposes of names of licensors or authors of the material; or +e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or +f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. +All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. + +8. Termination. +You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. + +9. Acceptance Not Required for Having Copies. +You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. +Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. + +An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. + +11. Patents. +A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. + +In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. + +A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. + +12. No Surrender of Others' Freedom. +If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. + +13. Use with the GNU Affero General Public License. +Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. + +14. Revised Versions of this License. +The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. + +15. Disclaimer of Warranty. +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. Limitation of Liability. +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. +If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS +{%- endif %} \ No newline at end of file diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/README.md b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/README.md new file mode 100644 index 00000000..8cbe3819 --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/README.md @@ -0,0 +1,26 @@ +# {{ cookiecutter.project_metadata.project_name }} +{{ cookiecutter.project_metadata.description }} + +## How to build your OpenAI Swarm Agent +### With the CLI +Add an agent using AgentStack with the CLI: +`agentstack generate agent ` +You can also shorten this to `agentstack g a ` +For wizard support use `agentstack g a --wizard` +Finally for creation in the CLI alone, use `agentstack g a --role/-r --goal/-g --backstory/-b --model/-m ` + +This will automatically create a new agent in the `agents.yaml` config as well as in your code. Either placeholder strings will be used, or data included in the wizard. + +Similarly, tasks can be created with `agentstack g t ` + +Add tools with `agentstack tools add` and view tools available with `agentstack tools list` + +## How to use your Agent +In this directory, run `uv pip install --requirements pyproject.toml` + +To run your project, use the following command: +`agentstack run` + +This will initialize your AI agent project and begin task execution as defined in your configuration in the main.py file. + +> 🪩 Project built with [AgentStack](https://github.com/AgentOps-AI/AgentStack) diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/agentstack.json b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/agentstack.json new file mode 100644 index 00000000..5511a17a --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/agentstack.json @@ -0,0 +1,6 @@ +{ + "framework": "{{ cookiecutter.framework }}", + "agentstack_version": "{{ cookiecutter.project_metadata.agentstack_version }}", + "template": "{{ cookiecutter.project_metadata.template }}", + "template_version": "{{ cookiecutter.project_metadata.template_version }}" +} \ No newline at end of file diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/pyproject.toml b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/pyproject.toml new file mode 100644 index 00000000..f6dc4cf6 --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/pyproject.toml @@ -0,0 +1,13 @@ +[project] +name = "{{cookiecutter.project_metadata.project_name}}" +version = "{{cookiecutter.project_metadata.version}}" +description = "{{cookiecutter.project_metadata.description}}" +authors = [ + { name = "{{cookiecutter.project_metadata.author_name}}" } +] +license = { text = "{{cookiecutter.project_metadata.license}}" } +requires-python = ">=3.10" + +dependencies = [ + "agentstack[{{cookiecutter.framework}}]>={{cookiecutter.project_metadata.agentstack_version}}", +] \ No newline at end of file diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/__init__.py b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/agents.yaml b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/agents.yaml new file mode 100644 index 00000000..eed47206 --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/agents.yaml @@ -0,0 +1,10 @@ +{%- for agent in cookiecutter.structure.agents %} +{{agent.name}}: + role: > + {{agent.role}} + goal: > + {{agent.goal}} + backstory: > + {{agent.backstory}} + llm: {{agent.llm}} +{%- endfor %} \ No newline at end of file diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/inputs.yaml b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/inputs.yaml new file mode 100644 index 00000000..fcac19a9 --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/inputs.yaml @@ -0,0 +1,4 @@ +{%- for key, value in cookiecutter.structure.inputs.items() %} +{{key}}: > + {{value}} +{%- endfor %} \ No newline at end of file diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/tasks.yaml b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/tasks.yaml new file mode 100644 index 00000000..63e43048 --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/config/tasks.yaml @@ -0,0 +1,8 @@ +{%- for task in cookiecutter.structure.tasks %} +{{task.name}}: + description: > + {{task.description}} + expected_output: > + {{task.expected_output}} + agent: {{task.agent}} +{%- endfor %} \ No newline at end of file diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/main.py b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/main.py new file mode 100644 index 00000000..0d6d25cb --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/main.py @@ -0,0 +1,19 @@ +#!/usr/bin/env python +import agentstack +import agentops +from stack import {{cookiecutter.project_metadata.project_name|replace('-', '')|replace('_', '')|capitalize}}Stack + + +agentops.init(default_tags=agentstack.get_tags()) + +instance = {{cookiecutter.project_metadata.project_name|replace('-', '')|replace('_', '')|capitalize}}Stack() + +def run(): + """ + Run the agent. + """ + instance.run(inputs=agentstack.get_inputs()) + agentops.end_session(end_state='Success') + +if __name__ == '__main__': + run() \ No newline at end of file diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/stack.py b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/stack.py new file mode 100644 index 00000000..b0592a2b --- /dev/null +++ b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/stack.py @@ -0,0 +1,25 @@ +from swarm import Swarm, Agent +import agentstack + + +class {{ cookiecutter.project_metadata.project_name|replace('-', '')|replace('_', '')|capitalize }}Stack: + + def run(self, inputs: list[str]): + app = Swarm() + history = [] + for task in agentstack.get_all_tasks(): + agentstack.log.notify(f"Running task `{task.name}`") + response = app.run( + agent=getattr(self, task.name)(), + messages=history, + context_variables=inputs, + debug=agentstack.conf.DEBUG, + ) + for message in response.messages: + if message.get('role') not in ['user', 'assistant']: + continue + if message.get('tool_calls'): + continue + history.append(message) + agentstack.log.info(message['content']) + diff --git a/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/tools/__init__.py b/agentstack/templates/openai_swarm/{{cookiecutter.project_metadata.project_slug}}/src/tools/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/agentstack/templates/proj_templates/hello_alex.json b/agentstack/templates/proj_templates/hello_alex.json index 7f8f0164..e4e7e178 100644 --- a/agentstack/templates/proj_templates/hello_alex.json +++ b/agentstack/templates/proj_templates/hello_alex.json @@ -7,7 +7,7 @@ "name": "alex", "role": "You are a friendly assistant.", "goal": "Help the user with any of their requests.", - "backstory": "After years travelling the world, you've decided to get back into tech, just in time for the AI boom!. You're working on AgentStack, the fastest way to get started with AI agents. You have a README file available at: ./README.md", + "backstory": "After years traveling the world, you've decided to get back into tech, just in time for the AI boom!. You're working on AgentStack, the fastest way to get started with AI agents. You have a README file available at: ./README.md", "model": "openai/gpt-4o" }], "tasks": [{ diff --git a/agentstack/templates/proj_templates/hola_alex.json b/agentstack/templates/proj_templates/hola_alex.json new file mode 100644 index 00000000..7843609e --- /dev/null +++ b/agentstack/templates/proj_templates/hola_alex.json @@ -0,0 +1,37 @@ +{ + "name": "hola_alex", + "description": "A simple example that summarizes the README in spanish.", + "template_version": 4, + "framework": "openai_swarm", + "agents": [{ + "name": "alex", + "role": "You are a friendly assistant.", + "goal": "Help the user with any of their requests.", + "backstory": "After years traveling the world, you've decided to get back into tech, just in time for the AI boom!. You're working on AgentStack, the fastest way to get started with AI agents. You have a README file available at: ./README.md", + "llm": "openai/gpt-4o" + }, { + "name": "translator", + "role": "You are a professional translator.", + "goal": "Translate content passed to you into the correct language.", + "backstory": "You have an ivy league education in linguistics.", + "llm": "openai/gpt-4o" + }], + "tasks": [{ + "name": "hello_world", + "description": "As is tradition in software, let's start by saying 'Hello, World!'. Then, pick one or two tasks that they should try to do next with AgentStack.", + "expected_output": "The sentence Hello, World! followed by two things the user should try to customize their agent further.", + "agent": "alex" + }, { + "name": "translate_to_spanish", + "description": "Translate the content to Spanish.", + "expected_output": "The content translated to Spanish.", + "agent": "translator" + }], + "tools": [{ + "name": "file_read", + "agents": ["alex"] + }], + "method": "sequential", + "graph": [], + "inputs": {} +} diff --git a/pyproject.toml b/pyproject.toml index acade32f..617f4785 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -52,6 +52,9 @@ langgraph = [ "langgraph>=0.2.61", "langchain>=0.3.14", ] +openai_swarm = [ + "swarm @ git+https://github.com/openai/swarm@9db581cecaacea0d46a933d6453c312b034dbf47" +] [tool.setuptools.package-data] agentstack = ["templates/**/*"] diff --git a/tests/fixtures/frameworks/openai_swarm/entrypoint_max.py b/tests/fixtures/frameworks/openai_swarm/entrypoint_max.py new file mode 100644 index 00000000..216a350c --- /dev/null +++ b/tests/fixtures/frameworks/openai_swarm/entrypoint_max.py @@ -0,0 +1,68 @@ +from swarm import Swarm, Agent +import agentstack + + +class TestStack: + + def _handoff(self, agent_name: str): + """Tool for handing off to another agent.""" + agent = getattr(self, agent_name) + def func(context_variables: list[str]): + return agent(context_variables) + return func + + def _get_first_task(self): + """Get the first task.""" + task_name = agentstack.get_all_task_names()[0] + return getattr(self, task_name)() + + @agentstack.agent + def agent_name(self, messages: list[str] = []): + agent_config = agentstack.get_agent('agent_name') + return Agent( + name=agent_config.name, + model=agent_config.model, + instructions="\n".join([agent_config.prompt, *messages, ]), + functions=[], + ) + + @agentstack.agent + def second_agent_name(self, messages: list[str] = []): + agent_config = agentstack.get_agent('second_agent_name') + return Agent( + name=agent_config.name, + model=agent_config.model, + instructions="\n".join([agent_config.prompt, *messages, ]), + functions=[], + ) + + @agentstack.task + def task_name(self): + task_config = agentstack.get_task('task_name') + messages = [ + task_config.prompt, + ] + agent = getattr(self, task_config.agent) + return agent(messages) + + @agentstack.task + def task_name_two(self): + task_config = agentstack.get_task('task_name_two') + messages = [ + task_config.prompt, + ] + agent = getattr(self, task_config.agent) + return agent(messages) + + def run(self, inputs: list[str]): + app = Swarm() + response = app.run( + agent=self._get_first_task(), + messages=[], + context_variables=inputs, + debug=agentstack.conf.DEBUG, + ) + + for message in response.messages: + agentstack.log.info(message['content']) + diff --git a/tests/fixtures/frameworks/openai_swarm/entrypoint_min.py b/tests/fixtures/frameworks/openai_swarm/entrypoint_min.py new file mode 100644 index 00000000..7e5a60b1 --- /dev/null +++ b/tests/fixtures/frameworks/openai_swarm/entrypoint_min.py @@ -0,0 +1,30 @@ +from swarm import Swarm, Agent +import agentstack + + +class TestStack: + + def _handoff(self, agent_name: str): + """Tool for handing off to another agent.""" + agent = getattr(self, agent_name) + def func(context_variables: list[str]): + return agent(context_variables) + return func + + def _get_first_task(self): + """Get the first task.""" + task_name = agentstack.get_all_task_names()[0] + return getattr(self, task_name)() + + def run(self, inputs: list[str]): + app = Swarm() + response = app.run( + agent=self._get_first_task(), + messages=[], + context_variables=inputs, + debug=agentstack.conf.DEBUG, + ) + + for message in response.messages: + agentstack.log.info(message['content']) + diff --git a/tests/test_frameworks_langgraph.py b/tests/test_frameworks_langgraph.py index 44265260..49ed0e84 100644 --- a/tests/test_frameworks_langgraph.py +++ b/tests/test_frameworks_langgraph.py @@ -19,6 +19,10 @@ class FrameworksLanggraphTest(unittest.TestCase): def setUp(self): self.framework = os.getenv('TEST_FRAMEWORK') + + if not self.framework == frameworks.LANGGRAPH: + self.skipTest("These tests are only for the LangGraph framework") + self.project_dir = BASE_PATH / 'tmp' / self.framework / 'langgraph' conf.set_path(self.project_dir) os.makedirs(self.project_dir / 'src/config') diff --git a/tests/test_frameworks_openai_swarm.py b/tests/test_frameworks_openai_swarm.py new file mode 100644 index 00000000..003744ae --- /dev/null +++ b/tests/test_frameworks_openai_swarm.py @@ -0,0 +1,74 @@ +import os, sys +import shutil +import unittest +from pathlib import Path +import ast +from agentstack import conf +from agentstack.exceptions import ValidationError +from agentstack import frameworks +from agentstack.frameworks.openai_swarm import ENTRYPOINT, SwarmFile +from agentstack.agents import AGENTS_FILENAME, AgentConfig +from agentstack.tasks import TASKS_FILENAME, TaskConfig + +BASE_PATH = Path(__file__).parent + + +class FrameworksOpenAISwarmTest(unittest.TestCase): + def setUp(self): + self.framework = os.getenv('TEST_FRAMEWORK') + + if not self.framework == frameworks.OPENAI_SWARM: + self.skipTest("These tests are only for the OpenAI Swarm framework") + + self.project_dir = BASE_PATH / 'tmp' / self.framework / 'openai_swarm' + conf.set_path(self.project_dir) + os.makedirs(self.project_dir / 'src/config') + + shutil.copy(BASE_PATH / 'fixtures/agentstack.json', self.project_dir / 'agentstack.json') + with conf.ConfigFile() as config: + config.framework = frameworks.OPENAI_SWARM + + def tearDown(self): + shutil.rmtree(self.project_dir) + + def test_missing_base_class(self): + """A class with the name *Stack does not exist in the entrypoint""" + entrypoint_src = """ +class FooBar: + pass + """ + with open(self.project_dir / ENTRYPOINT, 'w') as f: + f.write(entrypoint_src) + + entrypoint = SwarmFile(self.project_dir / ENTRYPOINT) + with self.assertRaises(ValidationError): + entrypoint.get_base_class() + + def test_missing_run_method(self): + """A method named `run` does not exist in the base class""" + entrypoint_src = """ +class TestStack: + def foo(self): + pass + """ + with open(self.project_dir / ENTRYPOINT, 'w') as f: + f.write(entrypoint_src) + + entrypoint = SwarmFile(self.project_dir / ENTRYPOINT) + with self.assertRaises(ValidationError): + entrypoint.get_run_method() + + def test_invalid_run_method(self): + """The run method does not have the correct signature""" + entrypoint_src = """ +class TestStack: + def run(self, foo): + pass + """ + with open(self.project_dir / ENTRYPOINT, 'w') as f: + f.write(entrypoint_src) + + entrypoint = SwarmFile(self.project_dir / ENTRYPOINT) + with self.assertRaises(ValidationError): + entrypoint.get_run_method() + diff --git a/tox.ini b/tox.ini index 2e39b7dd..a85fea7f 100644 --- a/tox.ini +++ b/tox.ini @@ -3,14 +3,14 @@ # `TEST_FRAMEWORK` section to `setenv`. # Developers -# run just 3.12 tests with `tox -epy312-crewai,py312-langgraph,report` +# run just 3.12 tests with `tox -epy312-crewai,py312-langgraph,py312-openai_swarm,report` # TODO I have not found a way to alias this, yet. # Coverage # codecov is configured to run on all frameworks and then be combined at the end. [tox] -envlist = py{310,311,312}-{crewai,langgraph} +envlist = py{310,311,312}-{crewai,langgraph,openai_swarm} [gh-actions] # converts python versions to tox envlist values for github actions @@ -24,6 +24,7 @@ extras = # framework specific dependencies crewai: crewai # installs agentstack[crewai] langgraph: langgraph + openai_swarm: openai_swarm deps = pytest parameterized @@ -39,6 +40,7 @@ setenv = # environment variables to determine active framework inside tests crewai: TEST_FRAMEWORK = crewai langgraph: TEST_FRAMEWORK = langgraph + openai_swarm: TEST_FRAMEWORK = openai_swarm [testenv:report] deps = coverage