Skip to main content

A package to extract and manipulate data contained in a music library such as playlists or album cover artwork.

Project description

audio-libraries-tlk

A set of Python tools to explore and modify data contained in a music library such as playlists or album cover artwork.

Acknoledgments

This project is heavily relying on, on the one hand Scholnicks' itunesLibrary (it self a port of Drew Stephen's Mac-iTunes-Library), on the other hand on KristoforMaynard's music-tag

Usecases

This project originates from the following needs:

  1. Transfering playlists from different audio devices.
  2. Convert cover artwork of songs to non-prog images.
  3. Explore inconsistencies in a music library (incomplete albums, songs placed in the wrong location, etc).
  4. These would be possible for both an iTunes or Apple Music managed library and a library managed by hand in folders.

How to install

Through pip

python3 -m pip install audio-libraries-tlk

Warnings

In general:

  • You are using this script at your own risks. Make sure you try the script on a duplicated small sample of your library to verify that it is achieving what you want.

In particular:

  • Running the playlists components of the script should be safe as these don't imply modifying your music library but just extract some playlists and create new ones.

  • Running the cover artwork options is much more risky as the script will potentially modify the cover artworks inside your music files. If your music files are not properly splited by album (two songs of different albums are present in the same folder) then you the cover artworks of the two albums will be mixed (one will replace the other). In other word, the script assumes that songs in the same location belong to the same album. In case of doubt, you can start by running the script with all the cover artwork options set as False (the default case) and with the option --create_special_playlists==True. This will produce a csv file showing all the locations containing songs of multiple albums.

  • Again try the script on a small duplicated sample of your music files and check if the reasult pleases you.

Be patient

Depending on the option you choose the script can take a long time to run: up to ~1 hour for 1 30k songs library on a mac mini M2.

To save time in the case you need to run the script twice and to avoide the full scan of the music files or of the .xml file twice, a .pickle and a .csv file are created by the first scan of the library. These will be reused in the the second call to significantly reduce the time of the second call.

However, if your music files or .xml have changed between the fiorst and the second call, you need to remove the existing .pickles and .csv are these wont reflect anymore the state of your music library.

Outputs

The .m3u8, .csv and .picklefiles created by the script will be located inside the PATH_TO_LIBRARY_DATA.

How to run

  • To run the script from an iTunes or Apple Music, first go to setting/Library/Export Library. Save the .xml file in a folder and copy this path (for instance /Users/user_name/Music/ where you have placed the file My_Library.xml).
  • To run the script from a music library that is simply organised in folders (for instance Artist/Album). Simply copy the path pointing to our music directory (for instance /Users/user_name/Music/Music/Media/Music).

Then, for instance, to extract all the playlists contained in your music library, convert them into a format readable by a new audio device, and create a cover.jpg file for inside each album folder, run the command:

python3 -m audio-libraries-tlk --path_to_library_data='/Users/user_name/Music/' --orginal_path_written_in_playlists='/Users/user_name/Music/' --updated_path_written_in_playlists='/home/Music/' --create_cover_jpg=True

To save time on the second run

To save time in the case you need to run the script twice and to avoide the full scan of the music files or of the .xmlfile twice, a .pickle and a .csv file are created by the first scan of the library. These will be reused in the the second call to significantly reduce the time of the second call.

However, if your music files or .xml have changed between the fiorst and the second call, you need to remove the existing .pickles and .csv are these wont reflect anymore the state of your music library.

Detailed options

options:
  -h, --help            show this help message and exit
  --path_to_library_data PATH_TO_LIBRARY_DATA
                        Path containing to a folder containing an iTunes library .xml file or all
                        a music library organized album folders.
  --orginal_path_written_in_playlists ORGINAL_PATH_WRITTEN_IN_PLAYLISTS default=None
                        Part of the path to be replaced in the original playlists (for instance
                        '/Users/UserName/Music/Music/Media/Music'). Open an m3u8 playlist with a
                        text editor to know what to use.
  --updated_path_written_in_playlists UPDATED_PATH_WRITTEN_IN_PLAYLISTS default=None
                        Part to be used in the new music location (for instance
                        '/home/sony/walkman/Music'). Open an m3u8 playlist with a text editor to
                        know what to use.
  --create_cover_jpg CREATE_COVER_JPG default=False
                        If True an image file called 'cover.jpg' will be created inside each
                        location containig some music files. Only 1 file will be created per
                        location. Even if two songs have distinct coverart
  --create_album_title_jpg CREATE_ALBUM_TITLE_JPG default=False
                        If True an image file called 'title of the album.jpg' will be created
                        inside each location containig some music files. Only 1 file will be
                        created per location. Even if two songs have distinct coverart
  --complete_missing_cover_art COMPLETE_MISSING_COVER_ART default=False
                        Use the coverart of a song (any arbitrary one) conatinied in the same
                        location to fil all the missing coverarts
  --convert_to_non_prog CONVERT_TO_NON_PROG default=False
                        Convert the coverarts to non-prog images.
  --create_special_playlists CREATE_SPECIAL_PLAYLISTS default=False
                        Create some playlists and csv file to underline some aspects of a music
                        library.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

audio_libraries_tlk-0.0.1.tar.gz (26.9 kB view details)

Uploaded Source

Built Distribution

audio_libraries_tlk-0.0.1-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file audio_libraries_tlk-0.0.1.tar.gz.

File metadata

  • Download URL: audio_libraries_tlk-0.0.1.tar.gz
  • Upload date:
  • Size: 26.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for audio_libraries_tlk-0.0.1.tar.gz
Algorithm Hash digest
SHA256 0fa383648347da421044ae3dd2dd09682785cf0ff1235854ecffe72c8febd464
MD5 fc649b76809891b4c024ebb04a04af5a
BLAKE2b-256 8e9e01f68f027c67b485c9c84d0ddfa87a6cb28a46bacd9fd0d1f37098bdea2f

See more details on using hashes here.

File details

Details for the file audio_libraries_tlk-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for audio_libraries_tlk-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f0a468c3b45a26a103f0f614b9258a84ea1d50e088c91496809e869c90cf2987
MD5 d4634d74d8733e0bcd7161b846e84fb4
BLAKE2b-256 79400de3137a8fa5fcda43952f79429665e3d31415d6551a76d3c96d4cca3465

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page