Skip to content

Commit

Permalink
GitHub Actions Description
Browse files Browse the repository at this point in the history
  • Loading branch information
@Prem-ium
Prem-ium authored Jan 6, 2024
1 parent 66753ac commit 8beb61d
Showing 1 changed file with 22 additions and 23 deletions.
45 changes: 22 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
- Generate Top Tracks Playlist that auto-updates!
- Generate List of Top Played Artists
- Optional Apprise Alerts/Notifications upon Program Execution/Playlist Update
- Google Sheets Compatiable.
- GitHub Actions
- Google Sheets Compatiable.
- Keep_Alive Flask Server
- Docker Support (In Addition to Docker Quickstart Bat File)
- Optional Recommended Tracks & Artists (Seperate Playlist)
Expand Down Expand Up @@ -50,16 +50,26 @@ To run this project, you will need to add the following environment variables to
5. Copy/paste Client ID into `CLIENT_ID` and Secret Client ID into `SECRET_CLIENT_ID` within your .env file.
<img src="https://user-images.githubusercontent.com/80719066/202246004-f7307806-69ec-4489-975b-beb71e6637b3.png" style="width: 50%;"></img>

#### Replit (~~Optional, Recommended~~, Depreciated)
### GitHub Actions
1. Fork the repository and start configuring your `.env` by navigating to your Forked Repository Settings: `Settings -> Security -> Secrets & Variables -> Actions -> New Repository Secret`.
3. Enable `GITHUB_ACTIONS` by assigning the value of `True` within your `.env`.
4. Run `main.py`, click the URL in the console, and approve the ticket for your account.
5. Copy the URL after approving permissions, paste it into the console, and hit enter.
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)
### 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.
5. Open Google Sheets and create a new file named 'Wrapped365'. Add tabs named 'short_term', 'medium_term', 'long_term', 'short_term Artists', 'medium_term Artists', and 'long_term Artists'
Expand Down Expand Up @@ -107,31 +117,20 @@ This repository is using the [MIT](https://choosealicense.com/licenses/mit/) lic

## Donations
I've been working on this project for a few months now, and I'm really happy with how it's turned out. It's also been a helpful tool for users to earn some extra money with Bing Rewards. I'm currently working on adding new features to the script and working on other similar programs to generate passive income. I'm also working on making the script more user-friendly and accessible to a wider audience.
If you appreciate my work and would like to show your support, there are two convenient ways to make a donation:

I'm accepting donations through BuyMeCoffee or GitHub Sponsors. Any amount you can donate will be greatly appreciated.
1. **GitHub Sponsors**
- [Donate via GitHub Sponsors](https://github.com/sponsors/Prem-ium)
- This is the preferred donation method as you can place donations with no transaction fees & possibily receive perks for your donation.
- [![GitHub Sponsor](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/Prem-ium)

<div style="display: grid; grid-template-columns: 1fr 1fr; justify-content: center; gap: 10px;">
<div style="display: grid; justify-content: center;">
<span>Buy Me a Coffee:</span>
<a href="https://www.buymeacoffee.com/prem.ium" target="_blank">
<img src="https://raw.githubusercontent.com/Prem-ium/youtube-analytics-bot/main/output-examples/media/coffee-logo.png" alt="Buy Me A Coffee" style="height: 41px !important; width: 174px !important; box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important; -webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;">
</a>
</div>
<div style="display: grid; justify-content: center;">
<span>GitHub Sponsors:</span>
<a href="https://github.com/sponsors/Prem-ium" target="_blank">
<img src="https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA" alt="GitHub Sponsor" style="height: 41px !important; width: 174px !important; box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important; -webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;">
</a>
</div>
</div>

Your donations will help me to cover the costs of hosting the project, developing new features, and marketing the project to a wider audience.
Thank you for your support!
2. **Buy Me A Coffee**
- [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!

~~As previously mentioned however, I strongly recommend utilizing this repository using a service such as [Replit](https://replit.com/) & [UpTimeRobot](https://uptimerobot.com/) as they will allow you the program to run without any computer resource cost to you. ~~

Beyond that, thank you for your interest in this repository. Please leave a 🌟 & share with your friends!

0 comments on commit 8beb61d

Please sign in to comment.