improve OAuthCredentials import ease of use (#732)

* improve OAuthCredentials import ease of use * improve OAuthCredentials import ease of use
sigma67 · Jan 31, 2025 · 535f153 · 535f153
1 parent a004bed
commit 535f153
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 34 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -15,10 +15,10 @@ jobs:
       - uses: actions/checkout@v4
       - uses: chartboost/ruff-action@v1
         with:
-          version: 0.9.2
+          version: 0.9.4
       - uses: chartboost/ruff-action@v1
         with:
-          version: 0.9.2
+          version: 0.9.4
           args: format --check
   mypy:
     runs-on: ubuntu-latest

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,10 +1,11 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.9.2
+  rev: v0.9.4
   hooks:
     # Run the linter.
     - id: ruff
+      args: [ --fix ]
     # Run the formatter.
     - id: ruff-format
 

diff --git a/docs/source/setup/oauth.rst b/docs/source/setup/oauth.rst
@@ -24,6 +24,8 @@ You will also need to pass ``client_id`` and ``client_secret`` to :py:class:`YTM
 
 .. code-block::
 
+    from ytmusicapi import YTMusic, OAuthCredentials
+
     ytmusic = YTMusic('oauth.json', oauth_credentials=OAuthCredentials(client_id=client_id, client_secret=client_secret)
 
 This OAuth flow uses the

diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -23,7 +23,7 @@ After you have created the authentication JSON, you can instantiate the class:
 
 .. code-block:: python
 
-    from ytmusicapi import YTMusic
+    from ytmusicapi import YTMusic, OAuthCredentials
     ytmusic = YTMusic("browser.json") # or, alternatively
     ytmusic = YTMusic("oauth.json", oauth_credentials=OAuthCredentials(client_id=client_id, client_secret=client_secret)
 

diff --git a/pdm.lock b/pdm.lock
diff --git a/ytmusicapi/__init__.py b/ytmusicapi/__init__.py
@@ -1,5 +1,6 @@
 from importlib.metadata import PackageNotFoundError, version
 
+from ytmusicapi.auth.oauth.credentials import OAuthCredentials
 from ytmusicapi.setup import setup, setup_oauth
 from ytmusicapi.ytmusic import YTMusic
 
@@ -12,4 +13,4 @@
 __copyright__ = "Copyright 2024 sigma67"
 __license__ = "MIT"
 __title__ = "ytmusicapi"
-__all__ = ["YTMusic", "setup", "setup_oauth"]
+__all__ = ["OAuthCredentials", "YTMusic", "setup", "setup_oauth"]