SPOTIFY FRIEND SONG RECOMMENDATION TOOL

Discover Music, Share Joy, Connect Instantly

A Flask-based API that leverages the Spotify Web API for user authentication and song recommendations. The application uses a PostgreSQL(Supabase) database to store user data, recommendations, and OAuth tokens.

Features

• Spotify OAuth 2.0 Integration: Securely authenticate users via their Spotify accounts.
• Persistent Sessions: Keeps users logged in across sessions.
• Token Management: Automatically handles refreshing of expired access tokens.
• User Profile: Fetches and stores user profile information from Spotify.
• Chrome Extension: A companion browser extension to interact with the API from the browser.
• Song Recommendations:
  • Recommend songs to other users.
  • Get recommendations from other users.
  • Get recommendations based on an artist's genre.

Technologies

Built with the tools and technologies:

Prerequisites

• Python 3.8 or higher
• pip for package management
• A PostgreSQL database instance (the free tier from Supabase is a good option)
• A Spotify Developer account and an application to get API credentials.

Installation & Setup

Backend

1. Clone the repository

   bash git clone https://github.com/DammyAA7/song-recommendations.git cd song-recommendations

2. Create and activate a virtual environment

   bash python3 -m venv .venv source .venv/bin/activate # On macOS/Linux .venv\Scripts\activate.bat # On Windows

3. Install dependencies

   bash pip install -r requirements.txt

4. Set up Environment Variables

   Create a file named .env in the root of the project and add the following variables. These are essential for connecting to the database and the Spotify API.

   ```ini

   PostgreSQL Database URL

   DATABASEURL="postgresql://USER:PASSWORD@HOST:PORT/DATABASENAME"

   Spotify API Credentials

   SPOTIFYCLIENTID="yourspotifyclientid" SPOTIFYCLIENTSECRET="yourspotifyclientsecret" SPOTIFYREDIRECTURI="http://127.0.0.1:5000/callback"

   Flask Session Secret Key

   SESSIONSECRETKEY="astrongandrandomsecret_key" ```

   Note: For the SPOTIFY_REDIRECT_URI, make sure to add this exact URI to your Spotify application settings on the developer dashboard.

5. Database Setup

   The schema.sql file contains the necessary SQL commands to create the database tables. Connect to your PostgreSQL instance and run the script.

   bash psql -d YOUR_DATABASE_NAME -a -f schema.sql

6. Run the application

   bash flask run

   The server will run at http://127.0.0.1:5000/.

Chrome Extension

1. Open Chrome and navigate to chrome://extensions.
2. Enable Developer mode by toggling the switch in the top-right corner.
3. Click on the "Load unpacked" button.
4. Select the Extension folder from this project's directory.

API Endpoints

Authentication

• GET /login

  Initiates the Spotify authentication process. Returns a JSON object with the Spotify authorization URL.

• GET /callback

  The redirect URI after the user authorizes the application on Spotify. It exchanges the authorization code for an access token and refresh token, stores them, and fetches the user's profile.

• GET /check_auth

  Checks if the current user is authenticated. Requires a valid session cookie.

• POST /logout

  Logs the user out by clearing the session.

Recommendations

• PUT /recommend

  Recommends a song to another user. Requires a JSON body with user_id, friend_id, and song_id.

• GET /recommend/user/<user_id>

  Gets a list of songs recommended to a specific user.

• GET /recommend/artist/<song_id>

  Gets song recommendations based on the genre of the artist of the given song_id.

License

This project is released under the MIT License. Feel free to copy, modify, and share.