Metadata-Version: 2.5
Name: litt
Version: 0.1.0
Summary: Display lyrics of playing song in terminal
Requires-Python: >=3.10
Requires-Dist: pillow==12.3.0
Requires-Dist: pyfiglet==1.0.4
Requires-Dist: rich==15.0.0
Requires-Dist: simple-term-menu==1.6.6
Requires-Dist: syncedlyrics==1.0.1
Description-Content-Type: text/markdown

# LITT

LITT (Lyrics in the Terminal) is, as the name suggests, a way to display lyrics of the currently playing song in the terminal.
Note that this tool currently only supports linux as it uses playerctl but it may be expanded to multiple operating systems in the future.

## Usage
Firstly make sure playerctl is installed:
```bash
# Debian / Debian-based
sudo apt install playerctl

# Fedora / Fedora-based
sudo dnf install playerctl

# Arch / Arch-based
sudo pacman -S playerctl
```

You can run LITT by typing `litt` and then choose your playerctl source.
To access the settings run `litt --settings`.

## Installation

This tool is currently in development and has no official release but you can try out the bleeding edge version by building it yourself with the steps below.

## Building

Prerequisites
- python (with pip)
- git/(gh)

1. Clone GitHub repository
```bash
git clone https://github.com/FabBeyond/litt.git
cd litt
```

2. Set up a virtual environment
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```

3. Run the program
```bash
python3 src/main.py
```
