Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fwcd/drum

Tool for copying or backing up playlists across music services like Spotify or Apple Music
https://github.com/fwcd/drum

apple-music backup playlist-manager spotify

Last synced: about 1 month ago
JSON representation

Tool for copying or backing up playlists across music services like Spotify or Apple Music

Host: GitHub
URL: https://github.com/fwcd/drum
Owner: fwcd
License: mit
Created: 2020-12-24T02:14:04.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-02-26T03:18:48.000Z (11 months ago)
Last Synced: 2024-11-29T12:53:49.499Z (about 2 months ago)
Topics: apple-music, backup, playlist-manager, spotify
Language: Ruby
Homepage: https://fwcd.github.io/drum
Size: 775 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Drum

[![Test](https://github.com/fwcd/drum/actions/workflows/test.yml/badge.svg)](https://github.com/fwcd/drum/actions/workflows/test.yml)
[![Documentation](https://github.com/fwcd/drum/actions/workflows/documentation.yml/badge.svg)](https://fwcd.github.io/drum)

A small tool for copying your playlists across music streaming services. Think `rsync`, but for playlists.

![Icon](artwork/icon128.png)

## Usage

The basic usage pattern is always `drum cp [source] [destination]` where `source` and `destination` may be any of the following (internally called _a ref_):

* A file or folder, e.g.
* `.`
* `some/folder`
* `some-file.yaml`
* A URI, e.g.
* `https://open.spotify.com/playlist/123456`
* `spotify:playlist:123456`
* `https://music.apple.com/us/playlist/some-name/pl.123456789`
* `file:///path/to/list.yaml`
* A special token, e.g.
* `@spotify/playlists`
* `@spotify/tracks`
* `@applemusic/playlists`
* `@music/playlists` (referring to the local Apple Music (`Music.app`) library on macOS)
* `@stdin`
* `@stdout`
* A dash `-`, synonymous with `@stdin` and `@stdout`, depending on usage

> [!NOTE]
> If the source is folder-like, i.e. includes multiple playlists, the destination has to be folder-like too. (The reverse is not true though.)

### Examples

**Download a playlist from Spotify.**

* `drum cp https://open.spotify.com/playlist/123456 my-fancy-list.yaml`
* `drum cp spotify:playlist:123456 my-fancy-list.yaml`
* `drum cp spotify:playlist:123456 some/folder`

**Download your liked songs playlist from Spotify.**

* `drum cp @spotify/tracks liked.yaml`

**Download all playlists from your Spotify library.**

* `drum cp @spotify/playlists .`

**Upload a playlist to Spotify.**

* `drum cp my-fancy-list.yaml @spotify/playlists`

## Supported Services

Currently, the following music services are supported:

* Spotify
* Apple Music
* Local, YAML-based playlists (via stdio or files)

> [!NOTE]
> The tool only processes metadata, not the actual audio files.

## Development

After checking out the repo, run `bin/setup` (or `bundle install`) to install dependencies.

To run the application, run `bundle exec bin/drum`. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

> [!IMPORTANT]
> You may need to run `bundle exec ruby bin/drum` on Windows

To package the application into a gem, run `bundle exec rake build`. The built gem should then be located in `pkg`.

> [!IMPORTANT]
> If you wish to install `drum` using `gem install`, you may need to install additional gems such as `rb-scpt` on macOS to use platform-specific integrations. See [the `Gemfile`](Gemfile) for more information.

To install the gem, run `bundle exec rake install`.

To generate the documentation, run `bundle exec rake yard`.

To run tests, run `bundle exec rake spec`.

> [!TIP]
> If you wish to use a language server such as Solargraph and code completion isn't working for required gems, you may have to run `yard gems`: https://solargraph.org/guides/troubleshooting

### Spotify

To use the service integration with Spotify, set the following environment variables:

```
SPOTIFY_CLIENT_ID=...
SPOTIFY_CLIENT_SECRET=...
```

The client ID and secret can be obtained by creating a Spotify application in the [developer dashboard](https://developer.spotify.com/dashboard/applications). After adding the application, make sure to whitelist the following redirect URI (required for user authentication):

```
http://localhost:17998/callback
```

### Apple Music

To use the service integration with Apple Music, set the following environment variables:

```
MUSICKIT_KEY_P8_FILE_PATH=...
MUSICKIT_KEY_ID=...
MUSICKIT_TEAM_ID=...
```

This keys can be obtained as described [here](https://developer.apple.com/documentation/applemusicapi/getting_keys_and_creating_tokens) (requires an Apple Developer Program membership).

## Limitations

* The Spotify API [does not support folders](https://developer.spotify.com/documentation/general/guides/working-with-playlists/#folders)
* The Apple Music API does support folders, these are not implemented yet, however (see [this issue](https://github.com/fwcd/drum/issues/17))

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/fwcd/drum.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).