spotapi 1.0.3__tar.gz → 1.0.4__tar.gz

{spotapi-1.0.3/spotapi.egg-info → spotapi-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spotapi
-Version: 1.0.3
+Version: 1.0.4
 Summary: A sleek API wrapper for Spotify's private API
 Home-page: UNKNOWN
 Author: Aran
@@ -8,6 +8,9 @@ License: UNKNOWN
 Keywords: Spotify,API,Spotify API,Spotify Private API,Follow,Like,Creator,Music,Music API,Streaming,Music Data,Track,Playlist,Album,Artist,Music Search,Music Metadata,SpotAPI,Python Spotify Wrapper,Music Automation,Web Scraping,Python Music API,Spotify Integration,Spotify Playlist,Spotify Tracks
 Platform: UNKNOWN
 Description-Content-Type: text/markdown
+Provides-Extra: websocket
+Provides-Extra: redis
+Provides-Extra: pymongo
 License-File: LICENSE
 
 # SpotAPI
@@ -16,6 +19,18 @@ Welcome to SpotAPI! This Python library is designed to interact with the private
 
 **Note**: This project is intended solely for educational purposes and should be used responsibly. Accessing private endpoints and scraping data without proper authorization may violate Spotify's terms of service
 
+## Table of Contents
+
+1. [Introduction](#spotapi)
+2. [Features](#features)
+3. [Installation](#installation)
+4. [Import Cookies](#import-cookies)
+5. [Quick Examples](#quick-examples)
+6. [Contributing](#contributing)
+7. [Roadmap](#roadmap)
+8. [License](#license)
+
+
 ## Features
 - **Public API Access**: Retrieve and manipulate public Spotify data such as playlists, albums, and tracks with ease.
 - **Private API Access**: Explore private Spotify endpoints to tailor your application to your needs.
@@ -31,7 +46,27 @@ Everything you can do with Spotify, **SpotAPI** can do with just a user’s
 pip install spotapi
 ```
 
-## Quick Example
+## Import Cookies
+If you prefer not to use a third party CAPTCHA solver, you can import cookies to manage your session.
+
+### Steps to Import Cookies:
+
+1. **Choose a Session Saver**:
+   - Select a session saver for storing your session data. 
+   - For simplicity, you should use `JSONSaver`, especially if performance or quantity of sessions is not a big concern.
+
+2. **Prepare Session Data**:
+   - Create an object with the following keys:
+     - **`identifier`**: This should be your email address or username.
+     - **`cookies`**: These are the cookies you obtain when logged in. To get these cookies, visit [Spotify](https://open.spotify.com/), log in, and copy the cookies from your browser.
+       - It can be a dict[str, str] or a string representation
+
+3. **Load the Session**:
+   - Use your program to load the session manually with the saved data. This will enable you to use Spotify with a fully functional session without needing additional CAPTCHA solving.
+
+## Quick Examples
+
+### With User Authentication
 ```py
 from spotapi import (
     Login, 
@@ -60,9 +95,51 @@ playlist.create_playlist("SpotAPI Showcase!")
 instance.save(MongoSaver())
 ```
 
+### Without User Authentication
+```py
+"""Here's the example from spotipy https://github.com/spotipy-dev/spotipy?tab=readme-ov-file#quick-start"""
+from spotapi import Song
+
+song = Song()
+gen = song.paginate_songs("weezer")
+
+# Paginates 100 songs at a time till there's no more
+for batch in gen:
+    for idx, item in enumerate(batch):
+        print(idx, item['item']['data']['name'])
+    
+# ^ ONLY 6 LINES OF CODE
+
+# Alternatively, you can query a specfic amount
+songs = song.query_songs("weezer", limit=20)
+data = songs["data"]["searchV2"]["tracksV2"]["items"]
+for idx, item in enumerate(data):
+    print(idx, item['item']['data']['name'])
+```
+### Results
+```
+0 Island In The Sun
+1 Say It Ain't So
+2 Buddy Holly
+.
+.
+.
+18 Holiday
+19 We Are All On d***s
+```
+
 ## Contributing
 Contributions are welcome! If you find any issues or have suggestions, please open an issue or submit a pull request.
 
+## Roadmap
+> I'll most likely do these if the project gains some traction
+
+- [ ] No Captcha For Login (**100 Stars**)
+- [ ] In Depth Documentation
+- [ ] Websocket Listener (Is not working ATM)
+- [ ] Player
+- [ ] More wrappers around this project
+
 ## License
 This project is licensed under the **GPL 3.0** License. See [LICENSE](https://choosealicense.com/licenses/gpl-3.0/) for details.
 

spotapi-1.0.4/README.md

@@ -0,0 +1,130 @@
+# SpotAPI
+
+Welcome to SpotAPI! This Python library is designed to interact with the private and public Spotify APIs, emulating the requests typically made through a web browser. This wrapper provides a convenient way to access Spotify’s rich set of features programmatically.
+
+**Note**: This project is intended solely for educational purposes and should be used responsibly. Accessing private endpoints and scraping data without proper authorization may violate Spotify's terms of service
+
+## Table of Contents
+
+1. [Introduction](#spotapi)
+2. [Features](#features)
+3. [Installation](#installation)
+4. [Import Cookies](#import-cookies)
+5. [Quick Examples](#quick-examples)
+6. [Contributing](#contributing)
+7. [Roadmap](#roadmap)
+8. [License](#license)
+
+
+## Features
+- **Public API Access**: Retrieve and manipulate public Spotify data such as playlists, albums, and tracks with ease.
+- **Private API Access**: Explore private Spotify endpoints to tailor your application to your needs.
+- **Ready to Use**: **SpotAPI** is designed for immediate integration, allowing you to accomplish tasks with just a few lines of code.
+- **No API Key Required**: Seamlessly use **SpotAPI** without needing a Spotify API key. It’s straightforward and hassle free!
+- **Browser-like Requests**: Accurately replicate the HTTP requests Spotify makes in the browser, providing a true to web experience while remaining undetected.
+
+Everything you can do with Spotify, **SpotAPI** can do with just a user’s login credentials.
+
+
+## Installation
+```
+pip install spotapi
+```
+
+## Import Cookies
+If you prefer not to use a third party CAPTCHA solver, you can import cookies to manage your session.
+
+### Steps to Import Cookies:
+
+1. **Choose a Session Saver**:
+   - Select a session saver for storing your session data. 
+   - For simplicity, you should use `JSONSaver`, especially if performance or quantity of sessions is not a big concern.
+
+2. **Prepare Session Data**:
+   - Create an object with the following keys:
+     - **`identifier`**: This should be your email address or username.
+     - **`cookies`**: These are the cookies you obtain when logged in. To get these cookies, visit [Spotify](https://open.spotify.com/), log in, and copy the cookies from your browser.
+       - It can be a dict[str, str] or a string representation
+
+3. **Load the Session**:
+   - Use your program to load the session manually with the saved data. This will enable you to use Spotify with a fully functional session without needing additional CAPTCHA solving.
+
+## Quick Examples
+
+### With User Authentication
+```py
+from spotapi import (
+    Login, 
+    Config, 
+    NoopLogger, 
+    solver_clients, 
+    PrivatePlaylist, 
+    MongoSaver
+)
+
+cfg = Config(
+    solver=solver_clients.Capsolver("YOUR_API_KEY", proxy="YOUR_PROXY"), # Proxy is optional
+    logger=NoopLogger(),
+    # You can add a proxy by passing a custom TLSClient
+)
+
+instance = Login(cfg, "YOUR_PASSWORD", email="YOUR_EMAIL")
+# Now we have a valid Login instance to pass around
+instance.login()
+
+# Do whatever you want now
+playlist = PrivatePlaylist(instance)
+playlist.create_playlist("SpotAPI Showcase!")
+
+# Save the session
+instance.save(MongoSaver())
+```
+
+### Without User Authentication
+```py
+"""Here's the example from spotipy https://github.com/spotipy-dev/spotipy?tab=readme-ov-file#quick-start"""
+from spotapi import Song
+
+song = Song()
+gen = song.paginate_songs("weezer")
+
+# Paginates 100 songs at a time till there's no more
+for batch in gen:
+    for idx, item in enumerate(batch):
+        print(idx, item['item']['data']['name'])
+    
+# ^ ONLY 6 LINES OF CODE
+
+# Alternatively, you can query a specfic amount
+songs = song.query_songs("weezer", limit=20)
+data = songs["data"]["searchV2"]["tracksV2"]["items"]
+for idx, item in enumerate(data):
+    print(idx, item['item']['data']['name'])
+```
+### Results
+```
+0 Island In The Sun
+1 Say It Ain't So
+2 Buddy Holly
+.
+.
+.
+18 Holiday
+19 We Are All On d***s
+```
+
+## Contributing
+Contributions are welcome! If you find any issues or have suggestions, please open an issue or submit a pull request.
+
+## Roadmap
+> I'll most likely do these if the project gains some traction
+
+- [ ] No Captcha For Login (**100 Stars**)
+- [ ] In Depth Documentation
+- [ ] Websocket Listener (Is not working ATM)
+- [ ] Player
+- [ ] More wrappers around this project
+
+## License
+This project is licensed under the **GPL 3.0** License. See [LICENSE](https://choosealicense.com/licenses/gpl-3.0/) for details.
+

{spotapi-1.0.3 → spotapi-1.0.4}/setup.py

@@ -5,14 +5,16 @@ __install_require__ = [
     "requests",
     "colorama",
     "Pillow",
-    "pymongo",
     "readerwriterlock",
-    "redis",
     "tls_client",
     "typing_extensions",
     "validators",
-    "websockets",
 ]
+__extras__ = {
+    "websocket": ["websockets"],
+    "redis": ["redis"],
+    "pymongo": ["pymongo"],
+}
 
 with open("README.md", "r") as f:
     long_description = f.read()
@@ -23,6 +25,7 @@ setup(
     description=__description__,
     packages=find_packages(),
     install_requires=__install_require__,
+    extras_require=__extras__,
     keywords=[
         "Spotify",
         "API",
@@ -52,5 +55,5 @@ setup(
     ],
     long_description=long_description,
     long_description_content_type="text/markdown",
-    version="1.0.3",
+    version="1.0.4",
 )

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/artist.py

@@ -19,16 +19,16 @@ class Artist:
         self,
         login: Optional[Login] = None,
         *,
-        client: Optional[TLSClient] = TLSClient("chrome_120", "", auto_retries=3),
+        client: TLSClient = TLSClient("chrome_120", "", auto_retries=3),
     ) -> None:
         if login and not login.logged_in:
             raise ValueError("Must be logged in")
 
         self._login: bool = bool(login)
-        self.base = BaseClient(client=login.client if (login is not None) else client) # type: ignore
+        self.base = BaseClient(client=login.client if (login is not None) else client)  # type: ignore
 
     def query_artists(
-        self, query: str, /, limit: Optional[int] = 10, *, offset: Optional[int] = 0
+        self, query: str, /, limit: int = 10, *, offset: int = 0
     ) -> Mapping[str, Any]:
         """Searches for an artist in the Spotify catalog"""
         url = "https://api-partner.spotify.com/pathfinder/v1/query"
@@ -56,7 +56,6 @@ class Artist:
 
         resp = self.base.client.post(url, params=params, authenticate=True)
 
-        
         if resp.fail:
             raise ArtistError("Could not get artists", error=resp.error.string)
 
@@ -96,7 +95,7 @@ class Artist:
         artist_id: str,
         /,
         *,
-        action: Optional[Literal["addToLibrary", "removeFromLibrary"]] = "addToLibrary",
+        action: Literal["addToLibrary", "removeFromLibrary"] = "addToLibrary",
     ) -> None:
         if not self._login:
             raise ValueError("Must be logged in")
@@ -122,7 +121,6 @@ class Artist:
 
         resp = self.base.client.post(url, json=payload, authenticate=True)
 
-
         if resp.fail:
             raise ArtistError("Could not follow artist", error=resp.error.string)
 

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/client.py

@@ -11,7 +11,7 @@ class BaseClient:
     """
     A base class that all the Spotify classes extend.
     This base class contains all the common methods used by the Spotify classes.
-    
+
     NOTE: Should not be used directly. Use the Spotify classes instead.
     """
 
@@ -45,9 +45,9 @@ class BaseClient:
         if self.access_token is None:
             self.get_session()
 
-        if not ("headers" in kwargs):
+        if "headers" not in kwargs:
             kwargs["headers"] = {}
-            
+
         assert self.access_token is not None, "Access token is None"
         kwargs["headers"].update(
             {
@@ -67,7 +67,6 @@ class BaseClient:
             },
         )
 
-
         if resp.fail:
             raise BaseClientError("Could not get session", error=resp.error.string)
 
@@ -107,7 +106,6 @@ class BaseClient:
 
         resp = self.client.post(url, json=payload, headers=headers)
 
-
         if resp.fail:
             raise BaseClientError("Could not get client token", error=resp.error.string)
 
@@ -124,7 +122,7 @@ class BaseClient:
     def part_hash(self, name: str) -> str:
         if self.raw_hashes is None:
             self.get_sha256_hash()
-            
+
         if self.raw_hashes is None:
             raise ValueError("Could not get playlist hashes")
 
@@ -136,20 +134,19 @@ class BaseClient:
     def get_sha256_hash(self) -> None:
         if self.js_pack is None:
             self.get_session()
-            
+
         if self.js_pack is None:
             raise ValueError("Could not get playlist hashes")
 
         resp = self.client.get(self.js_pack)
 
-
         if resp.fail:
             raise BaseClientError(
                 "Could not get playlist hashes", error=resp.error.string
             )
 
         assert isinstance(resp.response, str), "Invalid HTML response"
-        
+
         self.raw_hashes = resp.response
         self.client_version = resp.response.split('clientVersion:"')[1].split('"')[0]
         # Maybe it's static? Let's not take chances.
@@ -163,7 +160,6 @@ class BaseClient:
             f"https://open.spotifycdn.com/cdn/build/web-player/xpui-routes-search.{self.xpui_route}.js"
         )
 
-
         if resp.fail:
             raise BaseClientError("Could not get xpui hashes", error=resp.error.string)
 

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/creator.py

@@ -1,6 +1,5 @@
 import time
 import uuid
-from typing import Optional
 from spotapi.types import Config
 from spotapi.exceptions import GeneratorError
 from spotapi.http.request import TLSClient
@@ -20,11 +19,13 @@ class Creator:
     def __init__(
         self,
         cfg: Config,
-        email: Optional[str] = random_email(),
-        password: Optional[str] = random_string(10, True),
+        email: str = random_email(),
+        display_name: str = random_string(10),
+        password: str = random_string(10, True),
     ) -> None:
         self.email = email
         self.password = password
+        self.display_name = display_name
         self.cfg = cfg
 
         self.client = self.cfg.client
@@ -34,7 +35,6 @@ class Creator:
         url = "https://www.spotify.com/ca-en/signup"
         resp = self.client.get(url)
 
-
         if resp.fail:
             raise GeneratorError("Could not get session", error=resp.error.string)
 
@@ -52,7 +52,7 @@ class Creator:
                     "send_email": True,
                     "third_party_email": False,
                 },
-                "display_name": "Aran",
+                "display_name": self.display_name,
                 "email_and_password_identifier": {
                     "email": self.email,
                     "password": self.password,
@@ -80,7 +80,6 @@ class Creator:
 
         resp = self.client.post(url, json=payload)
 
-
         if resp.fail:
             raise GeneratorError(
                 "Could not process registration", error=resp.error.string
@@ -92,7 +91,6 @@ class Creator:
 
     def register(self) -> None:
         self.__get_session()
-        # Pylance keeps complaining about self keyword. I don't know why.
         captcha_token = self.cfg.solver.solve_captcha(
             "https://www.spotify.com/ca-en/signup",
             "6LfCVLAUAAAAALFwwRnnCJ12DalriUGbj8FW_J39",
@@ -114,7 +112,6 @@ class AccountChallenge:
         payload = {"session_id": self.session_id}
         resp = self.client.post(url, json=payload)
 
-
         if resp.fail:
             raise GeneratorError(
                 "Could not get challenge session", error=resp.error.string
@@ -139,11 +136,8 @@ class AccountChallenge:
             },
         )
 
-
         if resp.fail:
-            raise GeneratorError(
-                "Could not submit challenge", error=resp.error.string
-            )
+            raise GeneratorError("Could not submit challenge", error=resp.error.string)
 
     def __complete_challenge(self) -> None:
         url = (
@@ -152,13 +146,12 @@ class AccountChallenge:
         payload = {"session_id": self.session_id}
         resp = self.client.post(url, json=payload)
 
-
         if resp.fail:
             raise GeneratorError(
                 "Could not complete challenge", error=resp.error.string
             )
 
-        if not ("success" in resp.response):
+        if "success" not in resp.response:
             raise GeneratorError("Could not complete challenge", error=resp.response)
 
     def defeat_challenge(self) -> None:

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/family.py

@@ -27,7 +27,6 @@ class JoinFamily:
         url = f"https://www.spotify.com/ca-en/family/join/address/{self.invite_token}/"
         resp = self.client.get(url)
 
-
         if resp.fail:
             raise FamilyError("Could not get session", error=resp.error.string)
 
@@ -42,7 +41,6 @@ class JoinFamily:
         }
         resp = self.client.post(url, headers={"X-Csrf-Token": self.csrf}, json=payload)
 
-
         if resp.fail:
             raise FamilyError("Could not get address", error=resp.error.string)
 
@@ -57,7 +55,6 @@ class JoinFamily:
         }
         resp = self.client.post(url, headers={"X-Csrf-Token": self.csrf}, json=payload)
 
-
         self.csrf = resp.raw.headers.get("X-Csrf-Token")
         if resp.fail:
             return False
@@ -83,7 +80,6 @@ class JoinFamily:
         }
         resp = self.client.post(url, headers={"X-Csrf-Token": self.csrf}, json=payload)
 
-
         if resp.fail:
             raise FamilyError("Could not add to family", error=resp.error.string)
 
@@ -109,7 +105,6 @@ class Family(User):
         url = "https://www.spotify.com/api/family/v1/family/home/"
         resp = self.login.client.get(url)
 
-
         if resp.fail:
             raise FamilyError("Could not get user plan info", error=resp.error.string)
 

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/http/request.py

@@ -14,7 +14,9 @@ from spotapi.http.data import Response
 
 class StdClient(requests.Session):
     def __init__(
-        self, auto_retries: int = 0, auth_rule: Callable[[dict[Any, Any]], dict] | None = None
+        self,
+        auto_retries: int = 0,
+        auth_rule: Callable[[dict[Any, Any]], dict] | None = None,
     ) -> None:
         super().__init__()
         self.auto_retries = auto_retries + 1
@@ -54,7 +56,7 @@ class StdClient(requests.Session):
 
     def request(
         self, method: str, url: str, *, authenticate: bool = False, **kwargs
-    ) -> Union[Response, None]:
+    ) -> Response:
         if authenticate and self.authenticate:
             kwargs = self.authenticate(kwargs)
 
@@ -62,20 +64,16 @@ class StdClient(requests.Session):
 
         if response is not None:
             return self.parse_response(response)
+        else:
+            raise RequestError("Request kept failing after retries.")
 
-    def post(
-        self, url: str, *, authenticate: bool = False, **kwargs
-    ) -> Union[Response, None]:
+    def post(self, url: str, *, authenticate: bool = False, **kwargs) -> Response:
         return self.request("POST", url, authenticate=authenticate, **kwargs)
 
-    def get(
-        self, url: str, *, authenticate: bool = False, **kwargs
-    ) -> Union[Response, None]:
+    def get(self, url: str, *, authenticate: bool = False, **kwargs) -> Response:
         return self.request("GET", url, authenticate=authenticate, **kwargs)
 
-    def put(
-        self, url: str, *, authenticate: bool = False, **kwargs
-    ) -> Union[Response, None]:
+    def put(self, url: str, *, authenticate: bool = False, **kwargs) -> Response:
         return self.request("PUT", url, authenticate=authenticate, **kwargs)
 
 
@@ -127,7 +125,7 @@ class TLSClient(Session):
         is_dict = True
 
         try:
-            json.loads(body) # type: ignore
+            json.loads(body)  # type: ignore
         except json.JSONDecodeError:
             is_dict = False
 
@@ -140,8 +138,10 @@ class TLSClient(Session):
 
         # Why is status_code a None type...
         assert response.status_code is not None, "Status Code is None"
-        
-        resp = Response(status_code=int(response.status_code), response=body, raw=response)
+
+        resp = Response(
+            status_code=int(response.status_code), response=body, raw=response
+        )
 
         if danger and self.fail_exception and resp.fail:
             raise self.fail_exception(
@@ -151,9 +151,7 @@ class TLSClient(Session):
 
         return resp
 
-    def get(
-        self, url: str, *, authenticate: bool = False, **kwargs
-    ) -> Response:
+    def get(self, url: str, *, authenticate: bool = False, **kwargs) -> Response:
         """Routes a GET Request"""
         if authenticate and self.authenticate is not None:
             kwargs = self.authenticate(kwargs)

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/login.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import time
-from typing import Any, Mapping, Optional, Type
+from typing import Any, Mapping, Optional
 from urllib.parse import urlencode
 
 from spotapi.types import Config, SaverProtocol
@@ -55,19 +55,31 @@ class Login:
             ]
         )
 
-
     @classmethod
     def from_cookies(cls, dump: Mapping[str, Any], cfg: Config) -> Login:
         """
         Constructs a Login instance using cookie data and configuration.
         """
         password = dump.get("password")
+        password = "" if password is None else password
+
         cred = dump.get("identifier")
-        cookies: Mapping[str, Any] = dict(dump.get("cookies")) # type: ignore
+        cookies = dump.get("cookies")
+
+        if isinstance(cookies, str):
+            _cookies = cookies.strip().split(";")
+            cookies = {}
+
+            for cookie in _cookies:
+                k, v = cookie.split("=")
+                cookies[k] = v
+
+        if isinstance(cookies, Mapping):
+            cookies = cookies  # autotype
 
-        if not (password and cred and cookies):
+        if not (cred and cookies):
             raise ValueError(
-                "Invalid dump format: must contain 'password', 'identifier', and 'cookies'"
+                "Invalid dump format: must contain 'identifier', and 'cookies'"
             )
 
         cfg.client.cookies.clear()
@@ -80,13 +92,10 @@ class Login:
         return instantiated
 
     @classmethod
-    def from_saver(
-        cls, saver: SaverProtocol, cfg: Config, identifier: str
-    ) -> Login:
+    def from_saver(cls, saver: SaverProtocol, cfg: Config, identifier: str) -> Login:
         """
         Loads a session from a Saver Class.
-
-        Note: Kwargs are not used, make sure the defaults for the savers are what you want (or just implement this method yourself).
+        NOTE: Kwargs are not used, make sure the defaults for the savers are what you want (or just implement this method yourself).
         """
         dump = saver.load(query={"identifier": identifier})
         return cls.from_cookies(dump, cfg)
@@ -110,7 +119,7 @@ class Login:
 
         if resp.fail:
             raise LoginError("Could not get session", error=resp.error.string)
-        
+
         self.csrf_token = resp.raw.cookies.get("sp_sso_csrf_token")
         self.flow_id = parse_json_string(resp.response, "flowCtx")
 
@@ -156,7 +165,7 @@ class Login:
             # json_data will still be bad, but we know we are logged in now
             return
 
-        if not ("error" in json_data):
+        if "error" not in json_data:
             raise LoginError(f"Unexpected response format: {json_data}")
 
         error_type = json_data["error"]
@@ -173,6 +182,9 @@ class Login:
 
     def login(self) -> None:
         """Logins the user"""
+        if self.logged_in:
+            raise LoginError("User already logged in")
+
         now = time.time()
         self.__get_session()
 
@@ -219,7 +231,7 @@ class LoginChallenge:
             "accounts/login",
             "v3",
         )
- 
+
         if not captcha_response:
             raise LoginError("Could not solve captcha")
 
@@ -248,7 +260,6 @@ class LoginChallenge:
         if resp.fail:
             raise LoginError("Could not submit challenge", error=resp.error.string)
 
-
         if not isinstance(resp.response, Mapping):
             raise LoginError("Invalid JSON")
 
@@ -269,4 +280,4 @@ class LoginChallenge:
     def defeat(self) -> None:
         self.__get_challenge()
         self.__submit_challenge()
-        self.__complete_challenge()  
+        self.__complete_challenge()

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/password.py

@@ -31,7 +31,6 @@ class Password:
         url = "https://accounts.spotify.com/en/password-reset"
         resp = self.client.get(url)
 
-
         if resp.fail:
             raise PasswordError("Could not get session", error=resp.error.string)
 
@@ -51,7 +50,6 @@ class Password:
 
         resp = self.client.post(url, data=payload, headers=headers)
 
-
         if resp.fail:
             raise PasswordError("Could not reset password", error=resp.error.string)
 

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/playlist.py

@@ -34,7 +34,7 @@ class PublicPlaylist:
             self.playlist_link = f"https://open.spotify.com/playlist/{self.playlist_id}"
 
     def get_playlist_info(
-        self, limit: Optional[int] = 25, *, offset: Optional[int] = 0
+        self, limit: int = 25, *, offset: int = 0
     ) -> Mapping[str, Any]:
         """Gets the public playlist information"""
         if not self.playlist_id:
@@ -165,7 +165,6 @@ class PrivatePlaylist:
 
         resp = self.login.client.post(url, json=payload, authenticate=True)
 
-
         if resp.fail:
             raise PlaylistError(
                 "Could not add playlist to library", error=resp.error.string
@@ -211,7 +210,7 @@ class PrivatePlaylist:
         # They are the same requests
         return self.remove_from_library()
 
-    def get_library(self, limit: Optional[int] = 50) -> Mapping[str, Any]:
+    def get_library(self, limit: int = 50, /) -> Mapping[str, Any]:
         """Gets all the playlists in your library"""
         url = "https://api-partner.spotify.com/pathfinder/v1/query"
         params = {

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/solvers/capmonster.py

@@ -12,10 +12,10 @@ class Capmonster:
     def __init__(
         self,
         api_key: str,
-        client: Optional[StdClient] = StdClient(3),
+        client: StdClient = StdClient(3),
         *,
+        retries: int = 120,
         proxy: Optional[str] = None,
-        retries: Optional[int] = 120,
     ) -> None:
         self.api_key = api_key
         self.client = client
@@ -27,7 +27,7 @@ class Capmonster:
         self.client.authenticate = lambda kwargs: self._auth_rule(kwargs)
 
     def _auth_rule(self, kwargs: dict) -> dict:
-        if not ("json" in kwargs):
+        if "json" not in kwargs:
             kwargs["json"] = {}
 
         kwargs["json"]["clientKey"] = self.api_key
@@ -89,7 +89,7 @@ class Capmonster:
 
         return str(resp["taskId"])
 
-    def _harvest_task(self, task_id: str, retries: int) -> str | None:
+    def _harvest_task(self, task_id: str, retries: int) -> str:
         for _ in range(retries):
             payload = {"taskId": task_id}
             endpoint = self.BaseURL + "getTaskResult"

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/solvers/capsolver.py

@@ -1,6 +1,5 @@
-import json
 import time
-from typing import Literal, Optional
+from typing import Literal, Optional, Dict, Any
 
 from spotapi.exceptions import CaptchaException, SolverError
 from spotapi.http.request import StdClient
@@ -12,10 +11,10 @@ class Capsolver:
     def __init__(
         self,
         api_key: str,
-        client: Optional[StdClient] = StdClient(3),
+        client: StdClient = StdClient(3),
         *,
+        retries: int = 120,
         proxy: Optional[str] = None,
-        retries: Optional[int] = 120,
     ) -> None:
         self.api_key = api_key
         self.client = client
@@ -25,7 +24,7 @@ class Capsolver:
         self.client.authenticate = lambda kwargs: self._auth_rule(kwargs)
 
     def _auth_rule(self, kwargs: dict) -> dict:
-        if not ("json" in kwargs):
+        if "json" not in kwargs:
             kwargs["json"] = {}
 
         kwargs["json"]["clientKey"] = self.api_key
@@ -63,7 +62,7 @@ class Capsolver:
             if proxy
             else "ReCaptcha{}EnterpriseTaskProxyLess"
         ).format(task.upper())
-        payload = {
+        payload: Dict[str, Dict[str, Any]] = {
             "task": {
                 "type": task_type,
                 "websiteURL": url,
@@ -92,7 +91,7 @@ class Capsolver:
 
         return str(resp["taskId"])
 
-    def _harvest_task(self, task_id: str, retries: int) -> str | None:
+    def _harvest_task(self, task_id: str, retries: int) -> str:
         for _ in range(retries):
             payload = {"taskId": task_id}
             endpoint = self.BaseURL + "getTaskResult"

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/song.py

@@ -17,16 +17,17 @@ class Song:
         self,
         playlist: Optional[PrivatePlaylist] = None,
         *,
-        client: Optional[TLSClient] = TLSClient("chrome_120", "", auto_retries=3),
+        client: TLSClient = TLSClient("chrome_120", "", auto_retries=3),
     ) -> None:
         self.playlist = playlist
-        self.base = BaseClient(client=playlist.client if (playlist is not None) else client) # type: ignore
+        self.base = BaseClient(client=playlist.client if (playlist is not None) else client)  # type: ignore
 
     def query_songs(
-        self, query: str, /, limit: Optional[int] = 10, *, offset: Optional[int] = 0
+        self, query: str, /, limit: int = 10, *, offset: int = 0
     ) -> Mapping[str, Any]:
         """
         Searches for songs in the Spotify catalog.
+        NOTE: Returns the raw result unlike paginate_songs which only returns the songs.
         """
         url = "https://api-partner.spotify.com/pathfinder/v1/query"
         params = {
@@ -117,7 +118,7 @@ class Song:
     def __stage_remove_song(self, uids: List[str]) -> None:
         # If None, something internal went wrong
         assert self.playlist is not None, "Playlist not set"
-        
+
         url = "https://api-partner.spotify.com/pathfinder/v1/query"
         payload = {
             "variables": {
@@ -143,9 +144,10 @@ class Song:
     def __parse_playlist_items(
         self,
         items: List[Mapping[str, Any]],
+        *,
         song_id: Optional[str] = None,
         song_name: Optional[str] = None,
-        all_instances: Optional[bool] = False,
+        all_instances: bool = False,
     ) -> Tuple[List[str], bool]:
         uids: List[str] = []
         for item in items:
@@ -166,10 +168,10 @@ class Song:
     def remove_song_from_playlist(
         self,
         *,
+        all_instances: bool = False,
         uid: Optional[str] = None,
         song_id: Optional[str] = None,
         song_name: Optional[str] = None,
-        all_instances: Optional[bool] = False,
     ) -> None:
         """
         Removes a song from the playlist.

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/types/__init__.py

@@ -2,21 +2,22 @@ from .data import Config
 from .interfaces import CaptchaProtocol, LoggerProtocol, SaverProtocol
 from typing import Any, Dict, Type, Set
 
+
 class FilterInheritedMeta(type):
     def __new__(
-        cls: Type['FilterInheritedMeta'], 
-        name: str, 
-        bases: tuple, 
-        class_dict: Dict[str, Any]
+        cls: Type["FilterInheritedMeta"],
+        name: str,
+        bases: tuple,
+        class_dict: Dict[str, Any],
     ) -> Type:
         new_class_dict: Dict[str, Any] = {}
         base_attrs: Set[str] = set()
 
         for base in bases:
             base_attrs.update(dir(base))
-        
+
         for key, value in class_dict.items():
             if key not in base_attrs:
                 new_class_dict[key] = value
-        
+
         return super().__new__(cls, name, bases, new_class_dict)

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/types/interfaces.py

@@ -8,13 +8,13 @@ class CaptchaProtocol(Protocol):
     def __init__(
         self: "CaptchaProtocol",
         api_key: str,
-        client: Optional[StdClient] = StdClient(3),
+        client: StdClient = StdClient(3),
         *,
+        retries: int = 120,
         proxy: Optional[str] = None,
-        retries: Optional[int] = 120,
     ) -> None:
         ...
-    
+
     def get_balance(self: "CaptchaProtocol") -> float | None:
         ...
 
@@ -49,15 +49,15 @@ class LoggerProtocol(Protocol):
 
 @runtime_checkable
 class SaverProtocol(Protocol):
-    def __init__(
-        self: "SaverProtocol", *args, **kwargs
-    ) -> None:
+    def __init__(self: "SaverProtocol", *args, **kwargs) -> None:
         ...
-        
+
     def save(self: "SaverProtocol", data: List[Mapping[str, Any]], **kwargs) -> None:
         ...
 
-    def load(self: "SaverProtocol", query: Mapping[str, Any], **kwargs) -> Mapping[str, Any]:
+    def load(
+        self: "SaverProtocol", query: Mapping[str, Any], **kwargs
+    ) -> Mapping[str, Any]:
         ...
 
     def delete(self: "SaverProtocol", query: Mapping[str, Any], **kwargs) -> None:

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/user.py

@@ -14,7 +14,7 @@ class User:
     def __init__(self, login: Login) -> None:
         if not login.logged_in:
             raise ValueError("Must be logged in")
-        
+
         self.login = login
         self._user_plan: Mapping[str, Any] | None = None
         self._user_info: Mapping[str, Any] | None = None
@@ -29,7 +29,7 @@ class User:
     @property
     def username(self) -> str:
         if self._user_info is None:
-           self._user_info = self.get_user_info()
+            self._user_info = self.get_user_info()
 
         return self._user_info["profile"]["username"]
 
@@ -38,7 +38,6 @@ class User:
         url = "https://www.spotify.com/ca-en/api/account/v2/plan/"
         resp = self.login.client.get(url)
 
-
         if resp.fail:
             raise UserError("Could not get user plan info", error=resp.error.string)
 
@@ -56,14 +55,12 @@ class User:
             raise e
         else:
             return True
-        
 
     def get_user_info(self) -> Mapping[str, Any]:
         """Gets accounts user info."""
         url = "https://www.spotify.com/api/account-settings/v1/profile"
         resp = self.login.client.get(url)
 
-
         if resp.fail:
             raise UserError("Could not get user info", error=resp.error.string)
 
@@ -109,6 +106,5 @@ class User:
 
         resp = self.login.client.put(url, json=dump, headers=headers)
 
-
         if resp.fail:
             raise UserError("Could not edit  user info", error=resp.error.string)

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/utils/saver.py

@@ -277,9 +277,7 @@ class MongoSaver(SaverProtocol):
 
 
 class RedisSaver(SaverProtocol):
-    def __init__(
-        self, host: str = "localhost", port: int = 6379, db: int = 0
-    ) -> None:
+    def __init__(self, host: str = "localhost", port: int = 6379, db: int = 0) -> None:
         self.client = redis.StrictRedis(host=host, port=port, db=db)
         atexit.register(self.client.close)
 

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi/websocket.py

@@ -35,7 +35,7 @@ class WebsocketStreamer(BaseClient, Login):
         )
 
         self.rlock = threading.Lock()
-        self.ws_dump: dict| None = None
+        self.ws_dump: dict | None = None
 
         if ignore_init_packet:
             self.get_init_packet()
@@ -86,5 +86,4 @@ class WebsocketStreamer(BaseClient, Login):
     def get_player_state(self) -> dict:
         self.get_main_packet()
         payload = self.ws_dump["payload"][0]
-        return payload["cluster"]["player_state"] 
-        
+        return payload["cluster"]["player_state"]

{spotapi-1.0.3 → spotapi-1.0.4/spotapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spotapi
-Version: 1.0.3
+Version: 1.0.4
 Summary: A sleek API wrapper for Spotify's private API
 Home-page: UNKNOWN
 Author: Aran
@@ -8,6 +8,9 @@ License: UNKNOWN
 Keywords: Spotify,API,Spotify API,Spotify Private API,Follow,Like,Creator,Music,Music API,Streaming,Music Data,Track,Playlist,Album,Artist,Music Search,Music Metadata,SpotAPI,Python Spotify Wrapper,Music Automation,Web Scraping,Python Music API,Spotify Integration,Spotify Playlist,Spotify Tracks
 Platform: UNKNOWN
 Description-Content-Type: text/markdown
+Provides-Extra: websocket
+Provides-Extra: redis
+Provides-Extra: pymongo
 License-File: LICENSE
 
 # SpotAPI
@@ -16,6 +19,18 @@ Welcome to SpotAPI! This Python library is designed to interact with the private
 
 **Note**: This project is intended solely for educational purposes and should be used responsibly. Accessing private endpoints and scraping data without proper authorization may violate Spotify's terms of service
 
+## Table of Contents
+
+1. [Introduction](#spotapi)
+2. [Features](#features)
+3. [Installation](#installation)
+4. [Import Cookies](#import-cookies)
+5. [Quick Examples](#quick-examples)
+6. [Contributing](#contributing)
+7. [Roadmap](#roadmap)
+8. [License](#license)
+
+
 ## Features
 - **Public API Access**: Retrieve and manipulate public Spotify data such as playlists, albums, and tracks with ease.
 - **Private API Access**: Explore private Spotify endpoints to tailor your application to your needs.
@@ -31,7 +46,27 @@ Everything you can do with Spotify, **SpotAPI** can do with just a user’s
 pip install spotapi
 ```
 
-## Quick Example
+## Import Cookies
+If you prefer not to use a third party CAPTCHA solver, you can import cookies to manage your session.
+
+### Steps to Import Cookies:
+
+1. **Choose a Session Saver**:
+   - Select a session saver for storing your session data. 
+   - For simplicity, you should use `JSONSaver`, especially if performance or quantity of sessions is not a big concern.
+
+2. **Prepare Session Data**:
+   - Create an object with the following keys:
+     - **`identifier`**: This should be your email address or username.
+     - **`cookies`**: These are the cookies you obtain when logged in. To get these cookies, visit [Spotify](https://open.spotify.com/), log in, and copy the cookies from your browser.
+       - It can be a dict[str, str] or a string representation
+
+3. **Load the Session**:
+   - Use your program to load the session manually with the saved data. This will enable you to use Spotify with a fully functional session without needing additional CAPTCHA solving.
+
+## Quick Examples
+
+### With User Authentication
 ```py
 from spotapi import (
     Login, 
@@ -60,9 +95,51 @@ playlist.create_playlist("SpotAPI Showcase!")
 instance.save(MongoSaver())
 ```
 
+### Without User Authentication
+```py
+"""Here's the example from spotipy https://github.com/spotipy-dev/spotipy?tab=readme-ov-file#quick-start"""
+from spotapi import Song
+
+song = Song()
+gen = song.paginate_songs("weezer")
+
+# Paginates 100 songs at a time till there's no more
+for batch in gen:
+    for idx, item in enumerate(batch):
+        print(idx, item['item']['data']['name'])
+    
+# ^ ONLY 6 LINES OF CODE
+
+# Alternatively, you can query a specfic amount
+songs = song.query_songs("weezer", limit=20)
+data = songs["data"]["searchV2"]["tracksV2"]["items"]
+for idx, item in enumerate(data):
+    print(idx, item['item']['data']['name'])
+```
+### Results
+```
+0 Island In The Sun
+1 Say It Ain't So
+2 Buddy Holly
+.
+.
+.
+18 Holiday
+19 We Are All On d***s
+```
+
 ## Contributing
 Contributions are welcome! If you find any issues or have suggestions, please open an issue or submit a pull request.
 
+## Roadmap
+> I'll most likely do these if the project gains some traction
+
+- [ ] No Captcha For Login (**100 Stars**)
+- [ ] In Depth Documentation
+- [ ] Websocket Listener (Is not working ATM)
+- [ ] Player
+- [ ] More wrappers around this project
+
 ## License
 This project is licensed under the **GPL 3.0** License. See [LICENSE](https://choosealicense.com/licenses/gpl-3.0/) for details.
 

{spotapi-1.0.3 → spotapi-1.0.4}/spotapi.egg-info/requires.txt

@@ -1,10 +1,16 @@
 requests
 colorama
 Pillow
-pymongo
 readerwriterlock
-redis
 tls_client
 typing_extensions
 validators
+
+[pymongo]
+pymongo
+
+[redis]
+redis
+
+[websocket]
 websockets

spotapi-1.0.3/README.md

@@ -1,56 +0,0 @@
-# SpotAPI
-
-Welcome to SpotAPI! This Python library is designed to interact with the private and public Spotify APIs, emulating the requests typically made through a web browser. This wrapper provides a convenient way to access Spotify’s rich set of features programmatically.
-
-**Note**: This project is intended solely for educational purposes and should be used responsibly. Accessing private endpoints and scraping data without proper authorization may violate Spotify's terms of service
-
-## Features
-- **Public API Access**: Retrieve and manipulate public Spotify data such as playlists, albums, and tracks with ease.
-- **Private API Access**: Explore private Spotify endpoints to tailor your application to your needs.
-- **Ready to Use**: **SpotAPI** is designed for immediate integration, allowing you to accomplish tasks with just a few lines of code.
-- **No API Key Required**: Seamlessly use **SpotAPI** without needing a Spotify API key. It’s straightforward and hassle free!
-- **Browser-like Requests**: Accurately replicate the HTTP requests Spotify makes in the browser, providing a true to web experience while remaining undetected.
-
-Everything you can do with Spotify, **SpotAPI** can do with just a user’s login credentials.
-
-
-## Installation
-```
-pip install spotapi
-```
-
-## Quick Example
-```py
-from spotapi import (
-    Login, 
-    Config, 
-    NoopLogger, 
-    solver_clients, 
-    PrivatePlaylist, 
-    MongoSaver
-)
-
-cfg = Config(
-    solver=solver_clients.Capsolver("YOUR_API_KEY", proxy="YOUR_PROXY"), # Proxy is optional
-    logger=NoopLogger(),
-    # You can add a proxy by passing a custom TLSClient
-)
-
-instance = Login(cfg, "YOUR_PASSWORD", email="YOUR_EMAIL")
-# Now we have a valid Login instance to pass around
-instance.login()
-
-# Do whatever you want now
-playlist = PrivatePlaylist(instance)
-playlist.create_playlist("SpotAPI Showcase!")
-
-# Save the session
-instance.save(MongoSaver())
-```
-
-## Contributing
-Contributions are welcome! If you find any issues or have suggestions, please open an issue or submit a pull request.
-
-## License
-This project is licensed under the **GPL 3.0** License. See [LICENSE](https://choosealicense.com/licenses/gpl-3.0/) for details.
-