Stock-Analysis

AI-assisted equity research and reporting, built by the RIT AI Club. A ground-up rewrite of FinRLExtension.

Status: early development. Nothing is runnable yet. See CHANGELOG.md.

Warning

This project is for educational and research purposes only. Nothing it produces is financial or investment advice. Do your own research and consult a licensed professional before making investment decisions.

Getting started

Prerequisites: uv and Git. uv installs the correct Python version for you.

git clone git@github.com:RIT-AI-Club/Stock-Analysis.git
cd Stock-Analysis
uv sync                      # create .venv and install everything from uv.lock
uv run pre-commit install    # enable the git hooks
cp .env.example .env         # then fill in your keys

Run the checks CI runs:

uv run ruff check && uv run ruff format --check && uv run mypy && uv run pytest

Project structure

src/stock_analysis/   Application package
tests/                Tests (mirrors src/ layout)
docs/                 Architecture docs and decision records (docs/adr/)
.github/              CI workflows, issue/PR templates, CODEOWNERS

Documentation

• Architecture: how the system fits together
• Architecture Decision Records: why it's built this way
• Contributing guide: setup, workflow, and coding standards

Contributing

Read CONTRIBUTING.md before opening a PR. All participants are expected to follow the Code of Conduct.