litt 0.1.0__tar.gz

litt-0.1.0/.gitignore

@@ -0,0 +1,224 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+bin/
+lib64
+pyvenv.cfg
+include/

litt-0.1.0/PKG-INFO

@@ -0,0 +1,60 @@
+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
+```

litt-0.1.0/README.md

@@ -0,0 +1,48 @@
+# 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
+```

litt-0.1.0/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "litt"
+version = "0.1.0"
+description = "Display lyrics of playing song in terminal"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+  "rich==15.0.0",
+  "simple-term-menu==1.6.6",
+  "pyfiglet==1.0.4",
+  "syncedlyrics==1.0.1",
+  "pillow==12.3.0"
+]
+
+[project.scripts]
+litt = "litt.main:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/litt"]

litt-0.1.0/requirements.txt

@@ -0,0 +1,5 @@
+rich==15.0.0
+simple-term-menu==1.6.6
+pyfiglet==1.0.4
+syncedlyrics==1.0.1
+pillow==12.3.0

litt-0.1.0/src/litt/fonts/OFL.txt

@@ -0,0 +1,92 @@
+This Font Software is licensed under the SIL Open Font License,
+Version 1.1.
+
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font
+creation efforts of academic and linguistic communities, and to
+provide a free and open framework in which fonts may be shared and
+improved in partnership with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply to
+any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software
+components as distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to,
+deleting, or substituting -- in part or in whole -- any of the
+components of the Original Version, by changing formats or by porting
+the Font Software to a new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed,
+modify, redistribute, and sell modified and unmodified copies of the
+Font Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components, in
+Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the
+corresponding Copyright Holder. This restriction only applies to the
+primary font name as presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created using
+the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

litt-0.1.0/src/litt/main.py

