rico-backend

This is the source code for Rico, a Discord bot for exchanging notes and maintaining threads. It's written with Nextcord v2, and uses Spotipy for pulling rich metadata from Spotify for compatible notes.

Since the bot stores and reads data from the database, it's meant to be used in tandem with the backend. Therefore, when developing locally, it is recommended that one use Docker Compose to run all of Rico's parts together. Details are on the main Rico repository.

Local development

It is strongly recommended to use Docker Compose to run a local instance of the bot, with this repository's files mounted as a volume at /opt/app, so that you do not have to install Python 3.10 and all of the bot's dependencies manually, like so:

version: '3.8'
services:
  database:
    container_name: rico-db
    image: postgres:alpine
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=rico
    user: postgres
    volumes:
      - rico-db:/var/lib/postgresql/data
    healthcheck:
      test: ['CMD', 'pg_isready']
      interval: 1s
      timeout: 1s
      retries: 3
      start_period: 1s
    restart: always
  backend:
    container_name: rico-backend
    image: jareddantis/rico-backend:latest
    depends_on:
      database:
        condition: service_healthy
    healthcheck:
      test: ['CMD', 'curl', '-f', 'http://localhost:5000/health']
      interval: 1s
      timeout: 1s
      retries: 3
      start_period: 1s
  bot:
    container_name: rico-bot
    image: jareddantis/rico-bot:latest
    depends_on:
      backend:
        condition: service_healthy
    volumes:
      - .:/opt/app
  # frontend and proxy services here
volumes:
  rico-db:

But if you insist, create and enter a virtualenv using

python3 -m venv .virtualenv
source .virtualenv/bin/activate

or, if you're using pyenv,

# Make sure the virtualenv extension for pyenv is installed
pyenv virtualenv 3.10.5 rico-bot
pyenv shell rico-bot

then install all of the backend's dependencies using

pip install -r requirements.txt

Now create a config.yml file in the same directory as bot.py using this example.

Then run the backend using

python bot.py