Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pwittchen/spotify-cli-linux
🎶 A command line interface to Spotify on Linux
https://github.com/pwittchen/spotify-cli-linux
cli linux python shell spotify terminal
Last synced: 3 days ago
JSON representation
🎶 A command line interface to Spotify on Linux
- Host: GitHub
- URL: https://github.com/pwittchen/spotify-cli-linux
- Owner: pwittchen
- License: gpl-3.0
- Created: 2017-03-03T22:20:47.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-09T10:55:38.000Z (15 days ago)
- Last Synced: 2024-12-14T21:04:50.428Z (10 days ago)
- Topics: cli, linux, python, shell, spotify, terminal
- Language: Python
- Homepage: https://pwittchen.github.io/spotify-cli-linux
- Size: 154 KB
- Stars: 646
- Watchers: 12
- Forks: 57
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# spotify-cli-linux
[](https://github.com/pwittchen/spotify-cli-linux/actions/workflows/build.yml) [](https://pypi.python.org/pypi/spotify-cli-linux/) [](https://pypi.python.org/pypi/spotify-cli-linux/)
A command line interface to [Spotify](https://www.spotify.com/) on Linux.
This project is inspired by the similar project called [shpotify](https://github.com/hnarayanan/shpotify), which does similar things, but on macOS.
installation
------------
```
pip install spotify-cli-linux
```
**hint #1**: if you encounter problems during installation, try to call command with `sudo`
**hint #2**: if you still have problems (e.g. with resolving project dependencies), try to call `pip3` instead of `pip`
if you have any problems with `pip` or `pip3`, you can try to install the script in the alternative way as a workaround:
```
git clone [email protected]:pwittchen/spotify-cli-linux.git
cd spotify-cli-linux
sudo cp spotifycli/spotifycli.py /usr/local/bin/spotifycli
```
upgrade
-------
```
pip install spotify-cli-linux --upgrade
```
for the upgrade, you can apply the same hints like for installation
usage
-----
start the official Spotify desktop app
run the following command from your terminal:
```
spotifycli
```
use one of the following parameters:
```
-h, --help show this help message and exit
--version shows version number
--status shows song name and artist
--statusshort shows status in a short way
--statusposition shows song name and artist, with current playback position
--song shows the song name
--songshort shows the song name in a short way
--artist shows artists name
--artistshort shows artist name in a short way
--album shows album name
--arturl shows album image url
--lyrics shows lyrics for the song playing
--playbackstatus shows playback status
--position shows song position
--play plays the song
--pause pauses the song
--playpause plays or pauses the song (toggles a state)
--next plays the next song
--prev plays the previous song
--songuri OPENURI plays the track at the provided Uri
--listuri OPENURI plays the playlist at the provided Uri
--client CLIENT sets client's dbus name
```
if you don't use any parameters, you'll enter the shell mode, where you'll be able to use all commands mentioned above
solving problems
----------------
### lyricwikia
When, you're missing `lyricwikia` dependency, run the following command:
```
pip install lyricwikia
```
usage with tmux
---------------
If you want to use this script in your tmux panel, you can check [tmux-plugin-spotify](https://github.com/pwittchen/tmux-plugin-spotify).
development
-----------
to install necessary tools for code formatting, static code analysis and releasing, run:
```
make requirements
```
code formatting
---------------
Source code should be formatted according to [PEP8](https://www.python.org/dev/peps/pep-0008/) style guides.
To format code, run:
```
make format
```
to verify code formatting, type:
```
make checkformat
```
static code analysis
--------------------
To run static code analysis, execute:
```
make lint
```
docs
----
to update docs on `gh-pages`, type:
```
make docs
```
to run docs locally, type:
```
git checkout gh-pages && ./serve.sh
```
and view page with docs at: 0.0.0.0:8000
view it on-line at https://pwittchen.github.io/spotify-cli-linux
releasing
---------
currently release is automated via `deploy.yml` GitHub Action, but it can be done manually too
configure your `~/.pypirc` file as follows:
```
[distutils]
index-servers =
pypi
[pypi]
username:yourusername
password:yourpassword
```
then, update version in `spotifycli/version.py` and `spotifycli/spotifycli.py` and type:
```
make release
```
**note**: Version is not kept in a single file due to problems with importing files within another file and distributing them to PyPi. There are also Python vesion issues. If you know how to fix this issue properly to keep version in one place, I'd be happy to review your PR :-).