spotidry 0.0.9
A boring Spotify CLI client
Requires Python: >=3.10

# Spotidry

- [Spotidry](#spotidry)
- [Summary](#summary)
- [Installation](#installation)
- [Setup](#setup)
  - [Spotify API](#spotify-api)
  - [Configuration](#configuration)
  - [Tmux Integration](#tmux-integration)
  - [Polybar Integration](#polybar-integration)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributions](#contributions)

# Summary

Spotidry is a real dry & boring command-line client for Spotify.

My main motivation for this project is to have a simple client that allows me to save the currently-playing song to my Liked Tracks. I also added play/pause/next/previous commands.

One of the best use cases for `spotidry` is to integrate it into a polybar/tmux/vim status line. You can also map some key-bindings or foot-pedals to send `spotidry` command.

Below, is a demo video showing some basic `spotidry` commands, along with a tmux integration.

![](https://raw.githubusercontent.com/mikeboiko/spotidry/gif/resources/spotidry.gif)

# Installation

It is recommended to install `spotidry` using [uv](https://docs.astral.sh/uv/):

```bash
uv tool install spotidry
```

Alternatively, you can install from PyPI:

```bash
pip install --user spotidry
spotidry --setup
```

Note: I have only tested `spotidry` on Linux.

# Development

To set up a local development environment:

1. Clone the repository:

   ```bash
   git clone https://github.com/mikeboiko/spotidry.git
   cd spotidry
   ```

2. Install the tool in editable mode:

   ```bash
   uv tool install --editable .
   ```

3. Run type checking:
   ```bash
   uv run basedpyright spotidry
   ```

# Deployment

The deployment process to PyPI and GitHub Releases is automated via GitHub Actions.

## Manual Steps

To trigger a new release:

1.  **Update Changelog**: Add release notes for the new version in `CHANGELOG.md`.
2.  **Bump Version**: Update the version number in `spotidry/__init__.py`.
3.  **Commit & Push**: Commit these changes and push to the `master` branch.

## Automated Steps

Once the tag is pushed, the GitHub Action will automatically:

1.  Build the package (`sdist` and `wheel`).
2.  Check the package metadata with `twine`.
3.  Create a **GitHub Release** with the built artifacts and auto-generated notes.
4.  Publish the package to **PyPI**.

> **Note**: Ensure the `PYPI_API_TOKEN` secret is set in the GitHub repository settings.

# Setup

## Spotify API

You will need to register your app at [My Dashboard](https://developer.spotify.com/dashboard/login) to get the credentials necessary to make authorized calls (a client id and client secret).
Select the `Web API` scope.

You can set your redirect URI to something like "http://127.0.0.1:9999"

## Configuration

Configure your Spotify API variables in `~/.config/spotidry/spotidry.yaml`

```yaml
client_id: '<ID>'
client_secret: '<SECRET>'
redirect_uri: 'http://127.0.0.1:9999'
output_format: '{play_symbol} {artist_song} {liked_symbol}'

# Optional: scrolling for long titles (meant for 1Hz status lines like tmux/polybar)
max_width: 30
scroll_speed: 0.5
scroll_gap: '   '
```

The `output_format` string supports the following placeholders:

- `{artist}`: Artist name
- `{song}`: Track title
- `{artist_song}`: Convenience string of `"{artist} - {song}"` (and the one that scrolls)
- `{play_symbol}`: Play/Pause indicator (▶ or ⏸)
- `{liked_symbol}`: Liked status indicator (❤ or ♡)

## Tmux Integration

I'm using the popular [.tmux](https://github.com/gpakosz/.tmux) config.

I have configured `spotidry` to update 1/s in `~/.tmux/.tmux.conf.local`:

```
tmux_conf_theme_status_right='#(flock -n /tmp/spotidry.lock spotidry 2>/dev/null; sleep 1) #{prefix}#{pairing} #{?battery_status, #{battery_status},}#{?battery_bar, #{battery_bar},}#{?battery_percentage, #{battery_percentage},} , %R , %d %b | #{username}#{root} | #{hostname} '
```

## Polybar Integration

Add the following module to `~/.config/polybar/config.ini`

```
[module/spotidry]
type = custom/script
exec = ~/.local/bin/spotidry
exec-if = test -f ~/.local/bin/spotidry
click-left = ~/.local/bin/spotidry --next 2> /dev/null
click-middle = ~/.local/bin/spotidry --save 2> /dev/null
click-right = ~/.local/bin/spotidry --play 2> /dev/null
interval = 1
```

![Polybar screenshot](https://raw.githubusercontent.com/mikeboiko/spotidry/gif/resources/polybar.png)

# Usage

The first time you run `spotidry`, you will be prompted to authorize the app in your browser.

Run `spotidry --help` to see all commands/options.

```
usage: spotidry [-h] [-v] [-s] [-p] [-n] [--previous]

Spotify CLI client

options:
  -h, --help     show this help message and exit
  -v, --version  show program's version number and exit
  -s, --save     toggle liked track status
  -p, --play     play/pause track
  -n, --next     play next track
  --previous     play previous track/skip to beggining of current track
```

Note, in order to re-authorize, delete `~/.cache/spotidry.yaml`... Yes, I will provide a CLI flag for this eventually.

# Roadmap

- [x] Save currently playing song to Liked Tracks
- [x] Add output string customization
- [x] Scrolling Text for Long Titles
- [ ] Add volume controls/status
- [ ] Add socks/https proxy option

# Contributions

Contributions are always welcome!

Feel free to submit an issue or a pull request.