sunillshastry/rhythm

song lyric fetcher & downloader. built with python 3

Rhythm

By Sunil Shastry

Rhythm is an open-source software written in Python 3 programming language. Rhythm is free to download and use for everyone. The main objective of the software is to accurately fetch the lyrics of any and every song available*.

*Every song available on the lyrics.ovh public API

To view full documentation for Rhythm, visit Rhythm Documentation

Installation and Setup

Rhythm is designed and built using Python 3, it is recommend for the user to have Python 3.5 or a higher version of Python installed on their computer device. This is a console based application and consequently it is assumed that the user is aware of running a Python program on their console. However, if a person reading this is not aware of any basic command line interfaces (CLI), I have included a short reference below to get some idea on running the main.py Rhythm file (or any Python file in that regard).

Visit Python.org to install Python 3 on to your device.

To view full documentation for Rhythm, visit Rhythm Documentation

To get started, open up your terminal or command prompt, and follow the given commands to familiarize yourself with the basic CLI commands.

Common Commands

• pwd Print working directory (pwd) displays the path name of the current directory

• cd Change directory (cd), changes from one folder to another. To enter a folder use cd (foldername) and to leave a folder use cd ..

• ls List (ls) provides a list of all files with a directory

• clear Clears information on the display screen to provide a blank slate

CLI Reference: https://dev.to/kymiddleton/reference-guide-common-commands-for-terminal-6no

To view full documentation for Rhythm, visit Rhythm Documentation

Required Packages

The project is built using the Python 3 programming language and uses the following libraries:

• requests (https://pypi.org/project/requests/)

• os

• rhythm (No need to install, found in the project)

• termcolor (https://pypi.org/project/termcolor/)

• colorama (https://pypi.org/project/colorama/)

• pyfiglet (https://pypi.org/project/pyfiglet/0.7/)

In order to have the Rhythm application running accurately, you must have the requests library installed, the rest can be omitted. However, the other packages can surely be nice to have, as they help Rhythm perform better in terms of the user experience.

If you do not wish to view the Python documentation to install the required libraries or if you simply find the documentation a little complicated or intimidating, here is a short method to install a Python library through your command prompt or terminal.

• pip install (package-name)

• pip install requests

To view full documentation for Rhythm, visit Rhythm Documentation

How to Use Rhythm?

Once you have downloaded and installed the project files and the required Python libraries, head over to your terminal or command prompt. Since Rhythm is primarily based on the console, one can use the application through their terminal or command prompt only. However, Rhythm provides an option for the user to download external text files if needed. To run the Rhythm project, navigate to the project directory using some CLI commands and run the following command.

python main.py

If you are using a Mac, the above command may or may not work since Mac comes with a Python 2 version pre-installed on it already. To tackle this issue, please try running the following command.

python3 main.py

A full reference about running Python on the command line can be found here

Once you run the above command Rhythm does the rest, you can simply provide the basic information it seeks for. At one stage, you are given an option to either "view" the song lyrics or to download the entire song lyrics in a text file. By providing the file name for it, Rhythm will automatically download the text file for you and store in a directory named "downloads" present in the same folder as the Rhythm project directory. The lyrics to your song can be found there.

To view full documentation for Rhythm, visit Rhythm Documentation

References and Credits

• Simple API to retrieve the lyrics of a song: lyrics.ovh

• To fetch data using a public API, the project utilizes the Python requests library. Requests is a simple, yet elegant HTTP library: requests

• To learn more about all the CLI commands, please visit here

• To learn more about running Python 3 on your terminal, please visit here

To view full documentation for Rhythm, visit Rhythm Documentation

About the Developer

Sunil Shastry is a 19-year old software developer. Sunil is currently an undergraduate student at the University of Saskatchewan, Canada; majoring in Computer Science. He has always been fascinated about learning something new in terms of computer science and programming. Sunil is well versed with several programming languages and technologies including HTML, CSS, JavaScript, Python, C, C++, Bootstrap, Git, Figma and Adobe XD. During his first year at university, he developed the Rhythm application as a "side-project", applying all the knowledge, experience and programming paradigms he learnt throughout his academic year. To contact Sunil about the project or for any contact purpose, please view the contact section below.

Visit Sunil's personal site here

Projects

Sunil Shastry has designed and developed several projects using modern programming languages and with best coding practices and software design implementation. Please visit Sunil's personal website or his GitHub profile to view all his projects in much detail.

See Sunil's projects on his website here

Contact

If you wish to enquire about the project or to simply get in touch with Sunil, please use the following links below to contact him.

LinkedIn

Twitter

Instagram

To view full documentation for Rhythm, visit Rhythm Documentation

Thank you for visiting my GitHub repository, have a great day!

-- Sunil Shastry