pymusicterm

pymusicterm is a terminal-based music player that allows you to play your favorite songs directly from your terminal.

Features

• Play offline music.
• Download music from YouTube with pytubefix and ytmusicapi.
• Terminal-based interface powered by textual.
• Cross-platform support (Linux, macOS, Windows).
• MPRIS server integration for Linux and MACOS to control playback with external tools.

Important

The song are in the ~/.pymusicterm/musics folder with specific name and tags

Installation with uv

pip install uv
git clone https://github.com/ZachVFXX/PyMusicTerm.git
cd PyMusicTerm
uv sync #or pip install the dependencies

Prerequisites

• Python 3.12 (tested) or higher.
• ffmpeg (required for pydub and audio processing).
• On linux, install PyObject for mpris

Basic Commands

• Download from YouTube: Search for a song or paste the URL.
• Control playback: Use keyboard shortcuts to play, pause, skip, or adjust volume.

Configuration

The player reads a configuration file (setting.toml) for custom settings in the ~/.pymusicterm directory.

Dependencies

pymusicterm relies on the following libraries:

• just-playback: Audio playback management.
• msgspec: High-performance serialization.
• pydub: Audio processing.
• pytubefix: Simplified YouTube streaming.
• textual: Terminal user interface framework.
• ytmusicapi: YouTube Music API integration.
• loguru: Advanced logging.
• mpris-server: MPRIS integration (Linux and macos only).

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature/bugfix.
3. Submit a pull request with a detailed explanation of changes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Enjoy your music in the terminal with pymusicterm!