https://github.com/funkycharlie/consolify
A CLI interface for Spotify using python. Compatible with Windows, Mac and Linux!
https://github.com/funkycharlie/consolify
cli python spotify spotipy
Last synced: 4 months ago
JSON representation
A CLI interface for Spotify using python. Compatible with Windows, Mac and Linux!
- Host: GitHub
- URL: https://github.com/funkycharlie/consolify
- Owner: funkycharlie
- License: gpl-2.0
- Created: 2023-11-30T16:40:34.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-21T20:22:06.000Z (over 2 years ago)
- Last Synced: 2025-10-25T20:11:15.607Z (9 months ago)
- Topics: cli, python, spotify, spotipy
- Language: Python
- Homepage:
- Size: 110 KB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# This project is no longer being worked on due to the fact that I switched to YouTube Music. However, I will be working on a YTM version of this app, so stay tuned!
## If you like, you could fork this, I'd love to see this project be finished!
# Consolify - Spotify Console Interface
Please comment on my checklist for what to add on notion! https://www.notion.so/Checklist-for-Consolify-19c140633f41419a945bdc1bc4317f5d?pvs=4
Consolify is a console interface for interacting with the Spotify API using the Spotipy library.
## Getting Started
1. **Clone the repository:**
```bash
git clone https://github.com/funkycharlie/consolify.git
cd consolify
```
2. **Install dependencies:**
```bash
pip install -r requirements.txt
```
3. **Set up Spotify API credentials:**
- Go to [Spotify Developer Dashboard](https://developer.spotify.com/dashboard) and create a new application.
- Enter a name and description for your application.
- Set the application's redirect URI to: `http://localhost:8080`
- Copy the Client ID and Client Secret from your application's settings.
- Run the main.py and enter the prompted Client ID and Client Secret:
```bash
python main.py
```
## Features
### Commands (`commands.py`)
- **nowplaying [options]:** Display information about the currently playing song.
- Option "-a" shows the album of the song.
- Option "-l" adds the song to your library (liked songs).
- **search [options]:** Search for a specific song on Spotify.
- Option "-a" shows the album for each search result.
- Option "-q" adds the first search result to the queue.
- Option "-p" plays the first search result.
- **library:** Displays the last 20 tracks you added to your library.
- **pause:** Pause the currently playing song.
- **play:** Resume playback or play recently played tracks if no current playback.
- **skip:** Skips to the next song.
- **prev:** Skips to the previous song.
- **shuffle** Toggles the shuffle state.
- **createplist:** Create a new playlist for the authenticated user.
- **playlists:** Allows you to view all the songs in a playlist from your library. There are many things you can do with this function.
- **close:** Exit the program.
- **help:** Display a list of available commands and usage information.
## Playback and Search
### `global_functions.py`
#### Functions
- **choose_device():** Choose a device for playback.
- **playback(selected_track):** Start playback of a selected track.
- **add_to_queue(selected_track):** Add a selected track to the playback queue.
- **spotify_search_global(args):** Global search function with various options.
- **add_songs_playlist(playlist):** Add songs to a specified playlist.
### `sp_module.py`
This script is used to set up Spotify API credentials for the Consolify application.
## Usage
1. Run the main.py file to authenticate with Spotify.
2. Enter commands in the console to control your Spotify playback and perform other actions.
For more details, refer to the source code and individual module documentation.
## Dependencies
- spotipy: Spotify API library
- Other project dependencies (see requirements.txt)
## Author
Funkycharlie
## License
This project is licensed under the GNU General Public License - see the [LICENSE](LICENSE) file for details.