mirror of
https://github.com/spotipy-dev/spotipy.git
synced 2026-06-19 01:03:53 +00:00
d0ca977647
* Made cache_path and username optional * Update readme and example * Lint * Lint * Feedback / add warning
72 lines
2.3 KiB
Markdown
72 lines
2.3 KiB
Markdown
# Spotipy
|
||
|
||
##### A light weight Python library for the Spotify Web API
|
||
|
||
 [](https://spotipy.readthedocs.io/en/latest/?badge=latest)
|
||
|
||
## Documentation
|
||
|
||
Spotipy's full documentation is online at [Spotipy Documentation](http://spotipy.readthedocs.org/).
|
||
|
||
## Installation
|
||
|
||
```bash
|
||
pip install spotipy
|
||
```
|
||
|
||
or upgrade
|
||
|
||
```bash
|
||
pip install spotipy --upgrade
|
||
```
|
||
|
||
## Quick Start
|
||
|
||
A full set of examples can be found in the [online documentation](http://spotipy.readthedocs.org/) and in the [Spotipy examples directory](https://github.com/plamere/spotipy/tree/master/examples).
|
||
|
||
To get started, install spotipy and create an app on https://developers.spotify.com/.
|
||
Add your new ID and SECRET to your environment:
|
||
|
||
### Without user authentication
|
||
|
||
```python
|
||
import spotipy
|
||
from spotipy.oauth2 import SpotifyClientCredentials
|
||
|
||
sp = spotipy.Spotify(auth_manager=SpotifyClientCredentials(client_id="YOUR_APP_CLIENT_ID",
|
||
client_secret="YOUR_APP_CLIENT_SECRET"))
|
||
|
||
results = sp.search(q='weezer', limit=20)
|
||
for idx, track in enumerate(results['tracks']['items']):
|
||
print(idx, track['name'])
|
||
```
|
||
|
||
### With user authentication
|
||
|
||
```python
|
||
import spotipy
|
||
from spotipy.oauth2 import SpotifyOAuth
|
||
|
||
sp = spotipy.Spotify(auth_manager=SpotifyOAuth(client_id="YOUR_APP_CLIENT_ID",
|
||
client_secret="YOUR_APP_CLIENT_SECRET",
|
||
redirect_uri="YOUR_APP_REDIRECT_URI",
|
||
scope="user-library-read"))
|
||
|
||
results = sp.current_user_saved_tracks()
|
||
for idx, item in enumerate(results['items']):
|
||
track = item['track']
|
||
print(idx, track['artists'][0]['name'], " – ", track['name'])
|
||
```
|
||
|
||
## Reporting Issues
|
||
|
||
For common questions please check our [FAQ](FAQ.md).
|
||
|
||
You can ask questions about Spotipy on
|
||
[Stack Overflow](http://stackoverflow.com/questions/ask).
|
||
Don’t forget to add the *Spotipy* tag, and any other relevant tags as well, before posting.
|
||
|
||
If you have suggestions, bugs or other issues specific to this library,
|
||
file them [here](https://github.com/plamere/spotipy/issues).
|
||
Or just send a pull request.
|