Skip to content

Latest commit

 

History

History
65 lines (33 loc) · 2.07 KB

README.md

File metadata and controls

65 lines (33 loc) · 2.07 KB

Pyronear API

License: GPL v3 Codacy BadgeBuild Status codecov Docs

The building blocks of our wildfire detection & monitoring API.

Table of Contents

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/pyronear-api.git
pip install -r pyronear-api/src/requirements.txt

Usage

If you wish to deploy this project on a server hosted remotely, you might want to be using Docker containers. You can perform the same 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.