deezer-python-gql 0.1.0__py3-none-any.whl

deezer_python_gql/__init__.py

@@ -0,0 +1,5 @@
+"""Async typed Python client for Deezer's Pipe GraphQL API."""
+
+from deezer_python_gql.generated.client import DeezerGQLClient
+
+__all__ = ["DeezerGQLClient"]

deezer_python_gql/base_client.py

@@ -0,0 +1,198 @@
+"""Custom async base client with Deezer ARL → JWT authentication."""
+
+from __future__ import annotations
+
+import json
+import time
+from base64 import urlsafe_b64decode
+from typing import Any, cast
+
+import httpx
+
+
+class GraphQLClientError(Exception):
+    """Base exception for GraphQL client errors."""
+
+
+class GraphQLClientHttpError(GraphQLClientError):
+    """Raised when the HTTP response indicates an error."""
+
+    def __init__(self, status_code: int, response: httpx.Response) -> None:
+        self.status_code = status_code
+        self.response = response
+        super().__init__(f"HTTP status code: {status_code}")
+
+
+class GraphQLClientInvalidResponseError(GraphQLClientError):
+    """Raised when the response cannot be parsed as valid GraphQL."""
+
+    def __init__(self, response: httpx.Response) -> None:
+        self.response = response
+        super().__init__("Invalid response format")
+
+
+class GraphQLClientGraphQLError(GraphQLClientError):
+    """A single GraphQL error from the response."""
+
+    def __init__(self, message: str, locations: Any = None, path: Any = None) -> None:
+        self.message = message
+        self.locations = locations
+        self.path = path
+        super().__init__(message)
+
+
+class GraphQLClientGraphQLMultiError(GraphQLClientError):
+    """Raised when the GraphQL response contains errors."""
+
+    def __init__(self, errors: list[GraphQLClientGraphQLError], data: Any = None) -> None:
+        self.errors = errors
+        self.data = data
+        super().__init__(str(errors))
+
+    @classmethod
+    def from_errors_dicts(
+        cls,
+        errors_dicts: list[dict[str, Any]],
+        data: Any = None,
+    ) -> GraphQLClientGraphQLMultiError:
+        """Create from raw error dicts in a GraphQL response."""
+        errors = [
+            GraphQLClientGraphQLError(
+                message=e.get("message", "Unknown error"),
+                locations=e.get("locations"),
+                path=e.get("path"),
+            )
+            for e in errors_dicts
+        ]
+        return cls(errors=errors, data=data)
+
+
+class DeezerBaseClient:
+    """Async HTTP client for Deezer's Pipe GraphQL API with ARL-based auth.
+
+    Handles the ARL cookie → JWT token exchange and automatic refresh.
+    This class is used as the base client for ariadne-codegen's generated client.
+
+    :param arl: Deezer ARL cookie value for authentication.
+    :param url: GraphQL endpoint URL (defaults to Pipe API).
+    :param http_client: Optional pre-configured httpx.AsyncClient.
+    """
+
+    PIPE_URL = "https://pipe.deezer.com/api"
+    AUTH_URL = "https://auth.deezer.com/login/arl"
+    JWT_REFRESH_MARGIN_SECONDS = 30
+
+    def __init__(
+        self,
+        arl: str,
+        url: str = PIPE_URL,
+        http_client: httpx.AsyncClient | None = None,
+    ) -> None:
+        self.url = url
+        self._arl = arl
+        self._http_client = http_client
+        self._jwt: str | None = None
+        self._jwt_expires_at: float = 0
+
+    async def execute(
+        self,
+        query: str,
+        operation_name: str | None = None,
+        variables: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> httpx.Response:
+        """Execute a GraphQL query against the Pipe API.
+
+        Automatically handles JWT acquisition and refresh from the ARL cookie.
+
+        :param query: The GraphQL query string.
+        :param operation_name: Optional operation name for multi-operation documents.
+        :param variables: Optional query variables.
+        :param kwargs: Additional keyword arguments passed to httpx.
+        """
+        jwt = await self._ensure_jwt()
+
+        headers: dict[str, str] = kwargs.pop("headers", None) or {}
+        headers["Authorization"] = f"Bearer {jwt}"
+        headers["Content-Type"] = "application/json"
+
+        payload: dict[str, Any] = {"query": query}
+        if operation_name:
+            payload["operationName"] = operation_name
+        if variables:
+            payload["variables"] = variables
+
+        client = self._http_client or httpx.AsyncClient()
+        try:
+            return await client.post(
+                self.url,
+                json=payload,
+                headers=headers,
+                **kwargs,
+            )
+        finally:
+            if not self._http_client:
+                await client.aclose()
+
+    def get_data(self, response: httpx.Response) -> dict[str, Any]:
+        """Parse a GraphQL response and return the data dict.
+
+        Handles the Pipe API's text/plain content type and standard
+        GraphQL error responses.
+
+        :param response: The HTTP response from execute().
+        """
+        if not response.is_success:
+            raise GraphQLClientHttpError(status_code=response.status_code, response=response)
+
+        try:
+            response_json = response.json()
+        except ValueError as exc:
+            raise GraphQLClientInvalidResponseError(response=response) from exc
+
+        if (not isinstance(response_json, dict)) or (
+            "data" not in response_json and "errors" not in response_json
+        ):
+            raise GraphQLClientInvalidResponseError(response=response)
+
+        data = response_json.get("data")
+        errors = response_json.get("errors")
+
+        if errors:
+            raise GraphQLClientGraphQLMultiError.from_errors_dicts(errors_dicts=errors, data=data)
+
+        return cast("dict[str, Any]", data)
+
+    async def _ensure_jwt(self) -> str:
+        """Acquire or refresh the JWT token from ARL cookie.
+
+        The Pipe API uses short-lived JWTs (~6 min TTL) obtained by
+        POSTing the ARL cookie to auth.deezer.com. The response is
+        Content-Type: text/plain containing JSON.
+        """
+        now = time.time()
+        if self._jwt and now < (self._jwt_expires_at - self.JWT_REFRESH_MARGIN_SECONDS):
+            return self._jwt
+
+        params = {"jo": "p", "rto": "c", "i": "c"}
+
+        async with httpx.AsyncClient() as http:
+            resp = await http.post(
+                self.AUTH_URL,
+                params=params,
+                cookies={"arl": self._arl},
+            )
+            resp.raise_for_status()
+
+        # Response body is text/plain containing JSON
+        data = json.loads(resp.text)
+        self._jwt = data["jwt"]
+
+        # Decode expiration from JWT payload (second segment, base64url-encoded)
+        payload_segment = self._jwt.split(".")[1]
+        # Add padding for base64 decoding
+        padded = payload_segment + "=" * (-len(payload_segment) % 4)
+        payload = json.loads(urlsafe_b64decode(padded))
+        self._jwt_expires_at = float(payload["exp"])
+
+        return self._jwt

deezer_python_gql-0.1.0.dist-info/METADATA

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: deezer-python-gql
+Version: 0.1.0
+Summary: Async typed Python client for Deezer's Pipe GraphQL API.
+Author-email: Julian Daberkow <jdaberkow@users.noreply.github.com>
+License: Apache-2.0
+Platform: any
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: test
+Requires-Dist: codespell==2.4.1; extra == "test"
+Requires-Dist: mypy==1.19.1; extra == "test"
+Requires-Dist: pre-commit==4.5.1; extra == "test"
+Requires-Dist: pre-commit-hooks==6.0.0; extra == "test"
+Requires-Dist: pytest==9.0.2; extra == "test"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "test"
+Requires-Dist: pytest-cov==7.0.0; extra == "test"
+Requires-Dist: ruff==0.15.1; extra == "test"
+Provides-Extra: dev
+Requires-Dist: ariadne-codegen[subscriptions]; extra == "dev"
+Dynamic: license-file
+
+# deezer-python-gql
+
+Async typed Python client for Deezer's Pipe GraphQL API.
+
+Built with [ariadne-codegen](https://github.com/mirumee/ariadne-codegen) — all
+client methods and response models are generated from the GraphQL schema and
+`.graphql` query files.
+
+## Installation
+
+```bash
+uv add deezer-python-gql
+```
+
+## Quick Start
+
+```python
+import asyncio
+
+from deezer_python_gql import DeezerGQLClient
+
+async def main():
+    client = DeezerGQLClient(arl="YOUR_ARL_COOKIE")
+
+    # Current user
+    me = await client.get_me()
+    print(me)
+
+    # Track with media URLs, lyrics, and contributors
+    track = await client.get_track(track_id="3135556")
+    print(track.title, track.duration)
+
+    # Album with paginated track list
+    album = await client.get_album(album_id="302127")
+    print(album.display_title, album.tracks_count)
+
+    # Artist with top tracks and discography
+    artist = await client.get_artist(artist_id="27")
+    print(artist.name, artist.fans_count)
+
+    # Playlist with tracks
+    playlist = await client.get_playlist(playlist_id="53362031")
+    print(playlist.title, playlist.estimated_tracks_count)
+
+    # Unified search across all entity types
+    results = await client.search(query="Daft Punk")
+    print(len(results.tracks.edges), "tracks found")
+
+asyncio.run(main())
+```
+
+## Available Queries
+
+| Method                      | Description                                                   |
+| --------------------------- | ------------------------------------------------------------- |
+| `get_me()`                  | Current authenticated user                                    |
+| `get_track(track_id)`       | Full track details — ISRC, media tokens, lyrics, contributors |
+| `get_album(album_id)`       | Album with cover, label, paginated tracks, fallback           |
+| `get_artist(artist_id)`     | Artist with bio, top tracks, albums (ordered by release date) |
+| `get_playlist(playlist_id)` | Playlist with owner, picture, paginated tracks                |
+| `search(query, ...)`        | Unified search across tracks, albums, artists, playlists      |
+
+All methods return fully-typed Pydantic models generated from the GraphQL schema.
+
+## Development
+
+Requires **Python 3.12+** and [uv](https://docs.astral.sh/uv/).
+
+```bash
+# Install all dependencies (including codegen tooling)
+make setup
+
+# Re-generate the typed client from schema + queries
+make generate
+
+# Run linters and type checks
+make lint
+
+# Run tests
+make test
+```
+
+### Adding a new query
+
+1. Create a `.graphql` file in `queries/`.
+2. Run `make generate` to produce the typed client method and response models.
+3. Add tests in `tests/`.
+
+## Exploring the API
+
+To run ad-hoc GraphQL queries against the live Pipe API during development:
+
+1. Create a `.env` file (already gitignored) with your ARL cookie:
+
+   ```bash
+   echo 'DEEZER_ARL=your_arl_cookie_value' > .env
+   ```
+
+2. Run queries:
+
+   ```bash
+   # Run a .graphql file
+   uv run python scripts/explore.py queries/get_me.graphql
+
+   # Run an inline query
+   uv run python scripts/explore.py -q '{ me { id } }'
+
+   # With variables
+   uv run python scripts/explore.py -q 'query($id: String!) { track(trackId: $id) { title } }' \
+       -v '{"id": "3135556"}'
+
+   # Via make
+   make explore Q=queries/get_me.graphql
+   ```
+
+The script handles JWT auth automatically — no manual token management needed.
+
+## Authentication
+
+The Pipe API uses short-lived JWTs obtained from an ARL cookie. The base client
+handles token acquisition and refresh automatically — you only need to supply a
+valid ARL value.
+
+## License
+
+Apache-2.0

deezer_python_gql-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+deezer_python_gql/__init__.py,sha256=r6fqcdTcJ1zjm79BTe_6l7Q4fPR4OUGWkID2pbqKKW4,158
+deezer_python_gql/base_client.py,sha256=kd126ctyUhJGUlWyVLpy1bg2_5UnceFVMNC0yMzViQM,6618
+deezer_python_gql/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+deezer_python_gql-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+deezer_python_gql-0.1.0.dist-info/METADATA,sha256=wnP2w8AZ1mKhRZgEUPP9rTVUTLnhD3C4uNOYb4-Lt1A,4623
+deezer_python_gql-0.1.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+deezer_python_gql-0.1.0.dist-info/top_level.txt,sha256=Yf7lMr1RCsfdcASo4pLoZIzA5aTa-cqzUePMX-A0QOM,18
+deezer_python_gql-0.1.0.dist-info/RECORD,,

deezer_python_gql-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

deezer_python_gql-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

deezer_python_gql-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+deezer_python_gql