OrionIntel

AI-powered RAG platform for analyzing company files, finance reports, and books.

Setup

Install uv, then run uv sync.

curl -LsSf https://astral.sh/uv/install.sh | sh

Alternatively, you can use pip:

pip install uv

Then install dependencies:

uv sync

Activate the virtual environment (Windows)

.venv\Scripts\activate

Setup the environment variables

$ cp .env.example .env

Set your environment variables in the .env file. Like OPENAI_API_KEY value.

Running the Project

To run the project in development mode, use the following command:

uv run fastapi dev main.py

To run on a specific port (e.g., 7070):

uv run fastapi dev main.py --port 7070

Run Docker Compose Services

$ cd docker
$ cp .env.example .env

Update .env with your credentials

$ cd docker
$  docker compose up -d

Linting and Code Cleaning

Ruff (Linting)

To install Ruff:

uv tool install ruff@latest

To run the check:

uv run ruff check

To format code:

uv run ruff format

Autoflake (Removing Unused Imports)

To add autoflake to the project:

uv add autoflake

To remove unused imports:

uv run autoflake --in-place --recursive --remove-all-unused-imports .

To remove autoflake from the project:

uv remove autoflake

Black (Formatting)

uv run black .

isort (Import Sorting)

uv run isort .

Docker Cleanup (Windows CMD)

If you need to wipe your Docker environment clean, use these commands in your Windows Command Prompt (CMD).

Stop all running containers

FOR /f "tokens=*" %i IN ('docker ps -aq') DO docker stop %i

Stops every active container currently running on your system.

Remove all containers

FOR /f "tokens=*" %i IN ('docker ps -aq') DO docker rm %i

Deletes all containers (they must be stopped first).

Remove all images

FOR /f "tokens=*" %i IN ('docker images -q') DO docker rmi %i

Deletes all downloaded or built Docker images.

Remove all volumes

FOR /f "tokens=*" %i IN ('docker volume ls -q') DO docker volume rm %i

Deletes all persistent data volumes managed by Docker.

System Prune (Deep Clean)

docker system prune --all

A built-in Docker command that removes all unused containers, networks, and images (dangling and unreferenced) in one go.