This is a Spotistats integration for building customizable song charts. Currently, only creating song charts is avaliable, due to some complications that Spotistats has with album versions.
Please Note: Only accounts with Spotistats Plus AND their files imported work, as all other accounts don't display stream counts, which the system needs to work correctly.
This is the explaining to anyone how-to guide, so if you know how to run a program, skip to the other How to Use section.
(1) This is code that runs on your computer, so to run it, you have to download it first. Click on the green button in the top right corner, and then select "Download ZIP", which will download a compressed copy of the script onto your computer. Find the zipped folder in your file discovery system on your computer and move the inner folder (which should be named "levboard-main") out of the zipped folder.
(2) Find / update your Spotistats username. They are automatically set to whatever Spotify auto-generates your username to be, but they are unwieldy. Navigate to the Spotistats account page, sign into your account, and change your custom url to something nice. You'll need it soon to run the program.
(3) In order to run the files, your computer needs to have Python (the language the program is written in) installed. Download it from the official Python website, and follow any instructions. Make sure that you download either the version called "Python 3.9" or "Python 3.10", as older versions may not work properly.
(4) The program requires code from outside the system for it to work, and it's installed using the pip program that comes with Python. The first command updates your pip program, and the second will install the outside code needed for the program. Open up Command Prompt (on Windows) or Terminal (on Mac) and type in the first line, hit enter, and then type in the second line and hit enter again. The system should show that it is installing and updating pip and the programs needed for levboard to run.
python -m pip install --upgrade pip
pip install -r requirements.txt (5a) Navigate to where you moved the file inside of your command line tool. I saved the program files to the Documents folder, so move to there, and into the levboard-main folder as well. The command tool should display levboard-main as the last folder in your path on the left, as shown on the second line.
C:\your\path> cd Documents\levboard-main
C:\your\path\Documents\levboard-main>(5b) From there, execute the main.py program from the command line tool. When using the program for the first time, you need to specify your Spotistats username from step 2. Afterwards, it's not necessary, as the program will save your username.
C:\your\path\Documents\levboard-main> python main.py lev(5c) The program also accepts a third option, specifying if you want the songs to be lazily named or not. Running the program as python main.py {username} f will prompt you to name all the songs. Running the program later with python main.py {username} t(or any other letter at the end) will revert to lazy naming and will not prompt you to name any of the new songs. If you want to configure settings manually, you can change them in the data/settings.json file.
C:\your\path\Documents\levboard-main> python main.py lev f(6a) When prompted for a song name, type in the name that you wanted the song to be called at the prompt.
Song Secret Love Song (feat. Jason Derulo) (283072) not found.
Find the link here -> https://stats.fm/track/283072
What should the song be called in the database? Secret Love Song
(6b) If you press enter without giving a name, it will name the song whatever it already has displayed for you (the same as lazy naming the songs.)
Song Yikes (163325) not found.
Find the link here -> https://stats.fm/track/163325
What should the song be called?
(6c) There is also a merge option to merge two track ids together into one song. To merge a new track into an already existing one on the system, type in merge. Then, specify the song id of the track to merge into, which you can find by going to the data\songs.json file and then searching for the song title using any word processing tool, like Notepad, and they will be merged into one song. (This is helpful if a song has multiple names that are one song, like a remastered and original version.)
Song Bad - 2012 Remastered (1016605) not found.
Find the link here -> https://stats.fm/track/1016605
What should the song be called in the database? merge
Id of the song to merge with: 43009
Sucessfully merged Bad - 2012 Remastered into Bad
(7) While the program is running, it should display your data for your song weeks like this. Don't close the command line terminal, it should take around a minute or two to comb through all your weeks.
(2) Week of 2021-05-26 to 2021-06-09
MV | Title | Artists | TW | LW | OC | PLS | PK
▲39 | I Would | One Direction | 1 | 40 | 2 | 6 | 1
NEW | We Are Never Ever Getting Back Together | Taylor Swift | 1 | - | 1 | 6 | 1
NEW | Domino | Jessie J | 3 | - | 1 | 5 | 3
NEW | Neon Lights | Demi Lovato | 3 | - | 1 | 5 | 3
(8) Once it's done, it will create a songs.csv file in the root directory of the package. Load them into your favorite spreadsheet processing tool & enjoy your data. (Select "Split Text to Columns" after copy & pasting it if using Google Sheets.)
(9) Once you have ran the main.py program, you can also run the stats.py program located in the same directory, and it will display various stats about your songs, including your top songs all time (do this by running the first command.) I suggest sending the output to a text file so you can read it later (by running the second command in the same directory).
python stats.py
python stats.py > info.txtThis is for people who have done some surface-level programming and understand how running a program works.
(1) Clone the repository onto your machine. (Click on "Clone" and then either "Open in Github Desktop" or "Download ZIP", whichever you like better.) If you downloaded the ZIP folder version, make sure to un-compress it, or else it won't work.
(2) Find your Spotistats username. They are automatically set to whatever Spotify auto-generates your username to be, but they are unwieldy. Navigate to the Spotistats account page, sign into your account, and change your custom url to something nice. Remember it for later on in the process.
(3) If you don't have Python downloaded already, install it from the official Python website. The program is written in Python 3.9, so it or any later release will work.
(4) Install dependencies with pip through a command terminal. It's recomended to always upgrade your pip before downloading anything new, and then download the three non-standard library dependencies of levboard from the requirements.txt file.
python -m pip install --upgrade pip
pip install -r requirements.txt (5a) Navigate to the root directory of this package, and then run the main.py file. When using the program for the first time, you will need to specify your Spotistats username that you created in part 2 (example one.)
python main.py lev(5b) The program also accepts a third argument, specifying if you want the songs to be lazily named or not. Running the program as python main.py {username} f will prompt you to name all the songs (example two.) Running the program later with python main.py {username} t(or any other letter at the end) will revert to lazy naming and will not prompt you to name any of the new songs. If you want to configure settings manually, you can change them in the data/settings.json file.
python main.py lev f(6a) When prompted for a song name, type in the name that you wanted the song to be called at the prompt.
Song Secret Love Song (feat. Jason Derulo) (283072) not found.
Find the link here -> https://stats.fm/track/283072
What should the song be called in the database? Secret Love Song
(6b) If you press enter without giving a name, it will name the song whatever it already has displayed for you (the same as lazy naming the songs.)
Song Yikes (163325) not found.
Find the link here -> https://stats.fm/track/163325
What should the song be called?
(6c) There is also a merge option to merge two track ids together into one song. To merge a new track into an already existing one on the system, type in merge. Then, specify the song id of the track to merge into, which you can find by going to the data\songs.json file and then searching for the song title using any word processing tool, like Notepad, and they will be merged into one song. (This is helpful if a song has multiple names that are one song, like a remastered and original version.)
Song Bad - 2012 Remastered (1016605) not found.
Find the link here -> https://stats.fm/track/1016605
What should the song be called in the database? merge
Id of the song to merge with: 43009
Sucessfully merged Bad - 2012 Remastered into Bad
(7) While the program is running, it should display your data for your song weeks as shown in the example below. Don't close the command line terminal, it should take around a minute or two to comb through all your weeks.
(2) Week of 2021-05-26 to 2021-06-09
MV | Title | Artists | TW | LW | OC | PLS | PK
▲39 | I Would | One Direction | 1 | 40 | 2 | 6 | 1
NEW | We Are Never Ever Getting Back Together | Taylor Swift | 1 | - | 1 | 6 | 1
NEW | Domino | Jessie J | 3 | - | 1 | 5 | 3
NEW | Neon Lights | Demi Lovato | 3 | - | 1 | 5 | 3
(8) Once it's done, it will create a songs.csv file in the root directory of the package. Load them into your favorite spreadsheet processing tool & enjoy your data. (Select "Split Text to Columns" after copy & pasting it if using Google Sheets.)
(9) Once you have ran the main.py program, you can also run the stats.py program located in the same directory, and it will display various stats about your songs, including your top songs all time. I suggest sending the output to a text file so you can read it later.
python stats.py
python stats.py > info.txtIf you have any issues with the code, feel free to ask me over on my charts twitter where I post the charts created from the experimental version of this program. I love them and am currently working on making albums work for people other than me. If you want to help me crowdsource that data or want to contribute to it let me know, your help would be greatly appreciated.