yutipy 0.1.0__tar.gz

yutipy-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

yutipy-0.1.0/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.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/#use-with-ide
+.pdm.toml
+
+# 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/

yutipy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Cheap Nightbot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yutipy-0.1.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include README.md
+include requirements.txt
+include requirements-dev.txt
+recursive-include yutipy *
+recursive-include tests *

yutipy-0.1.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.2
+Name: yutipy
+Version: 0.1.0
+Summary: A simple package for retrieving music information from various music platforms APIs.
+Author: Cheap Nightbot
+Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>
+Maintainer-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>
+License: MIT License
+        
+        Copyright (c) 2025 Cheap Nightbot
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/CheapNightbot/yutipy
+Project-URL: Documentation, https://yutipy.readthedocs.io/
+Project-URL: Repository, https://github.com/CheapNightbot/yutipy.git
+Project-URL: Issues, https://github.com/CheapNightbot/yutipy/issues
+Project-URL: Changelog, https://github.com/CheapNightbot/yutipy/blob/master/CHANGELOG.md
+Project-URL: funding, https://ko-fi.com/cheapnightbot
+Keywords: music,API,Deezer,iTunes,Spotify,YouTube Music,search,retrieve,information,yutify
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv==1.0.1
+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"
+
+<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.

yutipy-0.1.0/README.md

@@ -0,0 +1,61 @@
+<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.

yutipy-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

yutipy-0.1.0/docs/_templates/contents.html

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

yutipy-0.1.0/docs/_templates/project_links.html

@@ -0,0 +1,8 @@
+<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/api_reference.rst

@@ -0,0 +1,109 @@
+=============
+API Reference
+=============
+
+Main Classes
+=============
+
+Deezer
+------
+
+.. autoclass:: yutipy.deezer.Deezer
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: is_session_closed
+
+iTunes
+------
+
+.. autoclass:: yutipy.itunes.Itunes
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: is_session_closed
+
+Spotify
+-------
+
+.. autoclass:: yutipy.spotify.Spotipy
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: is_session_closed
+
+YouTube Music
+-------------
+
+.. autoclass:: yutipy.musicyt.MusicYT
+    :members:
+    :inherited-members:
+    :noindex:
+
+Data Classes
+=============
+
+MusicInfo
+---------
+
+.. autoclass:: yutipy.models.MusicInfo
+    :members:
+    :noindex:
+    :exclude-members: album_art, album_title, album_type, artists, genre, id, isrc, lyrics, release_date, tempo, title, type, upc, url
+
+Exceptions
+=============
+
+.. autoclass:: yutipy.exceptions.YutipyException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.InvalidValueException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.DeezerException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.ItunesException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.SpotifyException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.MusicYTException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.AuthenticationException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.NetworkException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.InvalidResponseException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback

yutipy-0.1.0/docs/conf.py

@@ -0,0 +1,73 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))
+sys.path.insert(0, os.path.abspath("../../yutipy"))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "yutipy"
+copyright = "%Y, Cheap Nightbot"
+author = "Cheap Nightbot"
+release = "0.1.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+]
+
+# Exclude private members and special methods
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": False,
+    "private-members": False,
+    "special-members": False,
+    "inherited-members": True,
+    "show-inheritance": True,
+}
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = True
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "yutipydoc"
+
+html_theme = "alabaster"
+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",
+    ],
+}

yutipy-0.1.0/docs/index.rst

@@ -0,0 +1,15 @@
+.. 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/installation.rst

@@ -0,0 +1,9 @@
+============
+Installation
+============
+
+You can install the package using pip. Make sure you have Python 3.8 or higher installed.
+
+.. code-block:: bash
+
+    pip install -U yutipy

yutipy-0.1.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd