1️⃣ API end points for DJ-Helper app

You can find the project at https://www.dj-helper.com/.

2️⃣ Contributors

Evgenii Dudeiko

Project Overview

1️⃣ Trello Board

1️⃣ Product Canvas

DJ-helper is a web and IOS application designed to help a DJ get suggestions based on the songs requested by the event audience, so that he can create a playlist that the audience is very likely to like. Before and during the event guests will submit music requests. With the help of machine learning the application will take those requests and create a unique playlist. The DJ can select songs and add them to their set. The application will also function in real time during the event and adjust to any changes in music trend that occur.

Tech Stack

Python, Dash, Spotipy, Spotify API, Heroku, Plotly

2️⃣ Predictions

DJ helper uses an unsupervised k-neighbors model to predict similar songs. The model uses spotify's api to obtain a list of similar artists and then uses the audio features spotify provides to find the closest sounding track.

2️⃣ Explanatory Variables

• acousticness
• danceability
• energy
• instrumentalness
• liveness
• loudness
• speechiness
• tempo

Data Sources

• Spotify_API
• Spotipy

Python Notebooks

Notebooks

3️⃣ How to connect to the data API

• Search for songs https://sp-search.herokuapp.com/track_search_ready/{text}

• Search for songs with audio features https://sp-search.herokuapp.com/audio_features/{text}

• Find similar songs https://sp-search.herokuapp.com/predict/{track_id}

Heroku

• Check the directory first
• Create file requirement text by using 'pip freeze > requirements.txt'
• pipenv shell
• heroku login
• git remote -v
• git push heroku master

Debug mode

• heroku run bash
• ---> ls -al
• ---> exit
• heroku config
• heroku config:set SPOTIFY_CLIENT_ID="---------------"
• heroku config:set SPOTIFY_CLIENT_SECRET="---------------"
• heroku config # > to check on the changes

Important

• Add your heroku app name to the spotify app --> dashboard --> redirect URIs

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See [Backend Documentation](link to your backend readme here) for details on the backend of our project.

See [Front End Documentation](link to your front end readme here) for details on the front end of our project.