coreybobco / setlistspy-api

Home Page:http://setlistspy.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Setlist Spy

Build Status Coverage Status

Setlist Spy is an API for searching DJ setlists to discover new music. Other music suggestion engines like Youtube tend to create feedback loops by overrelying on what else you have already played or what else other people who play the same music also play. In contrast, Setlist Spy lets you pick the minds of cratediggers to find new musical inspiration.

Features

  • Django 2.2 + Rest Framework API
  • PostgreSQL
  • Redis Cache
  • Dataset Built from MixesDB.com XML Dumps -- (As of August 2019, Mixesdb.com has removed XML export functionality from their mediawiki, deprecating this information retrieval method.)
  • Celery, Flower for Sanitizing Data and Seeding the DB -- flower.setlistspy.com
  • Silk for Query Monitoring / Tuning
  • React Frontend: coreybobco/setlistspy-web
  • Kubernetes Deployment for Google Cloud Platform
  • Travis CI
  • Sentry for Error Tracking

There are also a few API calls for statistics I find fascinating but have not had time to implement in the frontend yet. Here are a few examples:

Running Locally

...with Docker

docker-compose -f local.yml build
docker-compose -f local.yml up

...with Cloud SQL

Place your environment variables in .envs/production/.django and envs/production/.postgres

docker-compose -f production.yml build
docker-compose -f production.yml up

Seeding the Database

To populate the database, run:

./manage.py scrape_mixesdb --everything

Running the Tests

To run the tests, run:

./testrunner.sh

or to run a specific test case, run this, substituting the last part

./testrunner.sh setlistspy.app.tests.api.[TEST CASE].[TEST]

To import data locally, run

./import-db.sh [DB_FILE]

Kubernetes

In .config/gcloud/secrets, store your environment variables in cloudsql.txt and django.txt

About

http://setlistspy.com

License:MIT License


Languages

Language:Python 90.9%Language:Shell 5.8%Language:Dockerfile 3.2%