Metadata-Version: 2.1
Name: get_cover_art
Version: 1.4.5
Summary: Batch cover art downloader and embedder for audio files
Home-page: https://github.com/regosen/get_cover_art
Author: Rego Sen
Author-email: regosen@gmail.com
License: MIT
Description: # get_cover_art
        
        ### THE PROBLEM
        Missing cover art for large imported music libraries.  
        
        ### EXISTING SOLUTIONS
        
        1. Apple's Music App (and its predecessor iTunes) has a "Get Album Artwork" feature, but it isn't reliable and doesn't actually embed cover art into your audio files.  That means if you move your music library elsewhere, you'll be missing all your album artwork.
        
        2. Metadata utilities like Metadatics are great (and cheap if not free), but they can require a lot of manual interaction to go through each album and select artwork from search results.  This can be forbidding for large libraries of thousands of albums.
        
        ### THIS SOLUTION
        This Python package will batch-update your entire library without manual interaction for each album.
        
        It uses Apple Music's artwork, which is already standardized and high-quality.  It also embeds the artwork directly into your audio files, so that it's independent of your player.
        
        ## Supported formats (so far)
        - MP3
        - MP4 (.m4a)
        - FLAC
        - Ogg Vorbis
        - Opus
        
        ## Requirements
        - Python 3.5 or greater
        - Python packages: [mutagen](https://pypi.org/project/mutagen/)
        
        ### Installation on MacOS using Homebrew
        
        ```
        brew install python
        python3 -m pip install mutagen
        python3 -m pip install get_cover_art
        ```
        And then to upgrade existing installations:
        ```
        python3 -m pip install --upgrade get_cover_art
        ```
        
        ## Usage
        
        ### From the Command Line
        ```
        python -m get_cover_art [--path=<path_to_audio_file_or_folder>] [--options]
        
          --path PATH           audio file, or folder of audio files (recursive)
        
        artwork options:
          --art-dest DEST       set artwork destination folder
          --art-dest-inline     set artwork destination folder to same folders as audio files
          --art-dest-filename ART_DEST_FILENAME
                                set artwork destination filename format. Accepts {artist},
                                {album}, and {title}. Default '{artist} - {album}.jpg'
          --external-art-mode {before,after,none}
                                Use images from local disk: "before" prevents
                                downloads, "after" downloads as a fallback. Default is none.
          --external-art-filename EXTERNAL_ART_FILENAME [EXTERNAL_ART_FILENAME ...]
                                Filename(s) of folder art to use. Accepts {artist},
                                {album}, and {title} for replacement: e.g. cover.jpg
                                or {album}-{artist}.jpg
        
        behavior options:
          --test, --no_embed    scan and download only, don't embed artwork
          --no_download         embed only previously-downloaded artwork
          --clear               clear artwork from audio file (regardless of finding art)
          --force               overwrite existing artwork
          --verbose             print verbose logging
          --throttle            wait X seconds between downloads
        
        filter options:
          --skip_artists SKIP_ARTISTS
                                file containing artists to skip
          --skip_albums SKIP_ALBUMS
                                file containing albums to skip
          --skip_artwork SKIP_ARTWORK
                                file containing destination art files to skip
        ```
        if you omit `path`, it will scan the current working directory
        
        _Pro Tip:_ You can run with `--test` first, then browse/prune the downloaded artwork, then run again with `--no_download` to embed only the artwork you didn't prune.
        
        
        #### Using external art sources
        
        The external-art options allow you to fall back on local folder art.
        Some other scraping systems may have created cover art: for instance, some
        Kodi scrapers create a "cover.jpg" image in each album directory.
        
        Specifying "--external-art-mode before" will use these existing images, and only
        download images if there is no existing image. Specifying "--external-art-mode
        after" will attempt to download artwork as usual, only falling back on the
        existing images if the download is unable to locate new art.
        
        The "--external-art-filename" option allows you to specify the filename(s) to use
        for this existing folder art. It defaults to "cover.jpg \_albumcover.jpg folder.jpg", which are 3 filenames commonly used by other scraping programs. You
        can also use bracket formatting with the artist, album, and title fields:
        for instance, --external-art-filename "{artist}-{album}-cover.jpg" would create
        filenames such as "The Beatles-Abbey Road-cover.jpg".
        
        The "--art-dest-filename" option allows you to specify the filename used to
        store downloaded files, for interoperability with other systems. You __must__
        be careful to avoid collisions between different albums: The default is
        "{artist} - {album}.jpg". If you know that all of the albums you're running
        against have their own directories _and_ you are using "--art-dest-inline", then you
        could use something more generic (such as "cover.jpg").
        
        _Pro Tip:_ If you have a cover.jpg in each album directory, you can use:
        "--external-art-mode before --external-art-filename cover.jpg --art-dest-inline"
        and the local images will be used when present (avoiding network lookups).
        You could also specify "--art-dest-filename cover.jpg" if you want to store the
        newly downloaded covers in a similar location (again, this is only sane
        in combination with --art-dest-inline, in cases where each album is stored in 
        a separate directory).
        
        ### From the Python Environment
        ```
        from get_cover_art import CoverFinder
        
        finder = CoverFinder(OPTIONS)
        
        # then you can run either of these:
        finder.scan_folder(PATH_TO_AUDIO_LIBRARY)
        finder.scan_file(PATH_TO_AUDIO_FILE)
        ```
        
        - `OPTIONS` is a dict of the same options listed for the commandline, e.g. `--verbose` -> `{'verbose': True}`
        - you can omit `PATH_TO_AUDIO_LIBRARY` to default to your current directory
        - your `CoverFinder` object keeps a list of files_processed, files_skipped, files_failed, files_invalid
        
        ## How it works
        1. First, it recursively scans your provided folder for supported files.
          - Step 1 is skipped if you specified a single file instead of a folder.
        2. For each file without embedded artwork (or all files if `--force` is used), attempts to download from Apple Music based on artist and album metadata.
          - Step 2 is skipped if it had already downloaded (or attempted to download) the image file.
          - Step 2 is also skipped based on `--no_download` or `--skip_*` options.
        3. If artwork is found, it's embedded into the audio file.
        
        ### Why do you download from Apple Music and not Google image search?
        1. Google's Image Search API requires a dev token (so does Apple Music's API, but not its public web query URL).
        2. Google search queries are heavily throttled.
        3. Apple Music's cover sizes are standardized and sufficiently large.
        
        ## Troubleshooting
        
        ### The artwork is embedded now, but Apple's Music App still won't show it.
        Try re-importing one of your embedded files.  If the re-imported version shows artwork, you need to reimport your music library.  You can do this without losing your playlists as follows:
        1. File->Library->Export Library... and name your exported library file.
        2. Visit Music->Preferences...->Files and screenshot your options.  You'll need to restore them later.
        3. Quit the app and relaunch while holding down the Option key.
        4. Choose "Create Library..." and pick a new location.
        5. Visit Music->Preferences...->Files and restore your desired options.
        6. File->Library->Import Playlist... and choose your library file from step 1.  (Yes, it's called "Import Playlist..." but you actually use this to import your library.)
        
        Step 6 will take a while.
        
        ### The artwork appears in Apple's Music App but not my iOS device.
        You'll have to unsync all your music and re-sync it again.  Try it with a single file first.
        
Keywords: cover album art artwork embed itunes apple music mp3 id3 m4a mp4 aac xmp flac ogg vorbis opus songs
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Python: >=3.5
Description-Content-Type: text/markdown
