mirrors
/
irs
mirror of https://github.com/cooperhammond/irs.git
1
1
Fork 0
Code Issues Projects Releases Wiki Activity
irs/README.md

3.4 KiB
Executable File
Raw Blame History

irs

AKA Ironic Repositioning System

made-with-crystal License: MIT Say Thanks

A music scraper that understands your metadata needs.

Installation

  1. Download the latest release for your platform here
  2. Create a .yaml config file somewhere on your system
  3. Copy the following into it 
    binary_directory: ~/.irs/bin
music_directory: ~/Music
client_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
client_secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
single_folder_playlist:
    enabled: true
    retain_playlist_order: true
    overwrite_album: false
  4. Set the environment variable IRS_CONFIG_LOCATION pointing to that file
  5. Go to https://developer.spotify.com/dashboard/
  6. Log in or create an account
  7. Click CREATE A CLIENT ID
  8. Enter all necessary info, true or false, continue
  9. Find your client key and client secret
  10. Copy them into where all the X's are in your config file from above

You should be good to go! Run the file from your command line to get help on usage or keep reading!

Optionally From Source

Or if you're one of those cool people who compiles from source

  1. Install crystal-lang (https://crystal-lang.org/install/)
  2. Clone it (git clone https://github.com/cooperhammond/irs)
  3. CD it (cd irs)
  4. Build it (shards build)

Usage

How it works

At it's core irs downloads individual songs. It does this by interfacing with the Spotify API, grabbing metadata, and then searching Youtube for a video containing the song's audio. It will download the video using youtube-dl, extract the audio using ffmpeg, and then pack the audio and metadata together into an MP3.

From the core, it has been extended to download the index of albums and playlists through the spotify API, and then iteratively use the method above for downloading each song.

It used to be in python, but

  1. I wasn't a fan of python's limited ability to distribute standalone binaries
  2. It was a clusterfuck of code that I made when I was little and I wanted to refine it
  3. crystal-lang made some promises and I was interested in seeing how well it did (verdict: if you're building high-level tools you want to run quickly and distribute, it's a joy to work in)

Contributing

Any and all contributions are welcome. If you think of a cool feature, send a PR or shoot me an email. If you think something could be implemented better, please shoot me an email. If you like what I'm doing here, pretty please shoot me an email.

  1. Fork it (https://github.com/your-github-user/irs/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request