> For the complete documentation index, see [llms.txt](https://agentneo.raga.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://agentneo.raga.ai/contributing/development-setup.md).

# Development Setup

### Initial Setup

1. Clone the Repository

```bash
git clone https://github.com/raga-ai-hub/agentneo.git
cd agentneo
```

2. Create Virtual Environment

```bash
python -m venv venv
source venv/bin/activate  # Unix
# or
venv\Scripts\activate  # Windows
```

3. Install Development Dependencies

```bash
pip install -e ".[dev]"
```

### Development Tools

#### Required Tools

* Python 3.8+
* Git
* pytest
* black (code formatting)
* isort (import sorting)
* flake8 (linting)

#### Installing Development Tools

```bash
pip install black isort flake8 pytest pytest-cov
```

### Setting Up Pre-commit Hooks

```bash
pre-commit install
```

### Running Tests

```bash
# Run all tests
pytest

# Run with coverage
pytest --cov=agentneo tests/

# Run specific test file
pytest tests/test_tracer.py
```

### To run the dashboard after local UI code changes 

```bash
# 1. Move to the UI folder
> cd agentneo/ui

# 2. Install the dependencies
> npm i

# 3. Build the UI files after the code changes
> npm run build

# 4. Go back to the root folder
> cd ..

# 5. Remove any previous installations of agentneo
> pip uninstall agentneo

# 6. Install the updated code
> pip install -e .
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://agentneo.raga.ai/contributing/development-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.