================================================ Howdy Music API ================================================ This document describes the lower level Howdy Music API, upon which the :ref:`command line tools ` are built. It lives in ``howdy.music``. howdy.music module ---------------------------- This contains only three methods: two format durations strings for YouTube_ clips, and a third is used to search for M4A_ music files that are missing artist or album information. .. automodule:: howdy.music :members: howdy.music.music module --------------------------------------- This contains the low-level functionality that does three things. * Gets music metadata using either the Gracenote_, LastFM_, or MusicBrainz_ APIs. * Retrieves YouTube_ clips using the `YouTube Google API`_ and yt-dlp_. .. note:: I checked on ``15 OCTOBER 2021``, and I see some disturbing things. The latest version of youtube-dl_ is ``6 JUNE 2021``. This `discussion on YCombinator `_ says that ``YouTube is dead``. Also, when I used the youtube-dl_ command line or the YoutubeDL API, my download speeds are no faster than 80 kbp/s. This means using yt-dlp_. From my cursory work, doing ``howdy_music_songs -M -a Air -s "All I Need"``, the old youtube-dl_ speeds that I loved and got used to seem to work again! * Uploads music to one's own `Google Play Music`_ account using GMusicAPI_, and sets its credentials. .. automodule:: howdy.music.music :members: howdy.music.music_spotify module --------------------------------------- These module handles integration with the Spotify_ RESTful API that does the following things: * Methods to handle authentication to the Spotify_ API. See `this blog article on the Spotify Web API `_ on how to set up a Spotify_ Web API client, and to acquire your client ID and client secret. * Methods to copy the Spotify_ song ID into an M4A_ song file's metadata, and to get the Spotify_ song ID of the song. * Methods that returns the Spotify_ ID based on a song's metadata. * Methods that show, create, modify the current user's Spotify_ public playlists. * Methods that convert a :py:class:`DataFrame ` representing a Plex_ music playlist *into* a :py:class:`DataFrame ` representing a data structure that can be converted into a Spotify_ public playlist. In this API I refer to the Spotify_ ID of a song, which has format ``:spotify:track:``. For example, the song `All I Need `_ by `Air the French band `_ has a Spotify_ ID = ``spotify:track:6T10XPeC9X5xEaD6tMcK6M``. It can be found at https://open.spotify.com/track/6T10XPeC9X5xEaD6tMcK6M. .. automodule:: howdy.music.music_spotify :members: howdy.music.pygn module ---------------------------------- This contains functionality used by the :py:class:`HowdyMusic ` higher level object interface to the Gracenote_ API. .. automodule:: howdy.music.pygn :members: .. URLs here .. _YouTube: https://www.youtube.com .. _M4A: https://en.wikipedia.org/wiki/MPEG-4_Part_14 .. _Gracenote: https://developer.gracenote.com/web-api .. _LastFM: https://www.last.fm/api .. _MusicBrainz: https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2 .. _Spotify: https://open.spotify.com .. _`YouTube Google API`: https://developers.google.com/youtube/v3 .. _yt-dlp: https://github.com/yt-dlp/yt-dlp .. _youtube-dl: https://ytdl-org.github.io/youtube-dl/index.html .. _GMusicAPI: https://unofficial-google-music-api.readthedocs.io .. _`Google Play Music`: https://play.google.com/music/listen