https://github.com/genza999/readme_cli
Readme_cli is a command-line tool that instantly fetches and displays Readme files of GitHub repositories in the command line interface
https://github.com/genza999/readme_cli
cli python readme readme-cli terminal
Last synced: about 1 year ago
JSON representation
Readme_cli is a command-line tool that instantly fetches and displays Readme files of GitHub repositories in the command line interface
- Host: GitHub
- URL: https://github.com/genza999/readme_cli
- Owner: Genza999
- License: mit
- Created: 2020-10-17T23:26:05.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-21T13:48:52.000Z (over 5 years ago)
- Last Synced: 2025-04-15T21:51:48.590Z (about 1 year ago)
- Topics: cli, python, readme, readme-cli, terminal
- Language: Python
- Homepage:
- Size: 334 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Readme_cli
Readme_cli is a command-line tool that instantly fetches and diplays Readme files of github repositories in the command
line interface
## Installation
>Requires Python 3.0> and Pip installed.
`$ pip install read-me-cli==0.2.1`
## Usage
Run readme_cli with the url to the github repository:
`$ readme_cli [github repository url]`
This will fetch the readme.md contents of that repository and display them in the CLI.
## Example
In the terminal, you type the command:
`$ readme_cli https://github.com/vinta/awesome-python`
The results:
Note: Scrolling up and down is done by the Up and Down Keyboard buttons.
## Contributing
To make a contribution, fork the repo, make your changes and then submit a pull request. Please try to adhere to the existing style. If you've discovered a bug or have a feature request, create an [issue](https://github.com/Genza999/readme_cli/issues/new)!
## Technologies
Readme_cli is written in Python and built on Urwid. Beautiful Soup is used to scrape Github content.
## Acknowledgements
Special thanks to [awesome-cli-apps](https://github.com/agarrharr/awesome-cli-apps), [awesome-shell](https://github.com/alebcay/awesome-shell), [terminals-are-sexy](https://github.com/k4m4/terminals-are-sexy), and [awesome-mac](https://github.com/jaywcjlove/awesome-mac) for the inspiration!