DEVELOPMENT.md

Development Guide

This guide provides instructions for setting up a development environment for freeact. Follow these steps to get started with development, testing, and contributing to the project.

Clone the repository:

git clone https://github.com/gradion-ai/freeact.git
cd freeact

Create a new Conda environment and activate it:

conda env create -f environment.yml
conda activate freeact

Install the poetry dynamic versioning plugin:

poetry self add "poetry-dynamic-versioning[plugin]"

Install dependencies with Poetry:

poetry install --with dev --with docs --with eval

Install pre-commit hooks:

invoke precommit-install

Create a .env file with Anthropic and Gemini API keys:

# Required for Claude 3.5 Sonnet
ANTHROPIC_API_KEY=...

# Required for generative Google Search via Gemini 2
GOOGLE_API_KEY=...

# Required to run integration tests using Qwen models via HuggingFace API
QWEN_MODEL_NAME=Qwen/Qwen2.5-Coder-32B-Instruct
QWEN_BASE_URL=https://api-inference.huggingface.co/v1/
QWEN_API_KEY=...

Enforce coding conventions (done automatically by pre-commit hooks):

invoke cc

Run unit tests:

invoke ut

Run integration tests:

invoke it

Run all tests:

invoke test