Pyronear API

The building blocks of our wildfire detection & monitoring API.

Table of Contents

• Pyronear API
  • Table of Contents
  • Getting started
    • Prerequisites
    • Installation
  • Usage
  • Documentation
  • Contributing
  • License

Getting started

Prerequisites

• Python 3.6 (or more recent)
• pip

Installation

You can clone and install the project dependencies as follows:

git clone https://github.com/pyronear/pyro-api.git
pip install -r pyro-api/requirements.txt

Usage

If you wish to deploy this project on a server hosted remotely, you might want to be using Docker containers. Beforehand, you will need to set a few environment variables either manually or by writing an .env file in the root directory of this project, like in the example below:

QARNOT_TOKEN=my_very_secret_token
BUCKET_NAME=my_storage_bucket_name
BUCKET_MEDIA_FOLDER=my/media/subfolder

Those values will allow your API server to connect to our cloud service provider Qarnot Computing, which is mandatory for your local server to be fully operational. Then you can run the API containers using this command:

PORT=8002 docker-compose up -d --build

Once completed, you will notice that you have a docker container running on the port you selected, which can process requests just like any django server.

Documentation

The full project documentation is available here for detailed specifications. The documentation was built with ReDoc.

Contributing

Please refer to CONTRIBUTING if you wish to contribute to this project.

License

Distributed under the GPLv3 License. See LICENSE for more information.