Skip to content

Commit

Permalink
Clean-Up README
Browse files Browse the repository at this point in the history
  • Loading branch information
Prem-ium committed Jan 7, 2024
1 parent b505533 commit 46c7257
Showing 1 changed file with 5 additions and 26 deletions.
31 changes: 5 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
## Features
- Generate Top Tracks Playlist that auto-updates!
- Generate List of Top Played Artists
- Optional Apprise Alerts/Notifications upon Program Execution/Playlist Update
- GitHub Actions
- Generate Reccomended Tracks Playlists (Optional)
- Optional Apprise Alerts/Notifications
- GitHub Actions Support
- Docker Support
- Google Sheets Compatiable.
- Keep_Alive Flask Server
- Docker Support (In Addition to Docker Quickstart Bat File)
- Optional Recommended Tracks & Artists (Seperate Playlist)

## Environment Variables
To run this project, you will need to add the following environment variables to your .env file (see .env.example for a reference):
Expand All @@ -39,7 +39,6 @@ To run this project, you will need to add the following environment variables to
| `GSPREAD_KEYS` | Your Google Service Account JSON contents obtained via OAuth 2.0 Client ID in Credentials of Google Cloud API. | - |



## Setup
#### Spotify Developer Credentials (Required)
1. Head over to [Spotify Developer's Dashboard](https://developer.spotify.com/dashboard/). Login or create an account using your Spotify.
Expand All @@ -58,17 +57,6 @@ To run this project, you will need to add the following environment variables to
6. Copy the cache JSON contents and assign it to the `AUTH_CACHE` variable within GitHub Secrets.
7. Adjust the cron job if necessary.

<details>
<summary>Replit (Free Version Depreciated)</summary>
Note: In January 2024, Replit has discontinued support for Always On & Free Hosting.
1. Login/Create a [Replit](https://replit.com/) account and create a new Python repl.
2. Setup .env within Replit's Secret tab (set `KEEP_ALIVE` to True) & go through [Installation](#installation). Optionally, move all files out of folder for ease of navigation, replace empty/old main.py.
3. Run the program and copy URL in the Flask webview. It should be something similar to:
`https://{Name of Repl}.{Repl username}.repl.co/`
4. Create an account on [Uptime Robot](https://uptimerobot.com/), Click 'Add New Monitor',HTTP monitor type, name the monitor anything you'd like, paste your copied link into URL, set interval to 5 minutes, timeout to 30 seconds, and create the monitor.
5. Rerun the repl program. The repl should stay on 24/7! Your playlist will continue to be updated at no computer resource cost to you!
</details>

### Google Sheets/GSpread (Optional)
1. Sign into [Google Cloud Console](https://console.cloud.google.com/), create your APP,Enable Google Sheets and Google Drive APIs.
3. Head to API & Services -> Credentials -> Create Credentials -> Service Account. Go through the prompts & download the JSON file afterwards.
Expand Down Expand Up @@ -102,15 +90,11 @@ Finally, you're ready to run the script!
docker run -it --env-file ./.env --restart unless-stopped --name spotify-wrapped spotify-wrapped
```


5. Let the bot log in and begin working. DO NOT PRESS `CTRL-c`. This will kill the container and the bot. To exit the logs view, press `CTRL-p` then `CTRL-q`. This will exit the logs view but let the bot keep running.


## License

This repository is using the [MIT](https://choosealicense.com/licenses/mit/) license.


## 🎧 What I've been listening to

[<img src="covers/short_term.jpg" style="width:30%;height:30%;">](https://open.spotify.com/playlist/41FgHkzQ2wf4v8MtoITL77?si=c4c016d8bdbf411a) [<img src="covers/medium_term.jpg" style="width:30%;height:30%;">](https://open.spotify.com/playlist/657cuGMmf1CnJEeMhfwgnK?si=154abf33ddd64a20) [<img src="covers/long_term.jpg" style="width:30%;height:30%;">](https://open.spotify.com/playlist/42TRuidms91LuMajAIu5xI?si=8a22e2ccb6b9445f)
Expand All @@ -128,9 +112,4 @@ If you appreciate my work and would like to show your support, there are two con
- [Donate via Buy Me A Coffee](https://www.buymeacoffee.com/prem.ium)
- [![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/prem.ium)

Your generous donations will go a long way in helping me cover the expenses associated with developing new features and promoting the project to a wider audience. I extend my heartfelt gratitude to all those who have already contributed. Thank you for your support!

## Final Remarks
How to Get Spotify Wrapped. 365 days a year. While everyone else google searches 'how to see / check / find spotify wrapped' you'll have access to your top played tracks and artists all year long!

Beyond that, thank you for your interest in this repository. Please leave a 🌟 & share with your friends!
Your generous donations will go a long way in helping me cover the expenses associated with developing new features and promoting the project to a wider audience. I extend my heartfelt gratitude to all those who have already contributed. Thank you for your support!

0 comments on commit 46c7257

Please sign in to comment.