Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 2.79 KB

README.md

File metadata and controls

81 lines (57 loc) · 2.79 KB
Raw

earworm

Create a simple web page to listen to audio files in a directory

Setup

The package is available on PyPI and you can install it using pip/conda.

pip install earworm

Usage

This tool can generate a simple HTML page from a directory of music files. The tool can read metadata from files directly (currently only supports MP3 files and ID3 tags). But, if you have files which are not MP3, you can use a CSV file with the metadata.

The CSV file must have the following columns filename and title, and any additional ones you may want. A template can be generated using the tool -- see step 3 below.

  1. To get started create a sample config file:

    earworm make-config -c config.yml

  2. Change the value of music_dir to the directory where you have your music files. If you wish to use a CSV file for the metadata, add a metadata_csv entry to the config.

    metadata_csv: "/path/to/metadata.csv"

  3. You can generate a template for the metadata.csv from your music_dir by running earworm with the update-csv sub-command. Once the CSV file is generated, add a metadata_csv entry pointing to this file to your config.

  4. Run earworm to generate a directory called output with an index.html, music/ directory with all the music files that have "valid metadata", and a covers/ directory with the cover images for the albums.

  5. You can specify the <title> of the page by using the title config var

  6. If the base_url parameter is specified, an og:image tag is added to the page, using the latest song's cover image.

  7. Open the index.html in your browser to view the playlist locally.

  8. If you have access to a webserver, you can just sync the output directory to your webserver.

  9. If you don't have access to a webserver you can use something like Google Drive or Dropbox to host this as a static website.

  10. A new music file can be added to an existing music directory and site using the add-audio subcommand.

    earworm add-audio -c config.yml -i ~/Downloads/cover-image.jpg ~/Music/covers/song123.mp3

Dev Setup

When working on the source (py/html/CSS/JS) of the site, you can automatically generate the html each time you make any changes to the input files using entr.

ls /path/to/config-file $(git ls-files) | entr earworm --config /path/to/config-file

JS toolchain

To change the JS files, you need to have rollup installed and you can run the rollup watcher (rollup -w -c rollup.config.js) to build the bundle.js.