https://github.com/ruffbuff/cmp-py

A simple command line music player
https://github.com/ruffbuff/cmp-py

archlinux hyprland music-player python-cli

Last synced: 29 days ago
JSON representation

A simple command line music player

• Host: GitHub
• URL: https://github.com/ruffbuff/cmp-py
• Owner: ruffbuff
• License: cc-by-sa-4.0
• Created: 2024-10-12T14:38:22.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T18:11:21.000Z (4 months ago)
• Last Synced: 2024-11-10T12:04:41.408Z (3 months ago)
• Topics: archlinux, hyprland, music-player, python-cli
• Language: Python
• Homepage:
• Size: 3.56 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## CMP - Command Music Player ( cmp-py )

A simple command line music player

Developed by:

```shell

▄▄▄  ▄• ▄▌·▄▄▄·▄▄▄ ▄▄▄▄·  ▄• ▄▌·▄▄▄·▄▄▄

▀▄ █·█▪██▌▐▄▄·▐▄▄· ▐█ ▀█▪ █▪██▌▐▄▄·▐▄▄·

▐▀▀▄ █▌▐█▌██▪ ██▪  ▐█▀▀█▄ █▌▐█▌██▪ ██▪ 

▐█•█▌▐█▄█▌██▌.██▌ .██▄▪▐█ ▐█▄█▌██▌.██▌.

.▀  ▀ ▀▀▀ ▀▀▀ ▀▀▀  ·▀▀▀▀   ▀▀▀ ▀▀▀ ▀▀▀ 

```

![Sneak-peek0](images/image0.png)


![Sneak-peek1](images/image1.png)


![Sneak-peek2](images/image2.png)


![Sneak-peek3](images/image3.png)


### Installation

1: `git clone https://github.com/ruffbuff/cmp-py`


2: `cd cmp-py`


3: `pip install requirements.txt`


4: `touch .env`, add `API_KEY=YOUR_API_KEY`, then go to `.config/cmp/conf.py` change `MUSIC_PATH` to yours.


5: `nano ~/.config/cmp/cmp.sh`


6.0: Then add this **[cmp.sh](.config/cmp/cmp.sh)** bash script, and make it executable.


(If you use `Kitty` like me, in my `kitty.conf` i have `window_padding_width 15`,so i use `restore_padding` func.)


6.1: `chmod +x ~/.config/cmp/cmp.sh`


7: Last thing: `cd` to your terminal framework config like `~/.zshrc` for `zsh`,
 and find lines with `Helpful aliases`,
 add `alias cmp='~/.config/cmp/cmp.sh'`, then `ctrl+o` + `Enter` to save, and `ctrl+x` to exit.


8: Start your terminal and write `cmp`


### Contribution

**[ruffbuff](https://github.com/ruffbuff)**


### License

**[CC-BY-SA-4.0](LICENSE)**


[Link](https://choosealicense.com/licenses/cc-by-sa-4.0/#)