mybigman / mucliar

YouTube automator bringing you your music right on your CLI.

muCLIar

Coffee, Music and Code! What else could we developers ask for?

But then, long gone are days of slow internet and locally stored songs. muCLIar is a command line utility that lets you play the song you wish to listen to, directly through your command line. muCLIar lets you log in to Youtube and hence plays your "similar song" playlist as well, so you can search a song and then enjoy the mood for a long while.

Note

1. Multiple new features are added. Do consider uninstalling once and installing the fresh version.
2. muCLIar is in active development. If you land into unprecedented errors, please feel free to open an issue. We would work on it as soon as possible.
3. We are still working on finding a workaround to let you login to your YouTube account so that your "favourite songs playlist" starts playing after the current song finishes. We did have the login functionality before, but turns out, Google is now rejecting automated login.

Features

1. Enjoy your music, advertisement and hassle free, right from your terminal in a single lined command.
2. Play/Pause/Switch between the songs using simple keypresses.
3. Play the YouTube mix relevant to your song.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

1. Conda
2. Ubuntu(Actively testing on some other distros)
3. Google Chrome

Installing

The repository has the installer script. This is what you need to do to get muCLIar running on your system:

1. Clone the repository:

git clone https://github.com/aayush1205/muCLIar.git

2. Get into the muCLIar directory:

cd muCLIar or cd /path/to/muCLIar

3. Run the installer:

./env.sh

4. You might encounter a XVFB display error. Just to ensure it doesn't happen, do the following:

sudo apt-get update -y

sudo apt-get install -y xvfb

Uninstalling

Use the uninstaller script. It will handle all the deletions and script removal.

./uninstall.sh

Using muCLIar

1. Once you are done installing muCLIar, now its time to enjoy this utility. All you have to do is run:

mu -s "name of the song"

2. To quit the player or to change the song to a new one, just generate a keyboard interrupt on the terminal:

Ctrl + C

Built With

• Selenium - Automating Tool
• ChromeDriver - Web Driver

Contributing

How to Contribute?

• Make sure that your changes do not conflict with the core files (changing file directories will require a change in all called paths)
• Follow the original code structure
• Refactoring contributions are welcome, explicitly mention "[Refactor]" in your pull request
• Give a few days to review PRs, code reviews are welcome

Steps to sync fork with master (Open Source Contributors):

If you fork is behind from the master project you can do these to get the latest version in the master branch of your fork. First go to your(cloned) project folders. Open the terminal in this directory then enter the following commands in the terminal:

• Configuring a remote for fork

  $ git remote -v 
  //Lists the current configured remote repository for your fork//
  $ git remote add upstream https://github.com/aayush1205/muCLIar.git
  //Specifies a new remote upstream repository that will be synced with the fork//
  $ git remote -v
  //Should show the newly made remote *upstream* along with your previous remote//
  

• Syncing the fork

  $ git fetch upstream
  //Fetch the branches and their respective commits from the upstream repository//
  $ git checkout master
  //Switches to local master branch//
  $ git merge upstream/master
  //Merges the upstearm remote (Main repo) into your local fork//
  

Python Code Style

PEP8

Authors

See the list of all the contributors who participated in this project.

License

This project is licensed under the Apache License - see the LICENSE.md file for details

Acknowledgments

• AdBlocking Extension