README.md

Pyronear Annotation API

The building blocks of our annotations and model predictions as an API.

Installation

Prerequisites

• Git
• Docker
• Docker compose

Starting your service

1 - Clone the repository

git clone https://github.com/pyronear/pyro-annotator.git && cd pyro-annotator
cd annotation_api

2 - Setup and start the services

The setup is now automated! Simply run:

# For development (recommended)
make start

# For production
make start-prod

# Or run setup separately
make setup

The setup automatically:

• Creates the required acme.json file for Let's Encrypt certificates
• Sets proper file permissions (600)
• Checks prerequisites (Docker, Docker Compose)

3 - Stop the services

# Stop development environment
make stop

# Stop production environment  
make stop-prod

4 - Check what you've deployed

You can now access your backend API at http://localhost:5050/docs

Run the tests

make test

Install locally

1. Install uv with pipx:

pipx install uv

2. Install dependencies:

uv sync

3. Activate the uv virtual environment:

source .venv/bin/activate

Documentation

For comprehensive documentation including API client guides, examples, and data ingestion instructions, see the docs/ directory.

Key documentation includes:

• API Client Guide - Practical usage and integration patterns
• Data Ingestion Guide - Platform data transfer scripts
• API Reference - Complete technical reference
• Examples & Recipes - Real-world implementation patterns

Contributing

Any sort of contribution is greatly appreciated!

You can find a short guide in CONTRIBUTING to help grow this project!

License

Distributed under the Apache 2.0 License. See LICENSE for more information.