Python Library that displays readme-file content in CLI

Hey guys, so as part of my journey to Mastering Python I decided to create a Python library. The library called readme_cli is used to extract and display readme file content from desired Github repositories in the Command Line Interface.

Usage of the library

To use the library, all you need is to have Pip installed and Python 3.0>.

Open the terminal and type the following command:

pip install read-me-cli==0.2.1

Once installed successfully, you can now be able to read most of the content about a repository from the Github readme file in the CLI by typing the following command in the terminal:

readme_cli <github repository url>

eg.

readme_cli https://github.com/vinta/awesome-python

Which will display the following in the terminal:

And you are done! You can scroll through the readme file of this repository by using the up and down keys on the keyboard.

Restrictions

• At the moment the links in the readme files cant be clicked to redirect a user from the terminal.
• Images aren't displayed.

The link to this project is https://github.com/Genza999/readme_cli. I’d really appreciate any contributions or advice on how to further improve this or work on the above restrictions, Thanks!