Skip to main content

play music from your termninal.

Project description

pymusicterm

pymusicterm is a terminal-based music player that allows you to play your favorite songs directly from your terminal. It only supports local files.

Features

  • Play local music files.
  • 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 to control playback with external tools.

Installation

Prerequisites

  • Python 3.12 or higher.
  • ffmpeg (required for pydub and audio processing).

You can install pymusicterm via pip:

Clone the repository:

git clone https://github.com/yourusername/pymusicterm.git
cd pymusicterm

Install dependencies:

pip install -r requirements.txt

Run the application:

python -m pymusicterm

Make sure all dependencies are met, including ffmpeg.

Basic Commands

  • Play local files: Add the path to the file or directory.
  • 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 (pymusicterm.toml) for custom settings in the ~/.pymusicterm directory.

Dependencies

pymusicterm relies on the following libraries:

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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

musicterm-0.0.2.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

MusicTerm-0.0.2-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file musicterm-0.0.2.tar.gz.

File metadata

  • Download URL: musicterm-0.0.2.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.25

File hashes

Hashes for musicterm-0.0.2.tar.gz
Algorithm Hash digest
SHA256 d72f3641766bc8645b2d0ef3f0760ea3fec25de3a38b996f3bcc26ce0d4ec864
MD5 fbaea01c24c98b5fa79a4caf8e10f2bd
BLAKE2b-256 c02118643bd1579013ba8ebfa0853a3f31149e55d3a4e4e92b21cd738febb085

See more details on using hashes here.

File details

Details for the file MusicTerm-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: MusicTerm-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.25

File hashes

Hashes for MusicTerm-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4989e5edd785f8fc776261569fd57c674ebf115cec913fe65a57d48b00828fee
MD5 670cec14f37bc77deea64c91cc2897df
BLAKE2b-256 1b3c1e260151e1483f2066dadfb2813707e6c0739a715500da21ca6d7ff67d3c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page