yutipy 2.2.7

A simple package for retrieving music information from various music platforms APIs.

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
  • Available Music Platforms
• Installation
• Usage Example
• Command-Line Interface (CLI)
  • Search for Music
    • Options
  • Configuration Wizard
• Contributing
• License

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.
• Authorize and access user resources easily.

Available Music Platforms

Right now, the following music platforms are available in yutipy for searching music. New platforms will be added in the future. Feel free to request any music platform you would like me to add by opening an issue on GitHub or by emailing me.

• Deezer: https://www.deezer.com
• iTunes: https://music.apple.com
• KKBOX: https://www.kkbox.com
• Lastfm: https://last.fm
• Spotify: https://spotify.com
• YouTube Music: https://music.youtube.com

Installation

You can install the package using pip. Make sure you have Python 3.9 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 on 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.

Command-Line Interface (CLI)

The yutipy package includes a CLI tool that allows you to search for music directly from the command line and configure API keys interactively.

Search for Music

You can use the CLI tool to search for music across multiple platforms:

yutipy-cli "Rick Astley" "Never Gonna Give You Up" --limit 3 --normalize

Options:

• artist (required): The name of the artist.
• song (required): The title of the song.
• --limit: The number of results to retrieve (default: 5).
• --normalize: Normalize non-English characters for comparison.
• --verbose: Enable logging in the terminal.
• --service: Specify a single service to search (e.g., deezer, spotify, itunes).

Configuration Wizard

To set up your API keys interactively, use the configuration wizard:

yutipy-config

The wizard will guide you through obtaining and setting up API keys for supported services like Spotify and KKBOX. If the required environment variables are already set, the wizard will skip those steps.

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.