Skip to main content

A friendly wrapper library for the Deezer API

Project description

deezer-python

Build status Test coverage percentage Documentation Status PyPi Status Code Health

A friendly wrapper around the Deezer API.

Installation

The package is published on the Python index simply run the following:

pip install deezer-python

And that’s it!

Basic Use

So far you can only retrieve the data for the public objects, for which no login is required. The objects are translated to python resources, which are basically python objects encapsulating the json dictionary returned by the API.

>>> client = deezer.Client()
>>> client.get_album(12).title
u'Monkey Business'

You also can use AsyncClient with tornado.

>>> from tornado.gen import coroutine
>>> from tornado.ioloop import IOLoop
>>> from deezer import AsyncClient
>>>
>>>
>>> @coroutine
... def main():
...     client = AsyncClient()
...     album = yield client.get_album(12)
...     print(album.title)
...
>>> IOLoop.instance().run_sync(main)
Monkey Business

See the whole API on the Sphinx generated documentation.

Authentication

Not supported by this package. There are excellent other python modules to handle that. There is the excellent Python Social Auth, it doesn’t support Deezer, but it’s very easily extensible to support it, and if you do write a back-end for it, I’d encourage you to submit a pull request there.

Running Tests

Tests are run using Tox, that you would need to have installed in your environment. Then simply run:

% tox [-e py35]
py35 runtests: commands[0] | python -m coverage run -m unittest discover
................................
----------------------------------------------------------------------
Ran 32 tests in 1.319s

OK
py35 runtests: commands[1] | python /Users/Bruno/Documents/Workspace/deezer-python/run_coveralls.py
_____________ summary _____________
py35: commands succeeded
congratulations :)

Create a New Release

This project is configured to use bumpversion, only prerequisite is to have it installed. When the tests have passed and you’re happy with the code base, just need to run:

$ bumpversion [major|minor|patch]

Depending on which digit of the version needs to be updated, and then push with tags:

$ git push --tags

Travis will take care of creating the release, and upload it to PyPi.

History

Unreleased

0.4.0 (2016-12-08)

  • Add the chart resource. Thanks to Pascal.
  • Documentation updates regarding changelog and list of authors.

0.3.0 (2016-11-09)

  • Enriching the API for resources to get related resources as iterators. Thanks to Pascal.

0.2.3 (2016-11-07)

  • Drop support for Python 3.2. It should still work, but we are not testing it anymore, as this version as reached end of life.

0.2.2 (2015-09-14)

  • Python 3.5 support
  • Various doc updates

0.2.0 (2015-01-31)

  • Enriching the API for resources to get artists for a genre, top tracks of an artist, etc… Thanks to Misuzu.

0.1.0 (2014-11-22)

  • Initial release.

Credits

“deezer-python” is written and maintained by Bruno Alla.

Contributors

Other people contributed to this project:

Please add yourself here alphabetically when you submit your first pull request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for deezer-python, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size deezer_python-0.4.0-py3-none-any.whl (11.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size deezer-python-0.4.0.tar.gz (39.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page