Building AI agents, atomically
Reorganized and updated development resources
KennyVaneetvelde5bd90af33c5d
diff --git a/DEV_GUIDE.md b/DEV_GUIDE.mddeleted file mode 100644index e718753..0000000--- a/DEV_GUIDE.md+++ /dev/null@@ -1,21 +0,0 @@-1. Fork the repository-2. Create a new branch (`git checkout -b feature-branch`)-3. Make your changes-4. Commit your changes (`git commit -m 'Add some feature'`)-5. Push to the branch (`git push origin feature-branch`)-6. Open a pull request--## Formatting and Linting-To format & lint the code before committing, you must run the following two commands:--`black atomic_agents`--`flake8 atomic_agents`---## Testing-To run the tests, run the following command:-`pytest --cov atomic_agents`--To view the coverage report, run the following command:-`coverage html`diff --git a/README.md b/README.mdindex 7491e19..e865781 100644--- a/README.md+++ b/README.md@@ -66,16 +66,16 @@ for question in response.suggested_questions:This snippet showcases how to create a customizable agent that responds to user queries and suggests follow-up questions. For full, runnable examples, please refer to the following files in the `atomic-examples/quickstart/quickstart/` directory:-- [Basic Chatbot](./atomic-examples/quickstart/quickstart/1_basic_chatbot.py)+- [Basic Chatbot](/atomic-examples/quickstart/quickstart/1_basic_chatbot.py)A minimal chatbot example to get you started.-- [Custom Chatbot](./atomic-examples/quickstart/quickstart/2_basic_custom_chatbot.py)+- [Custom Chatbot](/atomic-examples/quickstart/quickstart/2_basic_custom_chatbot.py)A more advanced example with a custom system prompt.-- [Custom Chatbot with Schema](./atomic-examples/quickstart/quickstart/3_basic_custom_chatbot_with_custom_schema.py)+- [Custom Chatbot with Schema](/atomic-examples/quickstart/quickstart/3_basic_custom_chatbot_with_custom_schema.py)An advanced example featuring a custom output schema.-- [Multi-Provider Chatbot](./atomic-examples/quickstart/quickstart/4_basic_chatbot_different_providers.py)+- [Multi-Provider Chatbot](/atomic-examples/quickstart/quickstart/4_basic_chatbot_different_providers.py)Demonstrates how to use different providers like Ollama or Groq.These examples provide a great starting point for understanding and using Atomic Agents.@@ -99,7 +99,7 @@ API documentation can be found [here](https://brainblend-ai.github.io/atomic-age## ContributingWe welcome contributions! Please follow these steps to contribute:-See the [Developer Guide](./DEV_GUIDE.md) for more information on how to contribute to Atomic Agents.+See the [Developer Guide](/guides/DEV_GUIDE.md) for more information on how to contribute to Atomic Agents.## LicenseThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.diff --git a/atomic-forge/README.md b/atomic-forge/README.mdindex 8b13789..e077436 100644--- a/atomic-forge/README.md+++ b/atomic-forge/README.md@@ -1 +1,7 @@+# Atomic Forge+Atomic Forge is a collection of tools that can be used with Atomic Agents to extend its functionality and integrate with other services.++## Using the Atomic Assembler CLI++Please use the [Atomic Assembler CLI](../README.md) as mentioned in the main [README.md](https://github.com/BrainBlend-AI/atomic-agents/blob/main/README.md) for managing and downloading Tools.diff --git a/guides/DEV_GUIDE.md b/guides/DEV_GUIDE.mdnew file mode 100644index 0000000..0088eaa--- /dev/null+++ b/guides/DEV_GUIDE.md@@ -0,0 +1,115 @@+# Atomic Agents Development Guide++This guide provides instructions for developers who want to contribute to the Atomic Agents project. It covers the project structure, setup, development workflow, and best practices.++## Project Structure++Atomic Agents uses a monorepo structure, which means multiple related projects are managed in a single repository. The main components are:++1. `atomic-agents/`: The core Atomic Agents library+2. `atomic-assembler/`: The CLI tool for managing Atomic Agents components+3. `atomic-examples/`: Example projects showcasing Atomic Agents usage+4. `atomic-forge/`: A collection of tools that can be used with Atomic Agents++## Getting Started++### Prerequisites++- Python 3.11 or higher+- Poetry (for dependency management)+- Git++### Setting Up the Development Environment++1. Fork the repository on GitHub.+2. Clone your fork locally:+ ```+ git clone https://github.com/BrainBlend-AI/atomic-agents.git+ cd atomic-agents+ ```+3. Install dependencies using Poetry:+ ```+ poetry install+ ```+4. Activate the virtual environment:+ ```+ poetry shell+ ```++## Development Workflow++1. Create a new branch for your feature or bugfix:+ ```+ git checkout -b feature-branch+ ```++2. Make your changes in the appropriate project directory.++3. Format your code using Black:+ ```+ black atomic_agents atomic_assembler+ ```++4. Lint your code using Flake8:+ ```+ flake8 atomic_agents atomic_assembler+ ```++5. Run the tests:+ ```+ pytest --cov atomic_agents+ ```++6. If you've added new functionality, make sure to add appropriate tests.++7. Commit your changes:+ ```+ git commit -m 'Add some feature'+ ```++8. Push to your fork:+ ```+ git push origin feature-branch+ ```++9. Open a pull request on GitHub.++## Code Style and Best Practices++- Follow PEP 8 guidelines for Python code style.+- Use type hints wherever possible.+- Write clear, concise docstrings for all public modules, functions, classes, and methods.+- Keep functions and methods small and focused on a single responsibility.+- Use meaningful variable and function names.++## Testing++- Write unit tests for all new functionality.+- Make sure to get 100% test coverage for all new functionality.+- Run the test suite before submitting a pull request:+ ```+ pytest --cov atomic_agents+ ```+- To view a detailed coverage report:+ ```+ coverage html+ ```+ This will generate an HTML report in the `htmlcov/` directory.++## Documentation++- Update the README.md file if you've added new features or changed existing functionality.+- If you've added new modules or significant features, consider updating the API documentation.++## Submitting Changes++- Create a pull request with a clear title and description.+- Link any relevant issues in the pull request description.+- Make sure all tests pass and there are no linting errors.+- Be responsive to code review feedback and make necessary changes.++## Questions and Support++If you have any questions or need support while developing, please open an issue on GitHub or reach out to the maintainers.++Thank you for contributing to Atomic Agents!diff --git a/guides/dev-setup.md b/guides/dev-setup.mddeleted file mode 100644index e69de29..0000000