Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dietrichm/admirer
🔄 🎶 Sync loved tracks between music services.
https://github.com/dietrichm/admirer
cli go golang lastfm spotify sync synchronization
Last synced: about 13 hours ago
JSON representation
🔄 🎶 Sync loved tracks between music services.
- Host: GitHub
- URL: https://github.com/dietrichm/admirer
- Owner: dietrichm
- License: mit
- Created: 2020-12-31T12:24:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T20:33:05.000Z (5 months ago)
- Last Synced: 2024-06-20T22:36:53.261Z (5 months ago)
- Topics: cli, go, golang, lastfm, spotify, sync, synchronization
- Language: Go
- Homepage: https://dietrichm.github.io/admirer/
- Size: 764 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Admirer
[](go.mod)
[](https://github.com/dietrichm/admirer/actions/workflows/go.yml)
[](LICENSE)
[](https://pkg.go.dev/github.com/dietrichm/admirer)
A command line utility to sync loved tracks between music services.
- [Installation](#installation)
- [Building from source](#building-from-source)
- [Usage](#usage)
- [Supported services](#supported-services)
- [Authentication](#authentication)
- [Use cases](#use-cases)
- [Listing recently loved or added tracks](#listing-recently-loved-or-added-tracks)
- [Syncing recently loved tracks between services](#syncing-recently-loved-tracks-between-services)
- [License](#license)
## Installation
Compiled binaries will be provided for version 1.0.0.
**Note**: Admirer is currently only tested on Linux.
### Building from source
Please [install Go 1.20 first](https://golang.org/doc/install), set the `GOPATH` environment variable and ensure `$GOPATH/bin` is present in `$PATH`.
```sh
go install github.com/dietrichm/admirer@latest
```
## Usage
```
Usage:
admirer [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
list List loved tracks on specified service
login Log in on external service
status Retrieve status for services
sync Sync recently loved tracks from one service to another
Flags:
-h, --help help for admirer
Use "admirer [command] --help" for more information about a command.
```
### Supported services
Last.fm and Spotify have an initial implementation.
In the future, I would like to add support for [ListenBrainz](https://listenbrainz.org/) and CSV/JSON files as well ([#27](https://github.com/dietrichm/admirer/issues/27)).
### Authentication
Before using any of the provided services, you need to create **your own API application** on said service and export your new API client ID and secret as environment variables:
| Service | Creating your app | Environment variables |
| ------- | ----------------- | --------------------- |
| Last.fm | [Create an account here](https://www.last.fm/api/account/create) | `LASTFM_CLIENT_ID` and `LASTFM_CLIENT_SECRET` |
| Spotify | [Manage and create an app here](https://developer.spotify.com/dashboard/applications) | `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` |
When this is done, continue with the following steps.
1. Run `admirer login ` to retrieve an authentication URL.
1. By visiting this URL, the service will ask confirmation and redirect back to a non existing URL `https://admirer.test/...`.
1. Copy and paste the desired query parameter from the URL into the CLI input and press Enter.
1. If all goes well, you will retrieve confirmation that you have been logged in.
**Note 1**: after [#23](https://github.com/dietrichm/admirer/issues/23), API client IDs and secrets will be queried during login and stored along with other authentication secrets.
**Note 2**: [#25](https://github.com/dietrichm/admirer/issues/25) will add an internal HTTP server to retrieve the authentication callback automatically.
## Use cases
### Listing recently loved or added tracks
Using the `list` command, you can retrieve a list of your most recently loved or added tracks on said service.
### Syncing recently loved tracks between services
Using the `sync` command, you can synchronise recently loved tracks from one service to another.
For example to mark as loved on Last.fm the same tracks that were added to your library on Spotify, or vice versa.
## License
Copyright 2020, Dietrich Moerman.
Released under the terms of the [MIT License](LICENSE).