spotapi 1.2.7__tar.gz → 2.0.0b1__tar.gz

spotapi-2.0.0b1/.gitignore

@@ -0,0 +1,166 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.vscode/
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+main.py
+build.bat
+sessions.json

spotapi-2.0.0b1/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+All notable changes to SpotAPI are documented here.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+SpotAPI adheres to [Semantic Versioning](https://semver.org/).
+
+---
+
+## [Unreleased] — `async-v2` beta
+
+### Added
+
+- **Full async rewrite** — every public method is now a coroutine or
+  `AsyncGenerator`. No sync wrappers, no `asyncio.run()` hidden inside the
+  library.
+- **`Public` search generators** — `search_tracks`, `search_artists`,
+  `search_albums`, `search_playlists`, `search_podcasts` all return
+  `AsyncGenerator[Sequence[T]]` and paginate automatically.
+- **Typed data wrappers** — `Track`, `Artist`, `Album`, `Playlist`, `Podcast`
+  are fully typed `@dataclass(slots=True)` classes with `__repr__`.
+- **Shared visual types** — `_common.py` extracts the repeated color/theme
+  structs that Spotify returns on every entity, eliminating ~300 lines of
+  duplication across the data wrapper modules.
+- **`from_dict` deserializer** — recursive, camelCase-aware dataclass factory
+  with `lru_cache`-backed annotation resolution.
+- **`ObjectDict`** — attribute-access `dict` subclass for ergonomic raw JSON
+  traversal, with optional thread-safe write locking.
+- **`Pool[T]`** — generic async object pool with factory, pre-warm, capped
+  eviction, and teardown callbacks.
+- **`EventDispatcher`** — async event system used by `WebSocketClient`.
+- **`WebSocketClient`** — async WebSocket wrapper with heartbeat manager,
+  `@event` decorator, and `asynccontextmanager`-based connection lifecycle.
+- **`HTTPClient`** — `wreq`-backed HTTP client with:
+  - Exponential backoff + jitter retry strategy.
+  - Randomised browser profile emulation (Chrome, Edge, Firefox, Opera).
+  - Randomised OS emulation (Windows 30×, macOS 6×, Linux 2×).
+  - Shared `ClientPool` for connection reuse.
+- **`BundleSession`** — parses Spotify's HTML to extract JS bundle URLs,
+  fetches and caches them, and derives persisted query hashes.
+- **`AuthSession`** — TOTP-based access token + client token acquisition with
+  a background auto-refresh task. No CAPTCHA solver required.
+- **`timed_cache`** — TTL-aware async/sync cache decorator used for the
+  expensive bundle-fetch step.
+- **Five loggers**: `LoggerColour`, `StandardLogger`, `NoopLogger`,
+  `InbuiltLogger`, `JsonLogger`, and `MultiLogger` fan-out — all implementing
+  `LoggerProtocol`.
+- **`py.typed` marker** — signals full PEP 561 type-checker support.
+- `pyproject.toml` replaces `setup.py`.
+
+### Fixed
+
+- `types/__init__.py` had duplicate star imports causing symbols to be
+  registered twice; replaced with explicit named imports.
+- `utils/__init__.py` used a broken double-import pattern that shadowed the
+  module-level `__all__`; replaced with explicit named imports.
+- `Pool.put()` called the deprecated `asyncio.get_event_loop()` (deprecated
+  in Python 3.11); replaced with `asyncio.get_running_loop()`.
+- `_BaseLogger.log()` acquired the threading lock then returned early without
+  releasing it when `is_enabled()` was `False`; replaced the manual
+  acquire/release with a `with` statement via `contextlib.nullcontext`.
+- `totp.py` had an unreachable `return FALLBACK` statement after a
+  `raise RuntimeError`; removed the dead code.
+- Data wrappers (`track.py`, `artist.py`, `album.py`, `playlist.py`,
+  `podcast.py`) each redefined identical color/theme dataclasses; extracted
+  to `_common.py` and imported from there.
+
+### Changed
+
+- Package layout reorganised into `connection/`, `datastruct/`,
+  `specialized/`, `types/`, `utils/` sub-packages.
+- `setup.py` replaced by `pyproject.toml` (Hatchling build backend).
+- Minimum Python version raised from 3.11 to **3.11**.
+
+### Removed
+
+- `annotations.py` runtime type-enforcement decorator (`@enforce_types`,
+  `@enforce`) — moved to a dev-only tool; it has no callers in v2 and
+  imposes overhead on every method call.
+- `parse_json_string` from `utils/strings.py` — v1 leftover with no callers
+  in v2 (Spotify's `correlationId` is now parsed via the `appServerConfig`
+  base64 blob).
+- `setup.py`, `requirements.txt` — superseded by `pyproject.toml`.
+
+---
+
+## [1.2.8] — 2026-06-14 *(latest stable)*
+
+> See the [main branch](https://github.com/Aran404/SpotAPI/tree/main) for the
+> v1 changelog.

spotapi-2.0.0b1/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+Email: aransservices1@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

spotapi-2.0.0b1/CONTRIBUTING.md

@@ -0,0 +1,247 @@
+# Contributing to SpotAPI
+
+Thank you for your interest in contributing to SpotAPI! This document covers
+everything you need to get set up, the conventions used in v2, and the
+tasks that are open for contribution right now.
+
+---
+
+## Table of contents
+
+- [Code of conduct](#code-of-conduct)
+- [Quick setup](#quick-setup)
+- [Branch layout](#branch-layout)
+- [What needs doing](#what-needs-doing)
+- [Good first issues](#good-first-issues)
+- [Conventions](#conventions)
+- [Submitting a pull request](#submitting-a-pull-request)
+- [Running tests](#running-tests)
+- [Running the linter](#running-the-linter)
+
+---
+
+## Code of conduct
+
+This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md). Please
+read it before participating.
+
+---
+
+## Quick setup
+
+```bash
+# 1. Fork the repo on GitHub, then clone your fork
+git clone https://github.com/Aran404/SpotAPI
+cd SpotAPI
+
+# 2. Check out the active development branch
+git checkout async-v2
+
+# 3. Install the package in editable mode with dev extras
+pip install -e ".[dev]"
+```
+
+Python **3.11 or later** is required. We recommend using
+[`pyenv`](https://github.com/pyenv/pyenv) to manage versions.
+
+---
+
+## Branch layout
+
+| Branch | Purpose |
+|---|---|
+| `main` | Stable v1 releases — do not target PRs here for v2 work |
+| `async-v2` | Active v2 development — **target all v2 PRs here** |
+
+---
+
+## What needs doing
+
+The async rewrite is in progress. The public search layer is complete. The 
+following items are not exhaustive but represent the next areas to tackle, roughly in priority order:
+
+### High priority
+
+#### Many of these will be coded by me in the coming few days-weeks.
+
+- [ ] **Private playlist management** — `create_playlist`, `add_track`,
+      `remove_track`, `edit_playlist`
+- [ ] **Player control** — `play`, `pause`, `skip`, `seek`, `set_volume`,
+      `set_repeat`, `set_shuffle`
+- [ ] **Websocket Handler** - `current_state`, `next_state`, `prev_state`
+
+
+### Medium priority
+
+- [ ] **async test suite** — `pytest-asyncio` tests for public search,
+      `Pool`, `ObjectDict`, `EventDispatcher`, `timed_cache`
+- [ ] **Additional search methods** in `public.py` — see
+      [good first issues](#good-first-issues) below
+- [ ] **User profile** — `get_profile`, `follow_artist`, `follow_user`
+- [ ] **MkDocs documentation site** — docstrings already exist, just needs
+      the `mkdocs.yml` + `docs/` pages wired up 
+
+### Lower priority
+
+- [ ] **Family plan management** (`Family`) async port
+- [ ] **Password reset** (`Password`) async port
+
+---
+
+## Good first issues
+
+These are self-contained additions that follow an established pattern in the
+codebase. Each one is approximately 8–12 lines of code.
+
+The existing `search_tracks`, `search_artists`, `search_albums`,
+`search_podcasts`, and `search_playlists` methods in `v2/public.py` all follow
+this pattern:
+
+```python
+@staticmethod
+async def search_tracks(query: str, /) -> AsyncGenerator[Sequence[Track]]:
+    """Search for tracks matching *query*.
+
+    Parameters
+    ----------
+    query : str
+        Free-text search query.
+
+    Yields
+    ------
+    Sequence[Track]
+        One page of :class:`~spotapi.v2.specialized.data_wrappers.track.Track` results.
+    """
+    async for page in Public.search(Track, Operations.SEARCH_TRACKS, query):
+        yield page
+```
+
+The following methods still need implementation following the existing pattern. Each issue identifies the operation enum value 
+and the data wrapper type to use. The list below is not exhaustive, and additional methods may need to be implemented.
+
+| GitHub issue | Method to add | `Operations` enum | Return type |
+|---|---|---|---|
+| [#GFI-1] | `search_users` | `SEARCH_USERS` | Needs a `User` data wrapper |
+| [#GFI-2] | `search_audiobooks` | `SEARCH_AUDIOBOOKS` | Needs an `Audiobook` data wrapper |
+| [#GFI-3] | `search_episodes` | `SEARCH_EPISODES` | Needs an `Episode` data wrapper |
+| [#GFI-4] | `search_top_results` | `SEARCH_TOP_RESULTS` | `ObjectDict` (raw) |
+
+**To contribute one of these:**
+
+1. Create the data wrapper in `v2/specialized/data_wrappers/<type>.py`
+   following the existing wrappers as a template. Include `__repr__`.
+2. Import it in `v2/specialized/data_wrappers/__init__.py` and add it to
+   `__all__`.
+3. Add the static method to `Public` in `v2/public.py` with a NumPy-style
+   docstring.
+4. Add it to `__all__` in `v2/public.py`.
+5. Open a PR targeting `async-v2`.
+
+---
+
+## Conventions
+
+### Style
+
+SpotAPI v2 is formatted with **Black** (formatter) and **Pyright** (strict). Run it before
+committing:
+
+```bash
+black ./
+pyright --strict
+```
+
+### Type annotations
+
+- All public functions and methods must be fully annotated.
+- `from __future__ import annotations` at the top of every file.
+- No `Any` in public API signatures unless unavoidable.
+- Run `mypy v2/` to verify.
+
+### Docstrings
+
+Use **NumPy-style** docstrings (same as discord.py and NumPy itself):
+
+```python
+def my_function(param: str, /, *, flag: bool = False) -> list[str]:
+    """One-line summary ending with a period.
+
+    Optional extended description. May span multiple paragraphs.
+
+    Parameters
+    ----------
+    param : str
+        Description of *param*.
+    flag : bool
+        Description of *flag*. Defaults to ``False``.
+
+    Returns
+    -------
+    list[str]
+        Description of the return value.
+
+    Raises
+    ------
+    ValueError
+        If *param* is empty.
+
+    Examples
+    --------
+    ::
+
+        result = my_function("hello", flag=True)
+    """
+```
+
+### `__all__`
+
+Every module must define `__all__` as an explicit `tuple[str, ...]`. Star
+imports from modules without `__all__` are not permitted.
+
+### `__repr__`
+
+All public data classes must implement `__repr__`. Use angle-bracket format:
+
+```python
+def __repr__(self) -> str:
+    return f"<Track id={self.id!r} name={self.name!r}>"
+```
+
+### Dataclasses
+
+Use `@dataclass(slots=True)` for all data wrappers. Use `frozen=True` for
+immutable value objects (e.g. `ResponseSuccess`, `LogRecord`).
+
+### Commit messages
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+feat(public): add search_users method
+fix(pool): replace deprecated get_event_loop with get_running_loop
+docs(contributing): add good first issue table
+refactor(data_wrappers): extract shared color structs to _common.py
+```
+
+---
+
+## Submitting a pull request
+
+1. Fork the repo and create a branch off `async-v2`:
+   ```bash
+   git checkout -b feat/search-users async-v2
+   ```
+2. Make your changes following the conventions above.
+3. Run the linter and tests:
+   ```bash
+    black ./
+    pyright --strict    
+   ```
+4. Push and open a PR against `async-v2` (not `main`).
+5. Fill in the PR template — include a short description of what you changed
+   and why, and reference the issue number if applicable.
+
+PRs that do not pass one of: `pyright`, `ruff`, or `mypy` will not be reviewed until
+they do.
+
+---

spotapi-2.0.0b1/LEGAL_NOTICE.md

@@ -0,0 +1,46 @@
+## Legal Notice
+
+This repository is in no way affiliated with, authorized, maintained, sponsored or endorsed by Spotify Inc. (spotify.com) or any of its affiliates or subsidiaries. This project is intended **for educational purposes only**.
+
+Please note the following:
+
+## Legal Notice
+
+### **Affiliation Disclaimer**
+The project is intended for educational purposes only. The APIs, services, trademarks, and other intellectual property mentioned in this repository are the property of their respective owners, with no claim of ownership or affiliation by this project.
+
+### **Liability Limitation**
+Under no circumstances shall the author of this repository be liable for any direct, indirect, incidental, special, consequential, or punitive damages, including but not limited to, loss of profits, data, or use, arising out of or in connection with the repository, regardless of whether such damages were foreseeable and whether the author was advised of the possibility of such damages.
+
+### **No Warranties**
+The repository is provided on an "as is" and "as available" basis without any warranties of any kind, either express or implied, including but not limited to, implied warranties of merchantability, fitness for a particular purpose, or non-infringement.
+
+### **User Responsibility**
+Users assume all risk for their use of this repository and are solely responsible for any damage or loss, including but not limited to financial loss, of any kind, to any party, that results from the use or misuse of the repository and its contents.
+
+### **Legal Compliance**
+Users are responsible for ensuring their use of the repository and its contents complies with all local, state, national, and international laws and regulations.
+
+### **Indemnification**
+Users agree to indemnify, defend, and hold harmless the author from any claims, liabilities, damages, losses, or expenses, including legal fees, arising out of or in any way connected with their use of this repository, violation of these terms, or infringement of any intellectual property or other rights of any person or entity.
+
+### **No Endorsement**
+The inclusion of third-party content does not imply endorsement or recommendation of such content by the author.
+
+### **Governing Law and Jurisdiction**
+Any disputes arising out of or related to the use of this repository shall be governed by the laws of the author's jurisdiction, without regard to its conflict of law principles.
+
+### **Severability**
+If any provision of this notice is found to be unlawful, void, or unenforceable, then that provision shall be deemed severable from this notice and shall not affect the validity and enforceability of any remaining provisions.
+
+### **Acknowledgment of Understanding**
+By using this repository, users acknowledge that they have read, understood, and agree to be bound by these terms.
+
+### **Updates and Changes**
+The author reserves the right to modify, update, or remove any content, information, or features in this repository at any time without prior notice. Users are responsible for regularly reviewing the content and any changes made to this repository.
+
+### **Unforeseen Consequences**
+The author of this repository is not responsible for any consequences, damages, or losses arising from the use or misuse of this repository or the content provided by the third-party APIs. Users are solely responsible for their actions and any repercussions that may follow. 
+
+### **Educational Purpose**
+Please note that this project and its content are provided strictly for educational purposes. Users acknowledge that they are using the APIs at their own risk and agree to comply with any applicable laws and regulations.