subpy/README.md

# SubPy (Name pending)

SubPy is a terminal user interface (TUI) music player written in Python primarly using the Textual library. SubPy connects to a SubSonic server using the SubSonic API to stream music to your machine.

# Usage

## Installation

Python >= 3.12

1. Clone the repo using `git clone`
2. Install dependencies `python -m pip install -r requirements.txt`
3. Set up auth file

## Auth File

This program requires a file simply named `auth` that contains your username and password as such `username,password`.

# Screenshots

Player

![Music player with media control buttons, a progress bar, and cover art](.attachments/player.png)

Song Queue

![Modal screen infront of the player with a table holding songs in the queue](.attachments/queue.png)

Artists Page

![![Artists Page](.attachments/artists-menu.png)](.attachments/artists-menu.png)

![View of an artists discography](.attachments/artist-discography.png)


View of favorite songs

![View of favorited songs](.attachments/songs-screen-favourites.png)