Contributing to agno
Agno is an open-source project and we welcome contributions.
👩💻 How to contribute
Please follow the fork and pull request workflow:
- Fork the repository.
- Create a new branch for your feature.
- Add your feature or improvement.
- Ensure your Pull Request follows our guidelines (see below).
- Send a pull request.
- We appreciate your support & input!
Pull Request Guidelines
To maintain a clear and organized project history, please adhere to the following guidelines when submitting Pull Requests:
- Title Format: Your PR title must start with a type tag enclosed in square brackets, followed by a space and a concise subject.
- Example:
[feat] Add user authentication
- Valid types:
[feat], [fix], [cookbook], [test], [refactor], [chore], [style], [revert], [release].
- Link to Issue: The PR description should ideally reference the issue it addresses using keywords like
fixes #<issue_number>, closes #<issue_number>, or resolves #<issue_number>.
- Example:
This PR fixes #42 by implementing the new login flow.
These guidelines are enforced automatically by our PR Lint workflow.
Development setup
- Clone the repository.
- Check if you have
uv installed by running uv --version.
- If you have
uv installed, you can skip this step.
- If you don't have
uv installed, you can install it by running pip install uv.
- Create a virtual environment:
- For Unix, use
./scripts/dev_setup.sh.
- For Windows, use
.\scripts\dev_setup.bat.
- This setup will:
- Create a
.venv virtual environment in the current directory.
- Install the required packages.
- Install the
agno package in editable mode.
- Activate the virtual environment:
- On Unix:
source .venv/bin/activate
- On Windows:
.venv\Scripts\activate
From here on you have to use uv pip install to install missing packages
Ensure your code meets our quality standards by running the appropriate formatting and validation script before submitting a pull request:
- For Unix:
./scripts/format.sh./scripts/validate.sh
- For Windows:
.\scripts\format.bat.\scripts\validate.bat
These scripts will perform code formatting with ruff and static type checks with mypy.
Local testing
Before submitting a pull request, ensure all tests pass locally:
-
Do the development setup above.
-
Run the test suite ./scripts/test.sh
-
Run specific test files or test cases: pytest ./libs/agno/tests/unit/utils/test_string.py or whatever file you want to test.
Make sure all tests pass before submitting your pull request. If you add new features, include appropriate test coverage.
Adding a new Vector Database
- Setup your local environment by following the Development setup.
- Create a new directory under
libs/agno/agno/vectordb for the new vector database.
- Create a Class for your VectorDb that implements the
VectorDb interface
- Your Class will be in the
libs/agno/agno/vectordb/<your_db>/<your_db>.py file.
- The
VectorDb interface is defined in libs/agno/agno/vectordb/base.py
- Import your
VectorDb Class in libs/agno/agno/vectordb/<your_db>/__init__.py.
- Checkout the
libs/agno/agno/vectordb/pgvector/pgvector file for an example.
- Add a recipe for using your
VectorDb under cookbook/07_knowledge/vector_db/<your_db>.
- Important: Format and validate your code by running
./scripts/format.sh and ./scripts/validate.sh.
- Submit a pull request.
Adding a new Model Provider
- Setup your local environment by following the Development setup.
- Create a new directory under
libs/agno/agno/models for the new Model provider.
- If the Model provider supports the OpenAI API spec:
- Create a Class for your LLM provider that inherits the
OpenAILike Class from libs/agno/agno/models/openai/like.py.
- Your Class will be in the
libs/agno/agno/models/<your_model>/<your_model>.py file.
- Import your Class in the
libs/agno/agno/models/<your_model>/__init__.py file.
- Checkout the
agno/models/together/together.py file for an example.
- If the Model provider does not support the OpenAI API spec:
- Add your model provider to
libs/agno/agno/models/utils.py:
- Add a recipe for using your Model provider under
cookbook/models/<your_model>.
- Important: Format and validate your code by running
./scripts/format.sh and ./scripts/validate.sh.
- Submit a pull request.
- Setup your local environment by following the Development setup.
- Create a new directory under
libs/agno/agno/tools for the new Tool.
- Create a Class for your Tool that inherits the
Toolkit Class from libs/agno/agno/tools/toolkit/toolkit.py.
- Your Class will be in
libs/agno/agno/tools/<your_tool>.py.
- Make sure to register all functions in your class via a flag.
- Checkout the
agno/tools/youtube.py file for an example.
- If your tool requires an API key, checkout the
agno/tools/serpapi_tools.py as well.
- Add a recipe for using your Tool under
cookbook/tools/<your_tool>.
- Important: Format and validate your code by running
./scripts/format.sh and ./scripts/validate.sh.
- Submit a pull request.
Message us on Discord or post on Discourse if you have any questions or need help with credits.
📚 Resources
📝 License
This project is licensed under the terms of the Apache-2.0 license