AgentNeo
RagaAIPackageGitHub
  • AgentNeo
  • Getting Started
    • Overview
    • Quick Start Guide
    • Installation Guide
  • Features
    • Architecture
    • Basic Usage
    • Components
    • Key Features
    • Dashboard
  • Developer Guide
    • Advanced Usage
    • API Documentation
    • Database
  • Evaluation & Metrics
    • Metric Configuration
    • Overview
    • Supported Metrics
  • Contributing
    • Guidelines
    • Pull Request Process
    • Development Setup
  • Troubleshooting
    • Common Issues and Solutions
    • Frequently Asked Questions
  • Release Information
    • Breaking Changes
    • Version History
  • Reference
    • Glossary
    • Changelog
Powered by GitBook
On this page
  • Initial Setup
  • Development Tools
  • Setting Up Pre-commit Hooks
  • Running Tests
  • To run the dashboard after local UI code changes
  1. Contributing

Development Setup

Initial Setup

  1. Clone the Repository

git clone https://github.com/raga-ai-hub/agentneo.git
cd agentneo
  1. Create Virtual Environment

python -m venv venv
source venv/bin/activate  # Unix
# or
venv\Scripts\activate  # Windows
  1. Install Development Dependencies

pip install -e ".[dev]"

Development Tools

Required Tools

  • Python 3.8+

  • Git

  • pytest

  • black (code formatting)

  • isort (import sorting)

  • flake8 (linting)

Installing Development Tools

pip install black isort flake8 pytest pytest-cov

Setting Up Pre-commit Hooks

pre-commit install

Running Tests

# 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

# 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 .
PreviousPull Request ProcessNextCommon Issues and Solutions

Last updated 6 months ago