jisaacso219 commited on
Commit
12d5303
·
verified ·
1 Parent(s): fc0231b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +52 -10
README.md CHANGED
@@ -1,13 +1,55 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: RNG Shuffle
3
- emoji: 🔥
4
- colorFrom: pink
5
- colorTo: indigo
6
- sdk: gradio
7
- sdk_version: 5.34.2
8
- app_file: app.py
9
- pinned: false
10
- short_description: RNG based playlist shuffle
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
1
+ # 🎶 RNG Shuffle - Spotify Playlist Shuffler
2
+
3
+ Welcome to **RNG Shuffle**, a Spotify-powered playlist shuffler that lets you:
4
+
5
+ - Log in with your own Spotify account
6
+ - Select one of your personal playlists
7
+ - Shuffle the tracks using a random algorithm
8
+ - Start playback on your active Spotify device
9
+
10
+ This app works across desktop and mobile via Spotify Connect.
11
+
12
+ ---
13
+
14
+ ## 🚀 How to Use
15
+
16
+ 1. Click **“Log in to Spotify”**
17
+ 2. You'll be redirected to Spotify’s login page — log in and authorize the app
18
+ 3. Return to this app (you'll see a success message)
19
+ 4. Click **“Load My Playlists”** to fetch your playlists
20
+ 5. Choose a playlist and hit **“Shuffle + Play”**
21
+ 6. Playback begins on your Spotify device (must be active!)
22
+
23
+ ---
24
+
25
+ ## 🛠 Developer Notes
26
+
27
+ This app is powered by:
28
+ - [Gradio](https://www.gradio.app/) for the UI
29
+ - [Spotipy](https://spotipy.readthedocs.io/) for Spotify API integration
30
+ - [Flask](https://flask.palletsprojects.com/) for handling the `/callback` OAuth redirect
31
+
32
+ You must register a [Spotify Developer App](https://developer.spotify.com/dashboard) and set the following redirect URI:
33
+ https://jisaacso219-rng-shuffle.hf.space/callback
34
+
35
+ Then add your Spotify credentials as **repository secrets** in Hugging Face:
36
+ - `SPOTIFY_CLIENT_ID`
37
+ - `SPOTIFY_CLIENT_SECRET`
38
+
39
  ---
40
+
41
+ ## 💡 Tips
42
+
43
+ - Your Spotify app **must be open** and playing on a device (phone, browser, etc.)
44
+ - This version supports **single-user login per session**
45
+ - For multiple users or persistent tokens, OAuth session handling would need to be extended
46
+
 
 
47
  ---
48
 
49
+ ## 📄 License
50
+
51
+ This project is for educational and personal use. Not affiliated with Spotify.
52
+
53
+
54
+
55
+