/octopus-api

Wouldn't you like to know

Primary LanguagePython

Code Coverage Unit Tests

Octopus API

Instructions

Prerequisites

Prior to running the project please install Docker.

The following environment variables should be set:

  • CLIENT_ID - Spotify Client ID
  • CLIENT_SECRET - Spotify Secret ID

Running the API

The API is run in an Docker container. The base image is moderately sized so spinning up the container the first time might take some time. For simplicity's sake just run:

docker-compose up --build api

Docker will spin up the API and listen on localhost:5000.

NOTE:

  • Avoid directly running with Python as the API relies on Redis as a key-value store across it's multiple threads.
  • If for some reason the Initializing API message prints multiple times, consult your nearest God/Goddess