Getting Started

This section guides you through installing Compere and running your first comparison.

Overview

Compere can be used in two ways:

1. As a Web Service - Run the FastAPI server and interact via REST API
2. As a Python Library - Import modules directly in your Python code

Prerequisites

• Python 3.11 or higher
• uv (recommended) or pip
• Node.js 18+ (optional, for the demo UI)

What's Next?

• Installation - Install Compere using uv, pip, or from source
• Quick Start - Start the server and explore the API
• First Comparison - Create entities and record comparisons