This project links your Spotify album library to a Notion database, and allows you to perform some operations on any album database you may have in Notion.
This project includes both a web app for importing albums from Spotify to Notion and a CLI (command line interface) app for performing various operations on an album database in Notion. The code for the web app can be found in the server.ts file, and the code for the CLI app can be found in the jobs.ts file.
The web app supports the following operations between a linked Spotify library and a Notion Database:
- Loading albums from a Spotify library
- Importing loaded albums into a Notion database
- The importing job creates columns for an Album's Name, Artist, Spotify ID, Spotify URL, the date it was saved to the user's Spotify libary, and Genre.
The CLI app supports the following cleanup operations on a Notion Album Database:
- Inferring the missing artist names of Albums From their Album Names
- Populating the Spotify Album IDs of albums without them
- Updating Album Pages With Album Art
- Remove Duplicate Albums By Album Properties
For this project to work, you should have a notion database that has (at least) a title column for an Album Name, and another text column for the album artist.
- Right now, these columns should be called "Album Name" and "Artist" respectively when importing albums from Spotify to Notion, but they can be changed to different names when running the CLI app.
- Each row of the database corresponds to an album.
- When running certain jobs, the code will also optionally look for column names:
- When removing duplicate albums, the code will optionally look for a "Rating" column on an album page and prioritize keeping the same album with a rating.
- When filtering albums on the web app, the code will look for an "Include in Spotify" boolean formula column to decide what albums to keep/remove in your spotify library.
You should also have Node installed.
To start, create an .env file at the root of your directory and add keys for the following properties:
NOTION_TOKEN={Your Notion Integration Secret}
DATABASE_ID={Notion Album Database ID}
SPOTIFY_CLIENT_ID={Spotify App Client ID}
SPOTIFY_CLIENT_SECRET={Spotify App Client Secret}
Then, run npm install to install dependencies, and depending on what you want to do, execute different commands:
To execute various cleanup jobs on a Notion Album Database, use the CLI app.
To run the CLI app, execute npm run jobs. You can then select and run the desired job from the command line interface.
Importing Spotify Albums into Notion is done via a web app, because of the need to use a browser to authenticate with the Spotify API. To use the web app, its frontend code needs to be bundled:
Run npm run bundle to bundle the TypeScript code for running the app.
Once it's finished bundling, you can choose the run the web app from either an HTTP or HTTPS server. Note that if you're trying to run the web app without using localhost, you'll need to run the web app from an HTTPS server for Spotify to allow you to authenticate.
NOTE: This is the recommended way to run the web app.
Running the web app via an HTTP server doesn't require any extra work. Just run npm run server to start the server, and then navigate to http://localhost:3000 to start the web app.
NOTE: I wouldn't recommend trying to run the web app this way unless you're trying to set up the web app on some sort of external device (like a Raspberry Pi) and you want to connect to the app via an IP address.
Running the web app via an HTTPS server requires you to create a self-signed OpenSSL certificate.
Installing OpenSSL on Windows may require some extra steps, check out this stackoverflow answer for details.
On Linux, you should be able to use whatever package manager you have to install OpenSSL if it's not already installed. (i.e. sudo apt-get install openssl for Ubuntu)
On Mac, you should be able to use Homebrew to install OpenSSL if it's not already installed. (i.e. brew install openssl)
In a new directory called cert (made at the root of the project), run
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 365
and follow the prompts to generate a self-signed certificate that lasts for 365 days (feel free to extend/shorten the duration if you want). This will generate key.pem (private key) and cert.pem (certificate) files.
Then, in the .env file at the root directory, add the certificate password you chose as a key:
...
CERT_PASSPHRASE={Your Certificate Password}
If done right, when starting the server using npm run server, you should be able to navigate to https://localhost:3000 to start the web app. You will likely have to trust the certificate in your browser to be able to access the web app.
When using the web app, first click the "Sign in with Spotify" button to get a Spotify API token. You'll then see the populated token in the web app.
From there, click the "Load Spotify Albums" button to load the saved albums from your Spotify library into the app.
After loading the albums, you can click the "Import Albums into Notion" button to import the loaded albums into your Notion database or click the "Sign Out" button to sign out of the app.
The web app will automatically log the output of its servers to the console and to files in the logs directory. If you want to log the output of the web app to Logtail/Better Stack, add the following line to your .env file:
LOGTAIL_SOURCE_TOKEN={Your Logtail Source Token}
Much of the usefulness of this project comes from the ability to schdeul jobs to run on a regular basis. By scheduling these jobs, you can log in to the web app once and let the app continually run integrations between your Spotify Library and Notion Album Database.
To use these jobs:
-
follow the web app instructions to start the web app.
-
After starting the web app, sign into Spotify (you don't need to load any albums).
-
From there, you can schedule the following jobs using the form on the webpage:
- Importing Spotify Albums into Notion
- Updating outdated/stale albums in your Notion Album Database
- Filtering your Spotify Library based on your Notion Album Database
-
After choosing your desired jobs, click the "Start Cron Jobs" button to start the jobs.
To stop the jobs, click the "Stop Cron Jobs" button. You can also see the current job settings on the web app page.