Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 2.98 KB

README.md

File metadata and controls

83 lines (62 loc) · 2.98 KB

yutipy

GitHub Actions Workflow Status PyPI Documentation Status License Stars Issues

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

  • Simple & Easy integration with popular music APIs.
  • Search for music by artist and song title across multiple platforms.
  • It uses RapidFuzz to compare & return the best match so that you can be sure you got what you asked for without having to worry and doing all that work by yourself.
  • Retrieve detailed music information, including album art, release dates, lyrics, ISRC, and UPC codes.

Installation

You can install the package using pip. Make sure you have Python 3.8 or higher installed.

pip install -U yutipy

Usage Example

Here's a quick example of how to use the yutipy package to search for a song:

Deezer

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 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 file for details.