User Guide

This section covers the main ways to use Compere.

Contents

• API Reference - Complete REST API endpoint documentation
• Library Usage - Using Compere as a Python library
• Configuration - Environment variables and options

Choosing an Approach

Approach	Best For
REST API	Web applications, microservices, language-agnostic clients
Python Library	Direct integration, scripts, notebooks, batch processing

Both approaches use the same underlying algorithms and database, so you can mix them as needed.