Skip to main content

A simple spotify tool for the terminal

Project description

Spotr - A spotify tool for the terminal

A very simple CLI for controlling your spotify on the fly in the terminal.
Made in python for simplicity

NEWS

It is now possible to bring the pictures into the terminal with image to ascii convertion!
Use "ascii" command to show image
Or set ASCII variable to True in config.json to replace spotify logo with ascii image for "current" command

Installation

Manual

Due to registration on pypi being temporarily disabled,you currently have to do a bit more manual work until it opens again

  1. Clone repo to your computer and cd into folder

  2. Build files "python3 setup.py sdist bdist_wheel"

  3. Install package "pip3 install ." (if you wish to later uninstall "pip3 uninstall spotrpy")

  4. Register an app in spotify for developers "https://developer.spotify.com/dashboard/applications" (also set callback URI to "https://www.google.com/")

  5. Run any spotr command

  6. You will be prompted to create config.json and paste in client and secret id from spotify app

  7. After these steps everything should work and you can enjoy spotr

Built-in Commands

ascii - Ascii image for current track authorise - Authenticate with Spotify API config - Modify config values in the terminal current - Display information about the current track next - Play next track playback - Set playback state playlist - Choose a playlist playlistadd - Add currently playing track to playlist previous - Play previous track qsearch - Quicksearch for tracks queue - Get Queue recent - Get recently played tracks recommend - Play random / recommended tracks based on recent tracks refresh - Refresh API key replay - Replay/Restart currently playing song search - Search for anything on spotify, Types - track, playlist, album seek - Seek posistion for track in seconds shuffle - Toggle shuffle, on / off start - Start/Resume playing stop - Stop/Pause playing vol - Ajust volume volume - Ajust volume web - Open currently playing track in a broswer

Debug mode

Simply change the debug variable in .env file to enable debug mode (DEBUG="True")

Modifications

You can easily create your own commands and scripts by adding a function in router.py

As soon as the function is created and saved you can run it on the terminal with (spotr function-name)

I recommend going to spotifys API documentation to get a grasp of what is possible

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

spotrpy-0.1.tar.gz (14.2 kB view hashes)

Uploaded Source

Built Distribution

spotrpy-0.1-py3-none-any.whl (14.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page