The API for the Sticky Pi project

main branch:

develop branch:

---

Project organisation:

• src a Python package (sticky_pi_api) that defines the API and its client. Complete documentation of the client and the api is available on our website.

• server a docker-based server, deployed using docker-compose. Complete documentation here. Contains the following services:

  • db the database (MySQL)
  • api a flask server that instantiates our API and routes entry points
  • rshiny a webtool to visualise the data
  • s3 an (optional) s3 server to store and serve resources such as images (can set a remote S3 server instead)
  • nginx an server to route trafic, set subdomains, etc