Installation

Reveilio is a plain Python package. No system services or containers are required.

Requirements

Python 3.9 or later (tested on 3.9 through 3.12).
An API key for one of the supported providers: Gemini, OpenAI, or Azure OpenAI. Alternatively, a running Ollama instance for local inference.
On Linux, for reliable legacy .doc (binary Word) support, install antiword:
```
sudo apt-get install antiword
```
Without it, reveilio falls back to a binary-safe text heuristic that is usable but less clean.

Install from PyPI

pip install reveilio

Install from source (for development)

git clone https://github.com/roosterhr/reveilio.git
cd reveilio
pip install -e ".[dev]"
pytest

Tip: reveilio uses the src/reveilio layout, so an editable install exposes the package without any PYTHONPATH changes.

What gets installed

Dependency	Purpose
`pydantic`	Typed result models such as `AnalysisResult` and `ResumeData`.
`PyPDF2`	PDF text extraction.
`python-docx`	DOCX text extraction.
`httpx`	HTTP client used for Ollama calls.
`openai`	OpenAI and Azure OpenAI client.
`google-genai`	Gemini client.
`reportlab`	PDF report generation.

Note: reveilio deliberately does not pull in fastapi, sqlalchemy, asyncpg, geopy, or apify-client. These dependencies belonged to the original application and are not required for the scoring core.

Verifying the install

python -c "import reveilio; print(reveilio.__version__)"
# 0.1.0

Continue to the Quickstart.