@@ -0,0 +1,251 @@
+from rich.console import Console
+from rich.align import Align
+from rich.text import Text
+from PIL import Image, ImageDraw, ImageFont
+from simple_term_menu import TerminalMenu
+import syncedlyrics
+import pyfiglet
+import time
+from requests.exceptions import RequestException
+from datetime import datetime
+import subprocess
+import sys
+import argparse
+import re
+import os
+import json
+
+def cmd(command):
+    return subprocess.run(command, capture_output=True, text=True)
+
+if subprocess.run(["which", "playerctl"], capture_output=True, text=True).returncode != 0:
+    print("Playerctl isnt installed or added to PATH")
+    sys.exit(1)
+if cmd(["playerctl", "-l"]).stdout.strip() == "":
+    print("No playerctl source")
+    sys.exit(1)
+
+settings = {}
+config_dir = os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config"))
+config_path = os.path.join(config_dir, "litt")
+config_file = os.path.join(config_path, "config.json")
+DEFAULTS = {"font": "base", "font_style": "blocky"}
+os.makedirs(config_path, exist_ok=True)
+if not os.path.isfile(config_file):
+    with open(config_file, "w") as f:
+        json.dump(DEFAULTS, f, indent=2)
+with open(config_file) as f:
+    settings = {**DEFAULTS, **json.load(f)}
+
+parser = argparse.ArgumentParser("LITT")
+parser.add_argument("--settings", action="store_true")
+args = parser.parse_args()
+if args.settings:
+    from litt import settings
+    sys.exit(1)
+
+TOKEN_RE = re.compile(
+    r'[\u3040-\u30ff\u3400-\u4dbf\u4e00-\u9fff\uf900-\ufaff\uff66-\uff9f\uac00-\ud7a3]'
+    r'|\s+'
+    r'|\S+'
+)
+
+console = Console()
+players = subprocess.run(["playerctl", "-l"], capture_output=True, text=True).stdout.strip()
+players = players.split("\n")
+player_menu = TerminalMenu(players, title="Choose your playerctl source:")
+selected_player = player_menu.show()
+if selected_player is None:
+    sys.exit(0)
+selected_player = players[selected_player]
+
+POLL_RATE = 0.1
+
+def parse_timestamp(stamp):
+    try:
+        stamp = stamp.split("]")[0][1:].replace(".", ":")
+        dt = datetime.strptime(stamp, "%M:%S:%f")
+        return dt.minute * 60 + dt.second + dt.microsecond / 1000000
+    except:
+        return None
+
+def get_position():
+    result = playerctl("position")
+    return float(result.stdout.strip())
+
+
+def playerctl(*args):
+    return cmd(["playerctl", "-p", selected_player, *args])
+
+def get_playing_song():
+    return playerctl("metadata", "--format", "{{title}} -||- {{artist}}").stdout.strip().split(" -||- ")
+
+def wait_until_next_song():
+    last_song = get_playing_song()
+    while get_playing_song() == last_song:
+        last_song = get_playing_song()
+        time.sleep(1)
+def blockify(text, consoleWidth, font_path="", size=25):
+    if settings["font"] == "base":
+        font_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "fonts", "NotoSansCJK-Regular.ttc")
+    else:
+        font_path = settings["font"]
+
+    font = ImageFont.truetype(font_path, size)
+    wrapped = wrap_text(text, font, consoleWidth * (1 if settings["font_style"] == "blocky" else 2))
+
+    measure = ImageDraw.Draw(Image.new("L", (1, 1)))
+    l, t, r, b = measure.multiline_textbbox((0, 0), wrapped, font=font)
+
+    lines = []
+    if settings["font_style"] == "blocky":
+        lines = blocky_lyrics(l, t, r, b, wrapped, font)
+    elif settings["font_style"] == "braille":
+        lines = braille_lyrics(l, t, r, b, wrapped, font)
+
+    return Text("\n".join(lines))
+
+def blocky_lyrics(l, t, r, b, wrapped, font):
+    width = r - l
+    height = b - t
+    height += height % 2
+
+    img = Image.new("L", (width, height), 0)
+    ImageDraw.Draw(img).multiline_text((-l, -t), wrapped, align="center", font=font, fill=255)
+    px = img.load()
+
+    lines = []
+    for y in range(0, height, 2):
+        line = ""
+        for x in range(width):
+            top_filled = px[x, y] > 0
+            bottom_filled = px[x, y+1] > 0
+
+            if top_filled and bottom_filled:
+                line += "█"
+            elif top_filled:
+                line += "▀"
+            elif bottom_filled:
+                line += "▄"
+            else:
+                line += " "
+        lines.append(line)
+
+    return lines
+
+def braille_lyrics(l, t, r, b, wrapped, font):
+    BRAILLE_BITS = {
+        (0, 0): 0x01, (0, 1): 0x02, (0, 2): 0x04, (0, 3): 0x40,
+        (1, 0): 0x08, (1, 1): 0x10, (1, 2): 0x20, (1, 3): 0x80,
+    }
+    width = r - l
+    width += width % 2
+    height = b - t
+    height += (4 - height % 4) % 4
+
+    img = Image.new("L", (width, height), 0)
+    ImageDraw.Draw(img).multiline_text((-l, -t), wrapped, align="center", font=font, fill=255)
+    px = img.load()
+
+    lines = []
+    for y in range(0, height, 4):
+        line = ""
+        for x in range(0, width, 2):
+            bits = 0
+            for (dx, dy), bit in BRAILLE_BITS.items():
+                px_x = x + dx
+                py_y = y + dy
+                if px_x < width and py_y < height and px[px_x, py_y] > 128:
+                    bits |= bit
+            line += chr(0x2800 + bits)
+        lines.append(line)
+
+    return lines
+
+def wrap_text(text, font, max_width):
+    tokens = TOKEN_RE.findall(text)
+    lines = []
+    current = ""
+
+    for token in tokens:
+        candidate = f"{current} {token}".strip()
+        if font.getlength(candidate) <= max_width or not current:
+            current = candidate
+        else:
+            lines.append(current)
+            current = token
+    if current:
+        lines.append(current)
+    return "\n".join(lines)
+
+def main():
+    while True:
+        console.clear()
+        try:
+            playing_song, artist = get_playing_song()
+            lyrics = syncedlyrics.search(f"{playing_song} {artist}")
+        except RequestException as e:
+            print(f"Network error {e}")
+            wait_until_next_song()
+            continue
+        except Exception as e:
+            print(f"An unexpected error occured {e}")
+            wait_until_next_song()
+            continue
+
+        if lyrics is None:
+            print("no lyrics :(")
+            wait_until_next_song()
+            continue
+        if lyrics == []:
+            print("no lyrics :(")
+            wait_until_next_song()
+            continue
+
+        lyrics = lyrics.split("\n")
+        idx = 0
+        last_song = get_playing_song()
+        global_offset = list(filter(lambda x: "offset" in x.lower(), lyrics))
+        if len(global_offset) == 0:
+            global_offset = 0
+        else:
+            global_offset = list(global_offset)[0]
+            global_offset = float(global_offset.split(":")[1].strip()[:-1])
+
+        timed_lyrics = []
+        for lyric in lyrics:
+            timestamp = parse_timestamp(lyric)
+            if timestamp is None:
+                continue
+            timestamp += global_offset
+
+            timed_lyrics.append((timestamp, lyric.split("]")[1].strip()))
+
+        last_song = get_playing_song()
+
+        while True:
+            pos = get_position()
+            text = list(filter(lambda x: x[0] <= pos+global_offset, timed_lyrics))
+            if len(text) == 0:
+                continue
+            content = text[len(text)-1][1].strip()
+
+            new_song = get_playing_song()
+            if new_song != last_song:
+                break
+            last_song = new_song
+
+            banner = Text(content, justify="center")
+
+            text = Align(
+                blockify(content, console.width),
+                vertical="middle",
+                align="center",
+                height=console.height
+            )
+            console.print(text)
+
+            time.sleep(POLL_RATE)
+
+if __name__ == "__main__":
+    main()

litt-0.1.0/src/litt/settings.py

@@ -0,0 +1,33 @@
+from simple_term_menu import TerminalMenu
+import os
+import json
+
+config_dir = os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config"))
+config_file = os.path.join(config_dir, "litt", "config.json")
+settings = json.loads(open(config_file, "r").read())
+
+font_options = ["Style", "Font"]
+font_menu = TerminalMenu(font_options, title="Settings")
+answer = font_menu.show()
+
+if answer == 0:
+    style_options = ["Blocky", "Braille"]
+    style_menu = TerminalMenu(style_options, title="Font Style")
+    answer = style_menu.show()
+
+    if answer == 0:
+        settings["font_style"] = "blocky"
+    elif answer == 1:
+        settings["font_style"] = "braille"
+
+elif answer == 1:
+    fontfont_options = ["Base", "Custom"]
+    fontfont_menu = TerminalMenu(fontfont_options, title="Font")
+    answer = fontfont_menu.show()
+
+    if answer == 0:
+        settings["font"] = "base"
+    elif answer == 1:
+        settings["font"] = input("Custom Font Path: ")
+
+open(config_file, "w").write(json.dumps(settings, indent=2))