deezer-python 1.0.0__tar.gz → 1.1.0__tar.gz

{deezer-python-1.0.0 → Users/bruno/.virtualenvs/deezer-python/lib/python3.6/site-packages}/deezer/__init__.py

@@ -9,7 +9,7 @@ from deezer.resources import Album, Resource, Artist, Playlist
 from deezer.resources import Genre, Track, User, Comment, Radio
 
 
-__version__ = "1.0.0"
+__version__ = "1.1.0"
 __all__ = [
     "Client",
     "Resource",

deezer-python-1.0.0/deezer/contrib/tornado.py → Users/bruno/.virtualenvs/deezer-python/lib/python3.6/site-packages/deezer/asynchronous.py

@@ -5,7 +5,7 @@ Implements an async tornado client class to query the
 import json
 import logging
 
-from tornado.gen import Return, coroutine
+from tornado.gen import coroutine, Return
 from tornado.httpclient import AsyncHTTPClient
 
 from deezer.client import Client
@@ -13,27 +13,26 @@ from deezer.client import Client
 
 class AsyncClient(Client):
     """
-    An async client to retrieve some basic infos about Deezer resources.
+    An async client to retrieve some basic infos about Deezer resourses.
 
     Create a client instance with the provided options. Options should
     be passed in to the constructor as kwargs.
 
-        >>> from deezer.contrib.tornado import AsyncClient
-        >>> client = AsyncClient(app_id='foo', app_secret='bar')
+        >>> import deezer
+        >>> client = deezer.AsyncClient(app_id='foo', app_secret='bar')
 
     This client provides several method to retrieve the content of most
     sort of Deezer objects, based on their json structure.
     """
 
     def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        max_clients = kwargs.get("max_clients", 2)
+        super(AsyncClient, self).__init__(*args, **kwargs)
+        max_clients = kwargs.get('max_clients', 2)
         self._async_client = AsyncHTTPClient(max_clients=max_clients)
 
     @coroutine
-    def get_object(
-        self, object_t, object_id=None, relation=None, parent=None, **kwargs
-    ):
+    def get_object(self, object_t, object_id=None, relation=None, parent=None,
+                   **kwargs):
         """
         Actually query the Deezer API to retrieve the object
 
@@ -43,7 +42,7 @@ class AsyncClient(Client):
         url = self.object_url(object_t, object_id, relation, **kwargs)
         logging.debug(url)
         response = yield self._async_client.fetch(url)
-        resp_str = response.body.decode("utf-8")
+        resp_str = response.body.decode('utf-8')
         jsn = json.loads(resp_str)
         result = self._process_json(jsn, parent)
         raise Return(result)

{deezer-python-1.0.0 → Users/bruno/.virtualenvs/deezer-python/lib/python3.6/site-packages}/deezer/client.py

@@ -5,6 +5,7 @@ Implements a client class to query the
 import requests
 from urllib.parse import urlencode
 
+from deezer.utils import SortedDict
 from deezer.resources import Album, Artist, Comment, Genre
 from deezer.resources import Chart, Resource
 from deezer.resources import Playlist, Radio, Track, User
@@ -48,6 +49,11 @@ class Client:
         self.use_ssl = kwargs.get("use_ssl", self.use_ssl)
         self.host = kwargs.get("host", self.host)
         self.session = requests.Session()
+
+        # Do not compress the response: to be readable in tests (cassettes)
+        if kwargs.get("do_not_compress_reponse"):
+            self.session.headers.update({"Accept-Encoding": "identity"})
+
         self.options = kwargs
         self._authorize_url = None
 
@@ -112,7 +118,9 @@ class Client:
             for key, value in kwargs.items():
                 if not isinstance(value, str):
                     kwargs[key] = str(value)
-            result = "{}?{}".format(base_url, urlencode(kwargs))
+            # kwargs are sorted (for consistent tests between Python < 3.7 and >= 3.7)
+            sorted_kwargs = SortedDict.from_dict(kwargs)
+            result = "{}?{}".format(base_url, urlencode(sorted_kwargs))
         else:
             result = base_url
         return result
@@ -231,7 +239,9 @@ class Client:
 
         :returns: a list of :class:`~deezer.resources.Resource` objects.
         """
-        return self.get_object("search", relation=relation, q=query, **kwargs)
+        return self.get_object(
+            "search", relation=relation, q=query, index=index, limit=limit, **kwargs
+        )
 
     def advanced_search(self, terms, relation=None, index=0, limit=25, **kwargs):
         """
@@ -247,5 +257,8 @@ class Client:
         ...                        relation="track")
         """
         assert isinstance(terms, dict), "terms must be a dict"
-        query = " ".join(['{}:"{}"'.format(k, v) for (k, v) in terms.items()])
-        return self.get_object("search", relation=relation, q=query, **kwargs)
+        # terms are sorted (for consistent tests between Python < 3.7 and >= 3.7)
+        query = " ".join(sorted(['{}:"{}"'.format(k, v) for (k, v) in terms.items()]))
+        return self.get_object(
+            "search", relation=relation, q=query, index=index, limit=limit, **kwargs
+        )

Users/bruno/.virtualenvs/deezer-python/lib/python3.6/site-packages/deezer/utils.py

@@ -0,0 +1,20 @@
+"""Utils."""
+
+from collections import OrderedDict
+
+
+class SortedDict(OrderedDict):
+    """Sorted ``dict``.
+
+    This class is present to order query string and keep the request call always the
+    same way. This is necessary to have reproductible tests with ``vcr.py``.
+
+    ``dict`` ordering is deterministic before 3.6 and is not guaranteed in Python < 3.7
+    """
+
+    @classmethod
+    def from_dict(cls, dct):
+        odict = cls()
+        for key in sorted(dct.keys()):
+            odict[key] = dct[key]
+        return odict

{deezer-python-1.0.0 → Users/bruno/.virtualenvs/deezer-python/lib/python3.6/site-packages/deezer_python-1.1.0-py3.6.egg-info}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: deezer-python
-Version: 1.0.0
+Version: 1.1.0
 Summary: A friendly wrapper library for the Deezer API
 Home-page: https://github.com/browniebroke/deezer-python
 Author: Bruno Alla
 Author-email: alla.brunoo@gmail.com
 License: MIT
-Download-URL: https://github.com/browniebroke/deezer-python/tarball/1.0.0
+Download-URL: https://github.com/browniebroke/deezer-python/tarball/1.1.0
 Description: Deezer Python Client
         ====================
         
@@ -38,7 +38,7 @@ Description: Deezer Python Client
             >>> client.get_album(12).title
             'Monkey Business'
         
-        See the whole API reference on the `Sphinx`_ generated `documentation`_.
+        The detailed `API reference`_ is available in the `documentation`_ on the RTD.
         
         Asynchronous client
         ```````````````````
@@ -95,7 +95,7 @@ Description: Deezer Python Client
         .. |pyversions| image:: https://img.shields.io/pypi/pyversions/deezer-python.svg?style=flat-square
         .. |license| image:: https://img.shields.io/pypi/l/deezer-python.svg?style=flat-square
         .. _Deezer API: http://developers.deezer.com/api
-        .. _Sphinx: http://sphinx-doc.org/
+        .. _API reference: https://deezer-python.readthedocs.io/api_reference/toc.html
         .. _documentation: http://deezer-python.readthedocs.io/
         .. _Python Social Auth: https://github.com/python-social-auth
         
@@ -105,7 +105,14 @@ Description: Deezer Python Client
         History
         =======
         
-        1.0.0 (unreleased)
+        1.1.0 (2019-05-25)
+        ------------------
+        
+        - Tests with ``vcr.py`` instead of ``requests_mock``.
+        - Support for Python 3.7 & 3.8 is finally official.
+        - Breaking: drop support for Python 3.4.
+        
+        1.0.0 (2019-02-11)
         ------------------
         
         - Breaking: drop support for Python 2.
@@ -225,17 +232,18 @@ Description: Deezer Python Client
         Please add yourself here alphabetically when you submit your first pull request.
         
 Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.4
 Classifier: Programming Language :: Python :: 3.5
 Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.4
+Requires-Python: >=3.5
 Provides-Extra: tornado

{deezer-python-1.0.0/deezer_python.egg-info → Users/bruno/.virtualenvs/deezer-python/lib/python3.6/site-packages/deezer_python-1.1.0-py3.6.egg-info}/SOURCES.txt

@@ -12,6 +12,7 @@ setup.py
 deezer/__init__.py
 deezer/client.py
 deezer/resources.py
+deezer/utils.py
 deezer/contrib/__init__.py
 deezer/contrib/tornado.py
 deezer_python.egg-info/PKG-INFO
@@ -31,4 +32,5 @@ docs/source/_static/.placeholder
 docs/source/api_reference/client.rst
 docs/source/api_reference/resources.rst
 docs/source/api_reference/toc.rst
+docs/source/api_reference/utils.rst
 docs/source/api_reference/contrib/tornado.rst

deezer-python-1.0.0/.coveragerc

@@ -1,17 +0,0 @@
-# Test coverage configuration.
-# Usage:
-#   pip install coverage
-#   coverage erase  # clears previous data if any
-#   coverage run -m unittest discover
-#   coverage report  # prints to stdout
-#   coverage html  # creates ./htmlcov/*.html including annotated source
-[run]
-branch = true
-source = deezer
-omit = 
-    ENV/*
-    deezer/tests/*
-
-[report]
-# Ignore missing source files, i.e. fake template-generated "files"
-ignore_errors = true

deezer-python-1.0.0/AUTHORS.rst

@@ -1,21 +0,0 @@
-Credits
-=======
-
-“deezer-python” is written and maintained by Bruno Alla.
-
-
-Contributors
-------------
-
-Other people contributed to this project:
-
-- `Hugo van Kemenade <https://github.com/hugovk>`_
-- `Jonathan Virga <https://github.com/jnth>`_
-- `khamaileon <https://github.com/khamaileon>`_
-- `Kieran Wynne <https://github.com/k33k00>`_
-- `Matheus Horstmann <https://github.com/horstmannmat>`_
-- `Misuzu <https://github.com/misuzu>`_
-- `Nikolay Sheregeda <https://github.com/sheregeda>`_
-- `Pascal <https://github.com/pfouque>`_
-
-Please add yourself here alphabetically when you submit your first pull request.

deezer-python-1.0.0/CONTRIBUTING.rst

@@ -1,127 +0,0 @@
-============
-Contributing
-============
-
-Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given.
-
-You can contribute in many ways:
-
-Types of Contributions
-----------------------
-
-Report Bugs
-~~~~~~~~~~~
-
-Report bugs on the `issues page`_. If you are reporting a bug, please include:
-
-* Any details about your local setup that might be helpful in troubleshooting.
-* Detailed steps to reproduce the bug.
-
-Fix Bugs
-~~~~~~~~
-
-Look through the GitHub issues for bugs. Anything tagged with "bug"
-is open to whoever wants to implement it.
-
-Implement Features
-~~~~~~~~~~~~~~~~~~
-
-Look through the GitHub issues for features. Anything tagged with "feature"
-is open to whoever wants to implement it.
-
-Write Documentation
-~~~~~~~~~~~~~~~~~~~
-
-This module could always use more documentation, whether as part of the
-official docs, in docstrings, or other.
-
-Submit Feedback
-~~~~~~~~~~~~~~~
-
-The best way to send feedback is to file an ticket on the `issues page`_. If you
-are proposing a feature:
-
-* Explain how it would work.
-* Keep the scope as narrow as possible, to make it easier to implement.
-* Remember that this is a volunteer-driven project, and that contributions
-  are welcome 🙂
-
-Get Started!
-------------
-
-Ready to contribute? Here's how to set up ``deezer-python`` for local development.
-
-1. Fork the repo on GitHub.
-2. Clone your fork locally::
-
-    $ git clone git@github.com:your_name_here/deezer-python.git
-
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper
-   installed, this is how you set up your fork for local development::
-
-    $ mkvirtualenv deezer-python
-    $ cd deezer-python/
-
-4. Create a branch for local development::
-
-    $ git checkout -b name-of-your-bugfix-or-feature
-
-   Now you can make your changes locally.
-
-5. When you're done making changes, check that your changes pass our
-   tests and that the doc builds. The easiest way to do that is by running
-   `tox`_ environments::
-
-        $ tox -e lint,docs,py36
-
-   It will run our linters (`flake8`_ and `black`_), build the docs and run the tests
-
-6. Commit your changes, quoting GitHub issue in the commit message, if applicable,
-   and push your branch to GitHub::
-
-    $ git add .
-    $ git commit -m "Fix #XX - My awesome fix"
-    $ git push origin name-of-your-bugfix-or-feature
-
-7. Submit a pull request on GitHub.
-
-Pull Request Guidelines
------------------------
-
-Feel free to open the pull request as soon as possible, but please be explicit
-if it's still a work in progress. To be mergeable, pull requests should follow the
-following guidelines:
-
-1. It should include tests for feature or bug fixes.
-2. If it adds functionality, the docs should be updated.
-3. It should work for Python 3.4, 3.5, 3.6 and for PyPy3.
-   Check `Travis`_ as well as `AppVeyor`_ and make sure that the tests
-   pass for all supported Python versions.
-4. If your change is worthwhile a mention in the changelog, update the
-   Unreleased section of ``HISTORY.rst``.
-5. If this is your first contribution, don't forget to leave your name in
-   the ``AUTHORS.rst`` file.
-
-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,
-you can bump the version everywhere needed, commit and create a git tag by running::
-
-  $ bumpversion [major|minor|patch]
-
-Then, do a git push, without forgetting about git tags::
-
-  $ git push --tags
-
-`Travis`_ will take care of creating the release, and upload it to PyPI.
-
-.. _issues page: https://github.com/browniebroke/deezer-python/issues
-.. _Travis: https://travis-ci.org/browniebroke/deezer-python/pull_requests
-.. _AppVeyor: https://ci.appveyor.com/project/browniebroke/deezer-python
-.. _tox: http://tox.readthedocs.io/en/stable/index.html
-.. _flake8: http://flake8.pycqa.org/en/latest/
-.. _black: https://github.com/ambv/black
-.. _bumpversion: https://github.com/peritus/bumpversion

deezer-python-1.0.0/HISTORY.rst

@@ -1,100 +0,0 @@
-.. :changelog:
-
-History
-=======
-
-1.0.0 (unreleased)
-------------------
-
-- Breaking: drop support for Python 2.
-
-0.9.0 (2019-02-10)
-------------------
-
-- Add ``Client.advanced_search``.
-
-0.8.0 (2018-10-30)
-------------------
-
-- Added ``index`` and ``limit`` to ``Client.search`` & ``Client.get_charts``.
-  Defaults are set to Deezer API defaults.
-- Changed tornado to be an optional requirement. If you want to use the
-  asynchronous client, you need to install the library as follow
-  ``pip install deezer-python[tornado]``.
-- Simplified a couple of things to rely more on `six`_ for Python compatibility.
-- Auto-format code using `black`_.
-
-.. _black: https://github.com/ambv/black
-
-0.7.0 (2018-10-03)
-------------------
-
-- Breaking: the ``async`` module has been renamed ``asynchronous`` as it was
-  breaking under Python 3.7, thanks `Matheus Horstmann`_ for the patch
-- Optimisation: the session is now stored internally by the client
-
-0.6.1 (2017-06-19)
-------------------
-
-- Added access token to the request kwargs. Thanks `Nikolay Sheregeda`_ for
-  the patch.
-- Documentation update, thanks `Khamaileon`_ for the correction.
-
-0.6.0 (2016-12-27)
-------------------
-
-- Refactoring to use `requests`_ instead of urllib, mocking using
-  Requests mock instead of manual patching. Use `six`_ for Python
-  2 and 3 compatibility.
-
-.. _requests: http://docs.python-requests.org/
-.. _six: https://pythonhosted.org/six/
-
-0.5.0 (2016-12-26)
-------------------
-
-- Python 3.6 support
-- Remove Python 3.2 classifier, support was dropped since 0.2.3
-- Updated docs and testing setup
-
-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.
-
-.. _Misuzu: https://github.com/misuzu
-.. _Pascal: https://github.com/pfouque
-.. _chart: https://developers.deezer.com/api/chart
-.. _Khamaileon: https://github.com/khamaileon
-.. _Nikolay Sheregeda: https://github.com/sheregeda
-.. _Matheus Horstmann: https://github.com/horstmannmat

deezer-python-1.0.0/LICENSE.txt

@@ -1,19 +0,0 @@
-Copyright (c) 2014 Bruno Alla
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

deezer-python-1.0.0/MANIFEST.in

@@ -1,10 +0,0 @@
-recursive-include deezer *.py
-include *.txt
-include *.rst
-include .coveragerc
-recursive-include deezer *.json
-recursive-include docs *.bat
-recursive-include docs *.placeholder
-recursive-include docs *.py
-recursive-include docs *.rst
-recursive-include docs Makefile

deezer-python-1.0.0/README.rst

@@ -1,91 +0,0 @@
-Deezer Python Client
-====================
-
-|build| |win_build| |coverage| |codeclimate| |black|
-
-|docs| |pypi| |pyversions| |license| |loc|
-
-A friendly wrapper around the `Deezer API`_.
-
-Installation
-------------
-
-The package is published on `PyPI <https://pypi.org/project/deezer-python/>`_ and can be installed by running:
-
-::
-
-    pip install deezer-python
-
-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.
-
-.. code-block:: python
-
-    >>> client = deezer.Client()
-    >>> client.get_album(12).title
-    'Monkey Business'
-
-See the whole API reference on the `Sphinx`_ generated `documentation`_.
-
-Asynchronous client
-```````````````````
-
-You also can use an ``AsyncClient`` with tornado, which requires an optional dependency. You should
-install with ``pip install deezer-python[tornado]``. Then, making requests look like:
-
-.. code-block:: python
-
-    >>> from tornado.gen import coroutine
-    >>> from tornado.ioloop import IOLoop
-    >>> from deezer.contrib.tornado import AsyncClient
-    >>>
-    >>>
-    >>> @coroutine
-    ... def main():
-    ...     client = AsyncClient()
-    ...     album = yield client.get_album(12)
-    ...     print(album.title)
-    ...
-    >>> IOLoop.instance().run_sync(main)
-    Monkey Business
-
-Authentication
---------------
-
-Not supported by this package. There are excellent other python modules to
-handle that. There is the excellent `Python Social Auth`_, which supports
-Deezer authentication.
-
-.. |build| image:: https://img.shields.io/travis/browniebroke/deezer-python.svg?style=flat-square&logo=travis
-    :target: https://travis-ci.org/browniebroke/deezer-python
-    :alt: Build status
-.. |win_build| image:: https://img.shields.io/appveyor/ci/browniebroke/deezer-python.svg?logo=appveyor&style=flat-square
-    :target: https://ci.appveyor.com/project/browniebroke/deezer-python
-    :alt: Build status
-.. |codeclimate| image:: https://api.codeclimate.com/v1/badges/bfbf562a06742972c694/maintainability
-   :target: https://codeclimate.com/github/browniebroke/deezer-python/maintainability
-   :alt: Maintainability
-.. |coverage| image:: https://img.shields.io/codecov/c/github/browniebroke/deezer-python.svg?logo=codecov&style=flat-square
-    :target: https://codecov.io/gh/browniebroke/deezer-python
-    :alt: Test coverage percentage
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/ambv/black
-.. |docs| image:: https://img.shields.io/readthedocs/deezer-python.svg?logo=read-the-docs&style=flat-square
-    :target: https://deezer-python.readthedocs.io
-    :alt: Documentation Status
-.. |pypi| image:: https://img.shields.io/pypi/v/deezer-python.svg?logo=python&logoColor=fff&style=flat-square
-    :target: https://pypi.org/project/deezer-python/
-    :alt: PyPi Status
-.. |loc| image:: https://tokei.rs/b1/github/browniebroke/deezer-python/
-    :target: https://github.com/browniebroke/deezer-python
-    :alt: LoC
-.. |pyversions| image:: https://img.shields.io/pypi/pyversions/deezer-python.svg?style=flat-square
-.. |license| image:: https://img.shields.io/pypi/l/deezer-python.svg?style=flat-square
-.. _Deezer API: http://developers.deezer.com/api
-.. _Sphinx: http://sphinx-doc.org/
-.. _documentation: http://deezer-python.readthedocs.io/
-.. _Python Social Auth: https://github.com/python-social-auth