diff --git a/.replit b/.replit index 69fe1d48..e93c2a36 100644 --- a/.replit +++ b/.replit @@ -82,3 +82,12 @@ args = "sleep 2" [[workflows.workflow.tasks]] task = "shell.exec" args = "python examples/mcp_example/mock_multi_agent.py" + +[[workflows.workflow]] +name = "Run Tests" +author = 13983571 +mode = "sequential" + +[[workflows.workflow.tasks]] +task = "shell.exec" +args = "python -m unittest tests/test_basic_example.py -v" diff --git a/docs/examples/basic_usage.md b/docs/examples/basic_usage.md new file mode 100644 index 00000000..038764a4 --- /dev/null +++ b/docs/examples/basic_usage.md @@ -0,0 +1,24 @@ + +# Basic Usage Guide + +## Getting Started + +This guide demonstrates how to use the basic features of the Swarms framework. + +### Basic Agent Example + +```python +from swarms.structs.agent import Agent + +# Initialize agent +agent = Agent( + agent_name="Basic-Example-Agent", + agent_description="A simple example agent", + system_prompt="You are a helpful assistant.", + model_name="gpt-4", +) + +# Run the agent +response = agent.run("What is 2+2?") +print(f"Agent response: {response}") +``` diff --git a/examples/basic_example.py b/examples/basic_example.py new file mode 100644 index 00000000..ca39aa89 --- /dev/null +++ b/examples/basic_example.py @@ -0,0 +1,18 @@ + +from swarms.structs.agent import Agent + +def main(): + # Initialize basic agent + agent = Agent( + agent_name="Basic-Example-Agent", + agent_description="A simple example agent", + system_prompt="You are a helpful assistant.", + model_name="gpt-4", + ) + + # Run the agent + response = agent.run("What is 2+2?") + print(f"Agent response: {response}") + +if __name__ == "__main__": + main() diff --git a/tests/test_basic_example.py b/tests/test_basic_example.py new file mode 100644 index 00000000..d626bbe9 --- /dev/null +++ b/tests/test_basic_example.py @@ -0,0 +1,23 @@ + +import unittest +from swarms.structs.agent import Agent + +class TestBasicExample(unittest.TestCase): + def setUp(self): + self.agent = Agent( + agent_name="Test-Agent", + agent_description="A test agent", + system_prompt="You are a helpful assistant.", + model_name="gpt-4", + ) + + def test_agent_initialization(self): + self.assertEqual(self.agent.agent_name, "Test-Agent") + self.assertEqual(self.agent.agent_description, "A test agent") + + def test_agent_run(self): + response = self.agent.run("What is 2+2?") + self.assertIsNotNone(response) + +if __name__ == "__main__": + unittest.main()