Skip to content

Commit 8e18a68

Browse files
committed
Update README
1 parent ca9bde6 commit 8e18a68

1 file changed

Lines changed: 35 additions & 2 deletions

File tree

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,43 @@ For a sample usage of the script, run
6161
python3 run.py
6262
```
6363

64+
### Prompting for Playlists
65+
66+
Custom user prompts can be provided in a way that they will complete the following sentence:
67+
`"Provide a playlist containing songs..."`
68+
```
69+
python3 run.py --PROMPT "falling under the genre downtempo and trip-hop"
70+
```
71+
72+
This will create the playlist and save it with a ChatGPT-generated name. If you instead would like to save it with a custom name, this can be provided with `--PLAYLIST_NAME` flag.
73+
74+
**Note:** Using this option will **NOT** use or share your previously listened artists with ChatGPT.
75+
76+
### Prompting for Playlists with User Data / Listening History
77+
78+
If you would like to share your previously listened artists and get playlists with new artist recommendations, simply use:
79+
```
80+
python3 run.py --USER_DATA True --TERM long_term --TOP_GENRE 1
81+
```
82+
83+
This will create playlist that are similar to but (mostly) not including your top-listened artists in the past years. The time range (term) and top genre selection can be made in the following way:
84+
85+
```
86+
--TERM "long_term" # past years
87+
"medium_term # past 6 months
88+
"short_term # past 4 weeks
89+
90+
--TOP_GENRE 1 # top (most-listened) genre
91+
2 # second most listened genre
92+
3 # third most listened genre
93+
```
94+
95+
**Note:** If you would like to have better quality predictions, try executing `pkill firefox` and then `chatgpt install` once in a while.
96+
6497
## Examples
6598

99+
Feel free to plug and play!
100+
66101
```
67102
play = SpotifyPlaylist()
68103
```
@@ -97,6 +132,4 @@ You can also ask the reasoning behind this playlist by asking the common element
97132
play.ask_chatgpt(prompt="What is the common theme, musical elements or features in this playlist? Explain in detail.")
98133
```
99134

100-
**Note:** If you would like to have better quality predictions, try executing `pkill firefox` and then `chatgpt install` once in a while.
101-
102135
Enjoy your new playlists!

0 commit comments

Comments
 (0)