This is a python sdk to manipulate the deezer's API
# Installation
```bash
pip install deezersdk
```
# Import
```bash
import deezersdk
```
# Authentication to the API
- You need to have a Deezer account to use the API.
- You have to go on https://developers.deezer.com/myapps and create an a new app
- You will need, your Application ID, Secret Key and the Redirect URL.
- First we use the `get_oauth_login_url` method to get a login url
```bash
url = Deezer.get_oauth_login_url(
app_id=DEEZER_APP_ID,
redirect_uri=DEEZER_REDIRECT_URI
)
```
- We have to go the url (if the pop up will open and we will be able to login to your deezer account.)
- You will then be redirected to your redirect url with an authorization code in your url.
- With this code you can, request your access token
```
Deezer.get_oauth_token(app_id=DEEZER_APP_ID, app_secret=DEEZER_APP_SECRET, code=code)
```
- You now have your access token, and can use the SDK.
# Using the sdk
## Instantiate the Deezer object
```bash
dz = Deezer(app_id=DEEZER_APP_ID,
app_secret=DEEZER_APP_SECRET,
code=YOUR_URL_CODE,
token=YOUR_ACCESS_TOKEN)
```
## Query the API
### Get my playlists
```bash
dz.get_my_playlists()
```
Will return an array of Playlist objects witch contains the title of the playlist,
the url of the picture, and a boolean `is_loved_track` to True if it's your loved playlist
### Play a music with the Deezer plugins
```bash
playlists = dz.get_my_playlists()
url = dz.get_widget(playlist=playlists[0])
```
This will give an of the plugin loaded with your playlist. You can add the url in an iframe to display the plugin
or you can open it directly with :
```bash
import webbrowser
webbrowser.open(url)
```
You call also play a list of tracks
```bash
playlists = dz.get_my_playlists()
url = dz.get_widget(tracks=tracks)
```
### Get your Flow
```bash
tracks = dz.get_flow()
```
### Get my favorites artists
```bash
artists = dz.get_my_favorite_artists()
```
### Methods on a Track
```bash
album = tack.get_album()
artist = tack.get_artist()
```
### Methods on an Album
```bash
tracks = album.get_tracks()
artist = album.get_artist()
```
### Methods on an Artist
```bash
tracks = artist.get_tracks()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/AlexisGomes/deezersdk",
"name": "deezersdk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Gomes Alexis",
"author_email": "alexis.gomes19@gmail.com",
"download_url": "",
"platform": "",
"description": "This is a python sdk to manipulate the deezer's API\n\n# Installation\n\n```bash\npip install deezersdk\n```\n\n# Import\n\n```bash\nimport deezersdk\n```\n\n# Authentication to the API\n- You need to have a Deezer account to use the API.\n\n- You have to go on https://developers.deezer.com/myapps and create an a new app \n\n- You will need, your Application ID, Secret Key and the Redirect URL.\n\n- First we use the `get_oauth_login_url` method to get a login url\n ```bash\n url = Deezer.get_oauth_login_url(\n app_id=DEEZER_APP_ID, \n redirect_uri=DEEZER_REDIRECT_URI\n )\n ```\n- We have to go the url (if the pop up will open and we will be able to login to your deezer account.)\n\n- You will then be redirected to your redirect url with an authorization code in your url.\n\n- With this code you can, request your access token \n ```\n Deezer.get_oauth_token(app_id=DEEZER_APP_ID, app_secret=DEEZER_APP_SECRET, code=code)\n ```\n\n- You now have your access token, and can use the SDK.\n\n# Using the sdk\n## Instantiate the Deezer object\n```bash\ndz = Deezer(app_id=DEEZER_APP_ID,\n app_secret=DEEZER_APP_SECRET,\n code=YOUR_URL_CODE,\n token=YOUR_ACCESS_TOKEN)\n```\n## Query the API\n### Get my playlists\n```bash\ndz.get_my_playlists()\n```\nWill return an array of Playlist objects witch contains the title of the playlist,\n the url of the picture, and a boolean `is_loved_track` to True if it's your loved playlist\n\n### Play a music with the Deezer plugins\n```bash\nplaylists = dz.get_my_playlists()\nurl = dz.get_widget(playlist=playlists[0])\n```\nThis will give an of the plugin loaded with your playlist. You can add the url in an iframe to display the plugin \nor you can open it directly with : \n```bash\nimport webbrowser\nwebbrowser.open(url)\n```\nYou call also play a list of tracks\n```bash\nplaylists = dz.get_my_playlists()\nurl = dz.get_widget(tracks=tracks)\n```\n### Get your Flow\n```bash\ntracks = dz.get_flow()\n```\n### Get my favorites artists\n```bash\nartists = dz.get_my_favorite_artists()\n```\n### Methods on a Track\n```bash\nalbum = tack.get_album()\nartist = tack.get_artist()\n```\n### Methods on an Album\n```bash\ntracks = album.get_tracks()\nartist = album.get_artist()\n```\n### Methods on an Artist\n```bash\ntracks = artist.get_tracks()\n```\n\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A python SDK for the Deezer API",
"version": "0.18",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8a9a6d3ecb47c168e82f163bedc87a02c6f67570479ccf18a1fe99f4e008f344",
"md5": "d393c4db12eb9769f9ee2ebf0912bc17",
"sha256": "2e7648ba1cce44f2a5585091191b864bfa6c17b03be5c06bdc5c738c988bea2e"
},
"downloads": -1,
"filename": "deezersdk-0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d393c4db12eb9769f9ee2ebf0912bc17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5862,
"upload_time": "2020-04-15T06:37:06",
"upload_time_iso_8601": "2020-04-15T06:37:06.149968Z",
"url": "https://files.pythonhosted.org/packages/8a/9a/6d3ecb47c168e82f163bedc87a02c6f67570479ccf18a1fe99f4e008f344/deezersdk-0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-04-15 06:37:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "AlexisGomes",
"github_project": "deezersdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "deezersdk"
}
JSON
