spotipy/README.md
2020-01-11 23:30:57 +00:00

54 lines
1.4 KiB
Markdown

# Spotipy - a Python client for The Spotify Web API
## Description
Spotipy is a thin client library for the Spotify Web API.
## Documentation
Spotipy's full documentation is online at [Spotipy Documentation](http://spotipy.readthedocs.org/).
## Installation
If you already have [Python](http://www.python.org/) on your system you can install the library simply by downloading the distribution, unpack it and install in the usual fashion:
```bash
python setup.py install
```
You can also install it using a popular package manager with
```bash
pip install spotipy
```
or
```bash
easy_install spotipy
```
## Dependencies
- [Requests](https://github.com/kennethreitz/requests) - spotipy requires the requests package to be installed
## Quick Start
To get started, simply install spotipy, create a Spotify object and call methods:
```python
import spotipy
sp = spotipy.Spotify()
results = sp.search(q='weezer', limit=20)
for i, t in enumerate(results['tracks']['items']):
print ' ', i, t['name']
```
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).
## Reporting Issues
If you have suggestions, bugs or other issues specific to this library, file them [here](https://github.com/plamere/spotipy/issues). Or just send me a pull request.