Installation

Install Copinance OS (import name copinance_os, distribution name copinance-os) from source. You get a CLI (copinance) and a library wired through get_container() and ResearchOrchestrator — see Architecture for how the pieces fit together.

Prerequisites

Python 3.11 or higher
make (optional, recommended)

Install from source

Recommended (with make):

git clone https://github.com/copinance/copinance-os.git
cd copinance-os
make setup

make setup creates a virtual environment at .venv, installs all dependencies (yfinance, FRED client, edgartools for SEC/EDGAR, QuantLib for BSM Greeks), and sets up pre-commit hooks.

Manual:

git clone https://github.com/copinance/copinance-os.git
cd copinance-os
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e ".[dev]"

Verify

copinance version
# Or from the repo root without a full install:
python -m copinance_os.interfaces.cli version

Expected output:

Copinance OS v0.1.0

Optional dependencies

Local LLM support (Ollama):

pip install -e ".[ollama]"

Plugin system (PyYAML):

pip install -e ".[plugins]"

Next Steps

Quick Start — Run your first analysis
Configuration — LLM keys, FRED, EDGAR, cache
Using as a Library — Integrate into your app
CLI Reference — Full command reference

Introduction Quick Start