Pyronear API

The building blocks of our wildfire detection & monitoring API.

Quick Tour

Running/stopping the service

You can run the API containers using this command:

make run

You can now navigate to http://localhost:8080/docs to interact with the API (or do it through HTTP requests) and explore the documentation.

In order to stop the service, run:

make stop

Installation

Prerequisites

• Git
• Docker
• Docker compose

Starting your service

1 - Clone the repository

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

2 - Set your environment variables

First copy the example environment setup

cp .env.example .env

3 - Start the services

docker compose pull
docker compose up

4 - Check how what you've deployed

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

More goodies

Python client

This project is a REST-API, and you can interact with the service through HTTP requests. However, if you want to ease the integration into a Python project, take a look at our Python client.

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.