Copinance OS Documentation

Welcome to Copinance OS - an open-source stock research platform and framework.

What is Copinance OS?

Copinance OS is a Python library that helps you perform comprehensive stock research with:

Dual workflow support (static pipelines and AI-powered agentic workflows)
Adaptive presentation based on financial literacy level
Extensible architecture for custom data providers and analyzers

🚀 Getting Started

Installation - Get up and running
Quick Start - Your first research in 5 minutes

👤 User Guide

CLI Reference - Complete command reference
Workflows - Static and agentic workflows
Configuration - Setting up API keys and options

🔧 Developer Guide

Architecture - System design and patterns
Extending - Adding custom data providers
Testing - Test structure and guidelines

📚 API Reference

Data Providers - Data provider interfaces

Key Concepts

Research Profiles

Research profiles provide context for research execution (financial literacy level, preferences). This is NOT user management - your app handles users, we handle research context.

Workflow Types

Static: Predefined analysis pipeline with consistent steps
Agentic: AI-powered dynamic analysis that adapts to questions

Need Help?

📖 Check the User Guide for common tasks
🐛 Report issues on GitHub
💬 Join Discussions in the repository

Installation