spotipy/README.md

71 lines
2.8 KiB
Markdown
Raw Normal View History

2014-08-22 16:10:48 +00:00
# Spotipy - a Python client for The Spotify Web API
2014-04-05 13:12:01 +00:00
## Description
2014-08-22 16:10:48 +00:00
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/)
2014-04-05 13:12:01 +00:00
## Installation
2014-08-22 16:10:48 +00:00
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:
2014-04-05 13:12:01 +00:00
python setup.py install
2014-06-16 17:38:47 +00:00
You can also install it using a popular package manager with
2014-08-25 21:30:31 +00:00
`pip install spotipy`
2014-06-16 17:38:47 +00:00
or
2014-08-25 21:30:31 +00:00
`easy_install spotipy`
2014-06-16 17:38:47 +00:00
2014-04-05 13:12:01 +00:00
## Dependencies
- [Requests](https://github.com/kennethreitz/requests) - spotipy requires the requests package to be installed
## Quick Start
2014-08-22 16:10:48 +00:00
To get started, simply install spotipy, reate a Spotify object and call methods:
2014-04-05 13:12:01 +00:00
2014-08-22 16:10:48 +00:00
import spotipy
2014-04-05 13:12:01 +00:00
sp = spotipy.Spotify()
2014-08-22 16:10:48 +00:00
results = sp.search(q='weezer', limit=20)
for i, t in enumerate(results['tracks']['items']):
2014-04-05 13:12:01 +00:00
print ' ', i, t['name']
2014-08-22 16:10:48 +00:00
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).
2014-04-05 13:12:01 +00:00
## Reporting Issues
2014-08-22 16:10:48 +00:00
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.
2014-04-05 13:12:01 +00:00
## Version
- 1.0 - 04/05/2014 - Initial release
2014-05-18 11:08:51 +00:00
- 1.1 - 05/18/2014 - Repackaged for saner imports
2014-06-17 17:29:33 +00:00
- 1.4.1 - 06/17/2014 - Updates to match released API
2014-06-21 22:20:40 +00:00
- 1.4.2 - 06/21/2014 - Added support for retrieving starred playlists
- v1.40, June 12, 2014 -- Initial public release.
- v1.42, June 19, 2014 -- Removed dependency on simplejson
- v1.43, June 27, 2014 -- Fixed JSON handling issue
2014-08-20 20:35:05 +00:00
- v1.44, July 3, 2014 -- Added show tracks.py example
- v1.45, July 7, 2014 -- Support for related artists endpoint. Don't used cache auth codes when scope changes
- v1.49, July 23, 2014 -- Support for "Your Music" tracks (add, delete, get), with examples
2014-08-20 20:35:05 +00:00
- v1.50, August 14, 2014 -- Refactored util out of examples and into the main package
- v1.301, August 19, 2014 -- Upgraded version number to take precedence over previously botched release (sigh)
- v1.310, August 20, 2014 -- Added playlist replace and remove methods. Added auth tests. Improved API docs
2014-08-22 16:10:48 +00:00
- v2.0 - August 22, 2014 -- Upgraded APIs and docs to make it be a real library
2014-08-25 21:49:00 +00:00
- v2.0.2 - August 25, 2014 -- Moved to spotipy at pypi
2014-10-25 10:46:04 +00:00
- v2.1.0 - October 25, 2014 -- Added support for new_releases and featured_playlists
2014-11-15 12:23:47 +00:00
- v2.2.0 - November 15, 2014 -- Added support for user_playlist_tracks
2015-01-05 19:58:03 +00:00
- v2.3.0 - January 5, 2015 -- Added session support added by akx.
2015-04-01 14:16:02 +00:00
- v2.3.2 - March 31, 2015 -- Added auto retry logic
2015-04-01 14:21:56 +00:00
- v2.3.3 - April 1, 2015 -- added client credential flow
2015-04-28 11:17:10 +00:00
- v2.3.5 - April 28, 2015 -- Fixed bug in auto retry logic