Development Setup¶

git clone https://github.com/Siddharth-magesh/Sentimatrix.git
cd Sentimatrix

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Linux/Mac
# venv\Scripts\activate  # Windows

# Install in development mode
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

playwright install chromium

# All tests
pytest

# With coverage
pytest --cov=sentimatrix --cov-report=html

# Specific test file
pytest tests/test_sentiment.py

# Fast tests only
pytest -m "not slow"

# Format code
black sentimatrix tests
isort sentimatrix tests

# Lint
ruff check sentimatrix tests

# Type check
mypy sentimatrix

cd website
pip install -r requirements.txt
mkdocs serve