yutipy 0.1.0__tar.gz → 0.1.1__tar.gz

yutipy-0.1.1/.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: cheapnightbot

yutipy-0.1.1/.github/workflows/pytest-unit-testing.yml

@@ -0,0 +1,43 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Pytest
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

yutipy-0.1.1/.readthedocs.yaml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+   builder: html
+   fail_on_warning: true
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - method: pip
+     path: .
+   - requirements: docs/requirements.txt

{yutipy-0.1.0 → yutipy-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: yutipy
-Version: 0.1.0
+Version: 0.1.1
 Summary: A simple package for retrieving music information from various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>
@@ -53,13 +53,34 @@ Requires-Dist: rapidfuzz==3.12.1
 Requires-Dist: requests==2.32.3
 Requires-Dist: ytmusicapi==1.10.1
 Provides-Extra: dev
-Requires-Dist: pytest==8.3.4; extra == "dev"
-Requires-Dist: Sphinx==8.2.0; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/CheapNightbot/yutipy/main/docs/_static/yutipy_header.png" alt="yutipy" />
 </p>
 
+<p align="center">
+<a href="https://github.com/CheapNightbot/yutipy/actions/workflows/tests.yml">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/cheapnightbot/yutipy/pytest-unit-testing.yml?style=for-the-badge&label=Pytest">
+</a>
+    
+<a href="https://pypi.org/project/yutipy/">
+<img src="https://img.shields.io/pypi/v/yutipy?style=for-the-badge" alt="PyPI" />
+</a>
+<a href="https://yutipy.readthedocs.io/en/latest/">
+<img src="https://img.shields.io/readthedocs/yutipy?style=for-the-badge" alt="Documentation Status" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/blob/master/LICENSE">
+<img src="https://img.shields.io/github/license/CheapNightbot/yutipy?style=for-the-badge" alt="License" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/stargazers">
+<img src="https://img.shields.io/github/stars/CheapNightbot/yutipy?style=for-the-badge" alt="Stars" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/issues">
+<img src="https://img.shields.io/github/issues/CheapNightbot/yutipy?style=for-the-badge" alt="Issues" />
+</a>
+</p>
+
 A _**simple**_ Python package for searching and retrieving music information from various music platforms APIs, including Deezer, iTunes, Spotify, and YouTube Music.
 
 ## Table of Contents
@@ -98,7 +119,7 @@ with Deezer() as deezer:
     print(result)
 ```
 
-For more usage examples, see the [docs](#).
+For more usage examples, see the [Usage Examples](https://yutipy.readthedocs.io/en/latest/usage_examples.html) page in docs.
 
 ## Contributing
 

{yutipy-0.1.0 → yutipy-0.1.1}/README.md

@@ -1,61 +1,83 @@
-<p align="center">
-<img src="https://raw.githubusercontent.com/CheapNightbot/yutipy/main/docs/_static/yutipy_header.png" alt="yutipy" />
-</p>
-
-A _**simple**_ Python package for searching and retrieving music information from various music platforms APIs, including Deezer, iTunes, Spotify, and YouTube Music.
-
-## Table of Contents
-
-- [Features](#features)
-- [Installation](#installation)
-- [Usage Example](#usage-example)
-- [Contributing](#contributing)
-- [License](#license)
-
-## Features
-
-- Simple & Easy integration with popular music APIs.
-- Search for music by artist and song title across multiple platforms.
-- Retrieve detailed music information, including album art, release dates, ISRC, and UPC codes.
-
-## Installation
-
-You can install the package using pip. Make sure you have Python 3.8 or higher installed.
-
-```bash
-pip install -U yutipy
-```
-
-## Usage Example
-
-Here's a quick example of how to use the `yutipy` package to search for a song:
-
-### Deezer
-
-```python
-from yutipy.deezer import Deezer
-
-with Deezer() as deezer:
-    result = deezer.search("Artist Name", "Song Title")
-    print(result)
-```
-
-For more usage examples, see the [docs](#).
-
-## Contributing
-
-Contributions are welcome! Please follow these steps:
-
-1. Fork the repository.
-2. Optionally, create an issue to discuss the changes you plan to make.
-3. Create a new branch linked to that issue.
-4. Make your changes in the new branch.
-5. Write tests if you add new functionality.
-6. Ensure all tests pass before opening a pull request.
-7. Open a pull request for review.
-
-Thank you for your contributions!
-
-## License
-
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+<p align="center">
+<img src="https://raw.githubusercontent.com/CheapNightbot/yutipy/main/docs/_static/yutipy_header.png" alt="yutipy" />
+</p>
+
+<p align="center">
+<a href="https://github.com/CheapNightbot/yutipy/actions/workflows/tests.yml">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/cheapnightbot/yutipy/pytest-unit-testing.yml?style=for-the-badge&label=Pytest">
+</a>
+    
+<a href="https://pypi.org/project/yutipy/">
+<img src="https://img.shields.io/pypi/v/yutipy?style=for-the-badge" alt="PyPI" />
+</a>
+<a href="https://yutipy.readthedocs.io/en/latest/">
+<img src="https://img.shields.io/readthedocs/yutipy?style=for-the-badge" alt="Documentation Status" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/blob/master/LICENSE">
+<img src="https://img.shields.io/github/license/CheapNightbot/yutipy?style=for-the-badge" alt="License" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/stargazers">
+<img src="https://img.shields.io/github/stars/CheapNightbot/yutipy?style=for-the-badge" alt="Stars" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/issues">
+<img src="https://img.shields.io/github/issues/CheapNightbot/yutipy?style=for-the-badge" alt="Issues" />
+</a>
+</p>
+
+A _**simple**_ Python package for searching and retrieving music information from various music platforms APIs, including Deezer, iTunes, Spotify, and YouTube Music.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage Example](#usage-example)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- Simple & Easy integration with popular music APIs.
+- Search for music by artist and song title across multiple platforms.
+- Retrieve detailed music information, including album art, release dates, ISRC, and UPC codes.
+
+## Installation
+
+You can install the package using pip. Make sure you have Python 3.8 or higher installed.
+
+```bash
+pip install -U yutipy
+```
+
+## Usage Example
+
+Here's a quick example of how to use the `yutipy` package to search for a song:
+
+### Deezer
+
+```python
+from yutipy.deezer import Deezer
+
+with Deezer() as deezer:
+    result = deezer.search("Artist Name", "Song Title")
+    print(result)
+```
+
+For more usage examples, see the [Usage Examples](https://yutipy.readthedocs.io/en/latest/usage_examples.html) page in docs.
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository.
+2. Optionally, create an issue to discuss the changes you plan to make.
+3. Create a new branch linked to that issue.
+4. Make your changes in the new branch.
+5. Write tests if you add new functionality.
+6. Ensure all tests pass before opening a pull request.
+7. Open a pull request for review.
+
+Thank you for your contributions!
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

{yutipy-0.1.0 → yutipy-0.1.1}/docs/api_reference.rst

@@ -5,6 +5,13 @@ API Reference
 Main Classes
 =============
 
+The following classes are available for use, utilizing the APIs of their respective music streaming platforms:
+
+- ``Deezer``: https://www.deezer.com
+- ``iTunes``: https://music.apple.com
+- ``Spotify``: https://spotify.com
+- ``YouTube Music``: https://music.youtube.com
+
 Deezer
 ------
 
@@ -26,7 +33,7 @@ iTunes
 Spotify
 -------
 
-.. autoclass:: yutipy.spotify.Spotipy
+.. autoclass:: yutipy.spotify.Spotify
     :members:
     :inherited-members:
     :noindex:

{yutipy-0.1.0 → yutipy-0.1.1}/docs/conf.py

@@ -6,8 +6,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath("../.."))
-sys.path.insert(0, os.path.abspath("../../yutipy"))
+sys.path.insert(0, os.path.abspath("../yutipy"))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -23,6 +22,8 @@ release = "0.1.0"
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
+    "sphinx_copybutton",
+    "sphinxext.opengraph",
 ]
 
 # Exclude private members and special methods
@@ -35,6 +36,13 @@ autodoc_default_options = {
     "show-inheritance": True,
 }
 
+# sphinx-copybutton optional configurations
+copybutton_prompt_text = r">>> |\.\.\. "
+copybutton_prompt_is_regexp = True
+copybutton_only_copy_code_blocks = False
+copybutton_remove_prompts = True
+copybutton_trim_trailing_whitespace = True
+
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
@@ -44,6 +52,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
+pygments_dark_style = "monokai"
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 html_show_sphinx = True
@@ -54,20 +63,9 @@ html_show_sourcelink = False
 # Output file base name for HTML help builder.
 htmlhelp_basename = "yutipydoc"
 
-html_theme = "alabaster"
+html_theme = "furo"
 html_static_path = ["_static"]
-html_logo = "_static/yutipy_logo.png"
 html_favicon = "_static/yutipy_logo.png"
-
-html_sidebars = {
-    "index": [
-        "project_links.html",
-        "contents.html",
-        "searchbox.html",
-    ],
-    "**": [
-        "contents.html",
-        "localtoc.html",
-        "searchbox.html",
-    ],
-}
+html_logo = "_static/yutipy_logo.png"
+html_css_files = ["custom.css"]
+html_title = project

yutipy-0.1.1/docs/index.rst

@@ -0,0 +1,27 @@
+.. image:: _static/yutipy_header.png
+   :alt: Welcome to yutipy's documentation!
+   :target: https://github.com/CheapNightbot/yutipy
+   :align: center
+
+**yutipy** is a Python package for searching and retrieving music information from various music platforms,
+including Deezer, iTunes, Spotify, and YouTube Music. This documentation will help you get started with yutipy
+and provide detailed information about its features and usage.
+
+Get Started
+===========
+
+.. toctree::
+   :maxdepth: 2
+
+   installation
+   usage_examples
+   api_reference
+
+.. toctree::
+   :caption: Project Links
+   :hidden:
+
+   pypi <https://pypi.org/project/yutipy>
+   source code <https://github.com/CheapNightbot/yutipy>
+   issue tracker <https://github.com/CheapNightbot/yutipy/issues>
+   support project <https://ko-fi.com/cheapnightbot>

{yutipy-0.1.0 → yutipy-0.1.1}/docs/installation.rst

@@ -7,3 +7,4 @@ You can install the package using pip. Make sure you have Python 3.8 or higher i
 .. code-block:: bash
 
     pip install -U yutipy
+

yutipy-0.1.1/docs/requirements.txt

@@ -0,0 +1,4 @@
+furo
+sphinx-copybutton
+Sphinx
+sphinxext-opengraph

yutipy-0.1.1/docs/usage_examples.rst

@@ -0,0 +1,83 @@
+==============
+Usage Examples
+==============
+
+Here's a quick example of how to use the **yutipy** package to search for a song:
+
+.. important::
+    All examples here—except for the `YouTube Music`_—use the ``with`` context manager to initialize an instance of the respective class,
+    as those classes internally use ``requests.Session()`` for making requests to APIs.
+    This approach ensures that the session is automatically closed once you exit the context. Although using ``with`` is not mandatory,
+    if you instantiate an object without it, you are responsible for closing the session after use by calling the ``close_session()`` method on that object.
+
+Deezer
+------
+
+.. code-block:: python
+
+    from yutipy.deezer import Deezer
+
+    with Deezer() as deezer:
+        result = deezer.search("Artist Name", "Song Title")
+        print(result)
+
+iTunes
+------
+
+.. code-block:: python
+
+    from yutipy.itunes import Itunes
+
+    with Itunes() as itunes:
+        result = itunes.search("Artist Name", "Song Title")
+        print(result)
+
+Spotify
+-------
+
+To use the Spotify API, you need to set the ``CLIENT_ID`` and ``CLIENT_SECRET`` for Spotify. You can do this by creating a ``.env`` file in the root directory of your project with the following content:
+
+.. admonition:: .env
+
+    .. code-block:: bash
+
+        CLIENT_ID=your_spotify_client_id
+        CLIENT_SECRET=your_spotify_client_secret
+
+Alternatively, you can manually provide these values when creating an object of the `Spotify` class:
+
+.. code-block:: python
+
+    from yutipy.spotify import Spotify
+
+    spotify = Spotify(client_id="your_spotify_client_id", client_secret="your_spotify_client_secret")
+
+.. code-block:: python
+
+    from yutipy.spotify import Spotify
+
+    with Spotify() as spotify:
+        result = spotify.search("Artist Name", "Song Title")
+        print(result)
+
+OR, if you have the ":abbr:`ISRC (International Standard Recording Code)`" or ":abbr:`UPC (Universal Product Code)`" of the song, you can use the `search_advanced` method:
+
+.. code-block:: python
+
+    from yutipy.spotify import Spotify
+
+    with Spotify() as spotify:
+        # ISRC for "single" tracks & UPC for "album" tracks. Only one of them is required.
+        result = spotify.search_advanced("Artist Name", "Song Title", isrc="USAT29900609", upc="00602517078194")
+        print(result)
+
+YouTube Music
+-------------
+
+.. code-block:: python
+
+    from yutipy.musicyt import MusicYT
+
+    music_yt = MusicYT()
+    result = music_yt.search("Artist Name", "Song Title")
+    print(result)

{yutipy-0.1.0 → yutipy-0.1.1}/pyproject.toml

@@ -39,8 +39,7 @@ classifiers = [
 
 [project.optional-dependencies]
 dev =  [
-    "pytest==8.3.4",
-    "Sphinx==8.2.0",
+    "pytest",
 ]
 
 [project.urls]

yutipy-0.1.1/requirements-dev.txt

@@ -0,0 +1 @@
+pytest

{yutipy-0.1.0 → yutipy-0.1.1}/tests/test_deezer.py

@@ -43,5 +43,5 @@ def test_search_no_results(deezer):
 
 
 def test_close_session(deezer):
-    deezer._close_session()
+    deezer.close_session()
     assert deezer.is_session_closed

{yutipy-0.1.0 → yutipy-0.1.1}/tests/test_itunes.py

@@ -45,5 +45,5 @@ def test_search_empty_song(itunes):
 
 
 def test_close_session(itunes):
-    itunes._close_session()
+    itunes.close_session()
     assert itunes.is_session_closed

{yutipy-0.1.0 → yutipy-0.1.1}/tests/test_musicyt.py

@@ -21,8 +21,8 @@ def test_search_valid(music_yt):
 
 
 def test_search_invalid(music_yt):
-    artist = "Nonexistent Artist"
-    song = "Nonexistent Song"
+    artist = ";laksjdflkajsdfj;asdjf"
+    song = "jaksjd;fljkas;dfkjasldkjf"
     result = music_yt.search(artist, song)
     assert result is None
 

{yutipy-0.1.0 → yutipy-0.1.1}/tests/test_spotify.py

@@ -2,13 +2,13 @@ import pytest
 
 from yutipy.exceptions import SpotifyException
 from yutipy.models import MusicInfo
-from yutipy.spotify import Spotipy
+from yutipy.spotify import Spotify
 
 
 @pytest.fixture(scope="module")
 def spotify():
     try:
-        return Spotipy()
+        return Spotify()
     except SpotifyException:
         pytest.skip("Spotify credentials not found")
 
@@ -49,5 +49,5 @@ def test_get_artists_ids(spotify):
 
 
 def test_close_session(spotify):
-    spotify._close_session()
+    spotify.close_session()
     assert spotify.is_session_closed

{yutipy-0.1.0 → yutipy-0.1.1}/yutipy/__init__.py

@@ -2,12 +2,12 @@ from .deezer import Deezer
 from .itunes import Itunes
 from .models import MusicInfo
 from .musicyt import MusicYT
-from .spotify import Spotipy
+from .spotify import Spotify
 
 __all__ = [
     "Deezer",
     "Itunes",
     "MusicInfo",
     "MusicYT",
-    "Spotipy",
+    "Spotify",
 ]

{yutipy-0.1.0 → yutipy-0.1.1}/yutipy/deezer.py

@@ -30,7 +30,7 @@ class Deezer:
         """Exits the runtime context related to this object."""
         self._close_session()
 
-    def _close_session(self) -> None:
+    def close_session(self) -> None:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
@@ -54,7 +54,7 @@ class Deezer:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):
@@ -104,13 +104,12 @@ class Deezer:
         Optional[Dict]
             A dictionary containing UPC and ISRC information.
         """
-        match music_type:
-            case "track":
-                return self._get_track_info(music_id)
-            case "album":
-                return self._get_album_info(music_id)
-            case _:
-                raise DeezerException(f"Invalid music type: {music_type}")
+        if music_type == "track":
+            return self._get_track_info(music_id)
+        elif music_type == "album":
+            return self._get_album_info(music_id)
+        else:
+            raise DeezerException(f"Invalid music type: {music_type}")
 
     def _get_track_info(self, music_id: int) -> Optional[Dict]:
         """

{yutipy-0.1.0 → yutipy-0.1.1}/yutipy/itunes.py

@@ -31,7 +31,7 @@ class Itunes:
         """Exits the runtime context related to this object."""
         self._close_session()
 
-    def _close_session(self) -> None:
+    def close_session(self) -> None:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
@@ -55,7 +55,7 @@ class Itunes:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):

{yutipy-0.1.0 → yutipy-0.1.1}/yutipy/musicyt.py

@@ -33,7 +33,7 @@ class MusicYT:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):

{yutipy-0.1.0 → yutipy-0.1.1}/yutipy/spotify.py

@@ -2,7 +2,7 @@ import base64
 import os
 import time
 from pprint import pprint
-from typing import Optional
+from typing import Optional, Union
 
 import requests
 from dotenv import load_dotenv
@@ -27,11 +27,11 @@ CLIENT_ID = os.getenv("CLIENT_ID")
 CLIENT_SECRET = os.getenv("CLIENT_SECRET")
 
 
-class Spotipy:
+class Spotify:
     """
     A class to interact with the Spotify API.
 
-    This class reads the CLIENT_ID and CLIENT_SECRET from the .env file by default.
+    This class reads the ``CLIENT_ID`` and ``CLIENT_SECRET`` from environment variables or the ``.env`` file by default.
     Alternatively, users can manually provide these values when creating an object.
     """
 
@@ -39,7 +39,7 @@ class Spotipy:
         self, client_id: str = CLIENT_ID, client_secret: str = CLIENT_SECRET
     ) -> None:
         """
-        Initializes the Spotipy class and sets up the session.
+        Initializes the Spotify class and sets up the session.
 
         Parameters
         ----------
@@ -69,7 +69,7 @@ class Spotipy:
         """Exits the runtime context related to this object."""
         self._close_session()
 
-    def _close_session(self) -> None:
+    def close_session(self) -> None:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
@@ -147,7 +147,7 @@ class Spotipy:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):
@@ -192,7 +192,7 @@ class Spotipy:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):
@@ -224,7 +224,7 @@ class Spotipy:
         artist_ids = self._get_artists_ids(artist)
         return self._find_music_info(artist, song, response.json(), artist_ids)
 
-    def _get_artists_ids(self, artist: str) -> list | None:
+    def _get_artists_ids(self, artist: str) -> Union[list, None]:
         """
         Retrieves the IDs of the artists.
 
@@ -235,7 +235,7 @@ class Spotipy:
 
         Returns
         -------
-        list | None
+        Union[list, None]
             A list of artist IDs or None if not found.
         """
         artist_ids = []
@@ -403,11 +403,11 @@ class Spotipy:
 
 
 if __name__ == "__main__":
-    spotipy = Spotipy(CLIENT_ID, CLIENT_SECRET)
+    Spotify = Spotify(CLIENT_ID, CLIENT_SECRET)
 
     try:
         artist_name = input("Artist Name: ")
         song_name = input("Song Name: ")
-        pprint(spotipy.search(artist_name, song_name))
+        pprint(Spotify.search(artist_name, song_name))
     finally:
-        spotipy._close_session()
+        Spotify._close_session()

{yutipy-0.1.0 → yutipy-0.1.1}/yutipy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: yutipy
-Version: 0.1.0
+Version: 0.1.1
 Summary: A simple package for retrieving music information from various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>
@@ -53,13 +53,34 @@ Requires-Dist: rapidfuzz==3.12.1
 Requires-Dist: requests==2.32.3
 Requires-Dist: ytmusicapi==1.10.1
 Provides-Extra: dev
-Requires-Dist: pytest==8.3.4; extra == "dev"
-Requires-Dist: Sphinx==8.2.0; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/CheapNightbot/yutipy/main/docs/_static/yutipy_header.png" alt="yutipy" />
 </p>
 
+<p align="center">
+<a href="https://github.com/CheapNightbot/yutipy/actions/workflows/tests.yml">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/cheapnightbot/yutipy/pytest-unit-testing.yml?style=for-the-badge&label=Pytest">
+</a>
+    
+<a href="https://pypi.org/project/yutipy/">
+<img src="https://img.shields.io/pypi/v/yutipy?style=for-the-badge" alt="PyPI" />
+</a>
+<a href="https://yutipy.readthedocs.io/en/latest/">
+<img src="https://img.shields.io/readthedocs/yutipy?style=for-the-badge" alt="Documentation Status" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/blob/master/LICENSE">
+<img src="https://img.shields.io/github/license/CheapNightbot/yutipy?style=for-the-badge" alt="License" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/stargazers">
+<img src="https://img.shields.io/github/stars/CheapNightbot/yutipy?style=for-the-badge" alt="Stars" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/issues">
+<img src="https://img.shields.io/github/issues/CheapNightbot/yutipy?style=for-the-badge" alt="Issues" />
+</a>
+</p>
+
 A _**simple**_ Python package for searching and retrieving music information from various music platforms APIs, including Deezer, iTunes, Spotify, and YouTube Music.
 
 ## Table of Contents
@@ -98,7 +119,7 @@ with Deezer() as deezer:
     print(result)
 ```
 
-For more usage examples, see the [docs](#).
+For more usage examples, see the [Usage Examples](https://yutipy.readthedocs.io/en/latest/usage_examples.html) page in docs.
 
 ## Contributing
 

{yutipy-0.1.0 → yutipy-0.1.1}/yutipy.egg-info/SOURCES.txt

@@ -1,22 +1,24 @@
 .gitattributes
 .gitignore
+.readthedocs.yaml
 LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
 requirements-dev.txt
 requirements.txt
+.github/FUNDING.yml
+.github/workflows/pytest-unit-testing.yml
 docs/Makefile
 docs/api_reference.rst
 docs/conf.py
 docs/index.rst
 docs/installation.rst
 docs/make.bat
+docs/requirements.txt
 docs/usage_examples.rst
 docs/_static/yutipy_header.png
 docs/_static/yutipy_logo.png
-docs/_templates/contents.html
-docs/_templates/project_links.html
 tests/__init__.py
 tests/test_deezer.py
 tests/test_itunes.py

{yutipy-0.1.0 → yutipy-0.1.1}/yutipy.egg-info/requires.txt

@@ -4,5 +4,4 @@ requests==2.32.3
 ytmusicapi==1.10.1
 
 [dev]
-pytest==8.3.4
-Sphinx==8.2.0
+pytest

yutipy-0.1.0/docs/_templates/contents.html

@@ -1,2 +0,0 @@
-<h3>Contents</h3>
-{{ toctree() }}

yutipy-0.1.0/docs/_templates/project_links.html

@@ -1,8 +0,0 @@
-<div class="project-links">
-    <h3>Project Links</h3>
-    <ul>
-        <li><a href="https://github.com/CheapNightbot/yutipy">Source Code</a></li>
-        <li><a href="https://github.com/CheapNightbot/yutipy/issues">Issue Tracker</a></li>
-        <li><a href="https://pypi.org/project/yutipy">PyPI</a></li>
-    </ul>
-</div>

yutipy-0.1.0/docs/index.rst

@@ -1,15 +0,0 @@
-.. image:: _static/yutipy_header.png
-   :alt: Welcome to yutipy's documentation!
-   :target: https://github.com/CheapNightbot/yutipy
-
-**yutipy** is a Python package for searching and retrieving music information from various music platforms, including Deezer, iTunes, Spotify, and YouTube Music. This documentation will help you get started with yutipy and provide detailed information about its features and usage.
-
-Get Started
-===========
-
-.. toctree::
-   :maxdepth: 2
-
-   installation
-   usage_examples
-   api_reference

yutipy-0.1.0/docs/usage_examples.rst

@@ -1,74 +0,0 @@
-=====
-Usage
-=====
-
-Here's a quick example of how to use the `yutipy` package to search for a song:
-
-Deezer
-------
-
-.. code-block:: python
-
-    from yutipy.deezer import Deezer
-
-    with Deezer() as deezer:
-        result = deezer.search("Artist Name", "Song Title")
-        print(result)
-
-iTunes
-------
-
-.. code-block:: python
-
-    from yutipy.itunes import Itunes
-
-    with Itunes() as itunes:
-        result = itunes.search("Artist Name", "Song Title")
-        print(result)
-
-Spotify
--------
-
-To use the Spotify API, you need to set the `CLIENT_ID` and `CLIENT_SECRET` for Spotify. You can do this by creating a `.env` file in the root directory of your project with the following content:
-
-.. code-block:: text
-
-    CLIENT_ID=your_spotify_client_id
-    CLIENT_SECRET=your_spotify_client_secret
-
-Alternatively, you can manually provide these values when creating an object of the `Spotipy` class:
-
-.. code-block:: python
-
-    from yutipy.spotify import Spotipy
-
-    spotify = Spotipy(client_id="your_spotify_client_id", client_secret="your_spotify_client_secret")
-
-.. code-block:: python
-
-    from yutipy.spotify import Spotipy
-
-    with Spotipy() as spotify:
-        result = spotify.search("Artist Name", "Song Title")
-        print(result)
-
-OR, if you have the ISRC or UPC of the song, you can use the `search_advanced` method:
-
-.. code-block:: python
-
-    from yutipy.spotify import Spotipy
-
-    spotify = Spotipy()
-    # ISRC for "single" tracks & UPC for "album" tracks. Only one of them is required.
-    result = spotify.search_advanced("Artist Name", "Song Title", isrc="USAT29900609", upc="00602517078194")
-
-YouTube Music
--------------
-
-.. code-block:: python
-
-    from yutipy.musicyt import MusicYT
-
-    music_yt = MusicYT()
-    result = music_yt.search("Artist Name", "Song Title")
-    print(result)

yutipy-0.1.0/requirements-dev.txt

@@ -1,2 +0,0 @@
-pytest==8.3.4
-Sphinx==8.2.0