Skip to content

Building AI agents, atomically

add linting & formatting & testing instructions

KennyVaneetvelde3a5eb4e0ed23
diff --git a/README.md b/README.md
index 14e59d8..433bf99 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,18 @@ Atomic Agents depends on the [Instructor](https://github.com/jxnl/instructor) pa
Additionally, Atomic Agents should work with Ollama or LMStudio. If the default settings do not work due to your local server not supporting tool-calling, you can set the `mode` to JSON.
+## Formatting
+To format the code before committing, you must run the following two commands:
+`black atomic_agents`
+`flake8 atomic_agents --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics`
+
+## Testing
+To run the tests, run the following command:
+`pytest --cov atomic_agents`
+
+To view the coverage report, run the following command:
+`coverage html`
+
## Contributing
We welcome contributions! Please follow these steps to contribute:
diff --git a/atomic_agents/agents/base_chat_agent.py b/atomic_agents/agents/base_chat_agent.py
index 06ffab6..b449805 100644
--- a/atomic_agents/agents/base_chat_agent.py
+++ b/atomic_agents/agents/base_chat_agent.py
@@ -42,7 +42,7 @@ class BaseChatAgentOutputSchema(BaseAgentIO):
description=(
"The chat message exchanged between the user and the chat agent. "
"This contains the markdown-enabled response generated by the chat agent."
- ),
+ )
)
class Config: