Gather Scrobble - Scrobble your last.fm or Spotify activity to the Gather status.
Project description
Inspired by gathertown/mod-spotify-as-status.
Scrobble your last.fm or Spotify activity to the Gather status.
gather-scrobble
gather-status
Installation
pip install gather-scrobble
As this library has a CLI, you may have permissions issues when installing, so try it with the --user flag:
pip install gather-scrobble --user
Documentation
Configuration
Itโs necessary to configure the following credentials:
Gather Credentials
Access Gather API keis to get your API_KEY.
last.fm Credentials
If you will scrobble from last.fm.
Create a last.fm API account to get your API_KEY and API_SECRET.
Spotify Credentials
If you will scrobble from Spotify.
Access your Spotify account dashboard and create a new app (in case you donโt have one or do not want to use an existing one). And get your CLIENT_ID and CLIENT_SECRET.
Also add a redirect URI in the Edit Settings. Suggested value: http://127.0.0.1:9090.
The spotispy will instantiate a server to receive the access token. More info here.
You can configure your credentials in 4 ways and with respective priorities:
keyring (recommended)
keyring set gather-scrobble GATHER_API_KEY
keyring set gather-scrobble LASTFM_API_KEY
keyring set gather-scrobble LASTFM_API_SECRET
keyring set gather-scrobble LASTFM_USERNAME
keyring set gather-scrobble SPOTIFY_CLIENT_ID
keyring set gather-scrobble SPOTIFY_CLIENT_SECRET
keyring set gather-scrobble SPOTIFY_CLIENT_REDIRECT_URI
environment variables
export GATHER_API_KEY=<GATHER_API_KEY>
export LASTFM_API_KEY=<LASTFM_API_KEY>
export LASTFM_API_SECRET=<LASTFM_API_SECRET>
export LASTFM_USERNAME=<LASTFM_USERNAME>
export SPOTIFY_CLIENT_ID=<SPOTIFY_CLIENT_ID>
export SPOTIFY_CLIENT_SECRET=<SPOTIFY_CLIENT_SECRET>
export SPOTIFY_CLIENT_REDIRECT_URI=<SPOTIFY_CLIENT_REDIRECT_URI>
.ini file
[settings]
GATHER_API_KEY=<GATHER_API_KEY>
LASTFM_API_KEY=<LASTFM_API_KEY>
LASTFM_API_SECRET=<LASTFM_API_SECRET>
LASTFM_USERNAME=<LASTFM_USERNAME>
SPOTIFY_CLIENT_ID=<SPOTIFY_CLIENT_ID>
SPOTIFY_CLIENT_SECRET=<SPOTIFY_CLIENT_SECRET>
SPOTIFY_CLIENT_REDIRECT_URI=<SPOTIFY_CLIENT_REDIRECT_URI>
.env file
GATHER_API_KEY=<GATHER_API_KEY>
LASTFM_API_KEY=<LASTFM_API_KEY>
LASTFM_API_SECRET=<LASTFM_API_SECRET>
LASTFM_USERNAME=<LASTFM_USERNAME>
SPOTIFY_CLIENT_ID=<SPOTIFY_CLIENT_ID>
SPOTIFY_CLIENT_SECRET=<SPOTIFY_CLIENT_SECRET>
SPOTIFY_CLIENT_REDIRECT_URI=<SPOTIFY_CLIENT_REDIRECT_URI>
Usage
Help
$ gather-scrobble --help
Gather Scrobble v0.0.1
Usage:
gather-scrobble start <space_id> [--source SOURCE] [--emojis EMOJIS]
gather-scrobble info
gather-scrobble test <space_id>
Arguments:
<space_id> Gather space id.
Options:
-h --help Show this screen.
-s --source SOURCE Scrobble source, if not defined the tool will try
all available sources configured.
Can be: lastfm, spotify, or any.
If 'any' it will use the first source configured in
the priority: lastfm -> spotify [default: any]
-e --emojis EMOJIS It is possible to customize the emojis, by setting
the list of emojis that will be chosen randomly,
and also you don't like emojis, you can set an
empty string here. [default: ๐ผ๐ต๐ถ๐ง๐ป๐ท๐ธ๐น]
Info
Before starting, check if you have configured the services:
$ gather-scrobble info
Gather Scrobble
โโโโโโโโโโโโโณโโโโโโโโโโโโโโโ
โ Service โ Configured โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ Gather โ True โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ last.fm โ True โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ Spotify โ False โ
โโโโโโโโโโโโโปโโโโโโโโโโโโโโโ
Test
And test your configuration:
$ gather-scrobble test "aAa0aAaAaaA0Aaaa/Name"
Testing connection with Gather...
Success
Testing connection with last.fm...
Success
Testing connection with Spotify...
Success
โโโโโโโโโโโโโณโโโโโโโโโโโโโ
โ Service โ Working? โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ Gather โ True โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ last.fm โ True โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ Spotify โ True โ
โโโโโโโโโโโโโปโโโโโโโโโโโโโ
Start
The first time you scrobble for any of the sources, the user will be asked to authorize your application to access data from the respective scrobble sources.
$ gather-scrobble start "aAa0aAaAaaA0Aaaa/Name"
๐ธ - Evil Papagali - Massacration ๐๐๐๐๐
Docker
Pull
$ docker pull pyanderson/gather-scrobble:0.0.5
Docker Configuration
Keyring
The most common way to manage credentials in docker containers is through environment variables, but in this case, you can still use keyring, through the third-party keyrings.cryptfile, you will need to create a file with your credentials, mount a volume with the file in the path /root/.local/share/python_keyring/cryptfile_pass.cfg and set the KEYRING_CRYPTFILE_PASSWORD environment variable with the password that you used to create the file:
$ docker run -v $(echo $HOME)/.local/share/python_keyring/cryptfile_pass.csg:/root/.local/share/python_keyring/cryptfile_pass.cfg -e KEYRING_CRYPTFILE_PASSWORD=secret_password ...
Env File
Add your credentials to a .env file and use it with the โenv-file option:
$ docker run --env-file /path/to/myfile.env ...
Cache
To avoid being asked to authorize the last.fm/Spotify application in every usage, you should mount a volume to save the gather-scrobble cache folder:
$ docker run -v /path/to/save/cache:/root/.config ...
Docker Usage
The docker container works as an executable, so you can use the same CLI command interface, for example, to test your configuration you can do this:
$ docker run --env-file /path/to/myfile.env -v /path/to/save/cache:/root/.config -it pyanderson/gather-scrobble:0.0.5 test "aAa0aAaAaaA0Aaaa/Name"
Testing connection with Gather...
Success
Testing connection with last.fm...
Success
Testing connection with Spotify...
Success
โโโโโโโโโโโโโณโโโโโโโโโโโโโ
โ Service โ Working? โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ Gather โ True โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ last.fm โ True โ
โฃโโโโโโโโโโโโโโโโโโโโโโโโโซ
โ Spotify โ True โ
โโโโโโโโโโโโโปโโโโโโโโโโโโโ
Examples
To run gather-scrobble in background:
$ docker run -d --restart=always --name gather-scrobble --env-file /path/to/myfile.env -v /path/to/save/cache:/root/.config pyanderson/gather-scrobble:0.0.5 test "aAa0aAaAaaA0Aaaa/Name"
cbe4b6c916d8e7977788462a447b8a6c9e526f46f5c9b85d7be5f843e7fd80dc
Check the logs:
$ docker logs gather-scrobble
[2023-04-29 15:39:30,637][DEBUG] loading credentials
[2023-04-29 15:39:31,427][DEBUG] starting application
[2023-04-29 15:39:32,925][DEBUG] application started
[2023-04-29 15:40:05,650][DEBUG] ๐ผ - Madhouse - Anthrax
Stop:
$ docker rm -r gather-scrobble
gather-scrobble
FAQ
How to get the space_id value? First enter in the space you want to scrobble, the space_id will be in the URL after the /app/. E.g., in the URL โhttps://app.gather.town/app/aAa0aAaAaaA0Aaaa/Nameโ the space_id is aAa0aAaAaaA0Aaaa/Name.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gather_scrobble-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a46bb6c729ab8be10783dcc890842d741d36f9c571bd36ab137ea1a567659a8 |
|
MD5 | 53209ddd1b2009a6c6778a3efaa34214 |
|
BLAKE2b-256 | 018b981cdadb5b9a4a4aeecd1f57c0042f2a40c8c3769aacfd9cb9ca5e4fdd14 |