README.md

yami | An open-source music player with simple UI

Download or play music locally without ads!

Installation • Usage • Features • Contributing • License

🔍Overview

Yami is a lightweight, open-source music player built in Python. It focuses on simplicity and ease of use, providing an intuitive user interface (UI) for users to manage and play their music. Whether you're playing local files or downloading from online sources using spotdl, Yami offers a seamless experience. This project is designed for users who want a minimalistic, cross-platform music player with the ability to integrate external sources like Spotify/Youtube Music.

📸Screenshot

🛠️ Getting Started

Prerequisites

• Python 3.8+
• pip for dependency management

Installation

From Pip

pip install yami-music-player

From Github

1. Clone the Repository

git clone https://github.com/DevER-M/yami.git
cd yami

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

3. Install yami-music-player (in editable mode):

pip install -e .

Usage

To run yami, use the following command in your terminal:

$ yami 
# Or
$ python -m yami

Features

• Spotdl Integration: Download music directly from the app using spotdl
  • Asynchronous Downloading : From synchronous spotdl.Downloader.search_and_download()
• Player Controls:
  • : Pause/play music
  • : Play next song
  • : Play previous song
  • : Choose folder
  • : Download music
  • ctrl+o : Choose folder

This will open the app, for the logs check the terminal.

Contributing

Contributions are welcome and greatly appreciated! Here's how you can contribute:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPLV3 License. See LICENSE for more information.

Discussions

Discussions are available and can be used for feature requests and questions

Credits

• Custom Tkinter
• Spotdl
• @ElSaico for fixing locale scaling

Star History