Ecosyste.ms: Awesome

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

https://github.com/ceuk/spotui

Spotify in the terminal 💻🎶
https://github.com/ceuk/spotui

cli cli-tool music music-player python python3 spotify spotify-api spotify-connect spotify-tui spotui terminal terminal-app terminal-based tui

Last synced: 20 days ago
JSON representation

Spotify in the terminal 💻🎶

Host: GitHub
URL: https://github.com/ceuk/spotui
Owner: ceuk
License: mit
Created: 2020-01-08T09:43:27.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-07-25T21:01:49.000Z (11 months ago)
Last Synced: 2024-05-02T02:17:21.573Z (about 2 months ago)
Topics: cli, cli-tool, music, music-player, python, python3, spotify, spotify-api, spotify-connect, spotify-tui, spotui, terminal, terminal-app, terminal-based, tui
Language: Python
Homepage:
Size: 87.9 KB
Stars: 502
Watchers: 7
Forks: 20
Open Issues: 8
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-stars - ceuk/spotui - Spotify in the terminal 💻🎶 (Python)
awesome-tuis - spotui

README

# SpoTUI
![Version Badge](https://img.shields.io/pypi/v/spotui)
![License Badge](https://img.shields.io/github/license/ceuk/spotui)
![Code size Badge](https://img.shields.io/github/languages/code-size/ceuk/spotui)

Spotify in the terminal.

![screenshot](https://i.imgur.com/7syOTKb.gif)

Getting Started
-----------

Install with ```pip install spotui```

**Please Note:** SpoTUI will not work with free Spotify accounts.

Register a developer application at: [https://developer.spotify.com/dashboard/login]( https://developer.spotify.com/dashboard/login). Once you create the application you'll need to edit it to add a Redirect URI. Use something like 'http://localhost:8888/callback' (it doesn't matter what you use really as long as it matches what's in your config file).

Run `spotui` to generate a sample config file at ~/.config/spotui/.spotuirc or create one manually with the following:

```
[spotify_api]
user_name = *Your spotify username*
client_id = *Your application client ID*
client_secret = *Your application secret*
redirect_uri = http://localhost:8888/callback

[other]
use_nerd_fonts = yes
config_version = 1
```

Once you're done start the app with `spotui`, log in via your browser and copy the URL of the broken web page you're taken to. *(This ugly authentication process is part of the underlying Spotipy library I use so don't blame me :stuck_out_tongue_winking_eye:)*

This app acts like a kind of remote control for Spotify. The best way to use it is in conjunction with [Spotifyd](https://github.com/Spotifyd/spotifyd) which means you won't need to actually have Spotify open. Alternatively, you can just open Spotify on your computer, phone etc. (press `d` to pick the device to play on).

Controls
-------

**Navigation**

`tab` Switch section

`k`/`↑` Up

`j`/`↓` Down

`g` Scroll to top

`G` Scroll to bottom

`Enter` Select

`/` Search

`d` Open device menu

`Esc`/`q` Quit/Back

**Playback**

`space` Play/Pause

`n` Next track

`p` Previous track

`→` Seek 10s forwards

`←` Seek 10s backwards

`s` Toggle shuffle

`r` Toggle repeat

FAQ
----

* **What do I do if something breaks?** [Raise an issue](https://github.com/ceuk/spotui/issues/new) or submit a PR to fix my crappy code :pray:
* **Why can't I play anything?** Check you have a device selected (d) and make sure you're using a paid Spotify account
* **I get an error page when I log into Spotify** This is correct - just copy the URL and paste it back into the terminal
* **Podcasts aren't playing** See: #13

Dependencies
-----------

* [Spotipy](https://spotipy.readthedocs.io/en/latest/)

LICENSE
------

MIT