{"id":17526952,"url":"https://github.com/Genza999/readme_cli","last_synced_at":"2025-03-06T06:31:11.223Z","repository":{"id":57460392,"uuid":"304986941","full_name":"Genza999/readme_cli","owner":"Genza999","description":"Readme_cli is a command-line tool that instantly fetches and displays Readme files of GitHub repositories in the command line interface","archived":false,"fork":false,"pushed_at":"2020-10-21T13:48:52.000Z","size":342,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-09T01:07:31.767Z","etag":null,"topics":["cli","python","readme","readme-cli","terminal"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Genza999.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-17T23:26:05.000Z","updated_at":"2024-08-08T17:06:22.000Z","dependencies_parsed_at":"2022-09-01T20:22:12.893Z","dependency_job_id":null,"html_url":"https://github.com/Genza999/readme_cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Genza999%2Freadme_cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Genza999%2Freadme_cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Genza999%2Freadme_cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Genza999%2Freadme_cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Genza999","download_url":"https://codeload.github.com/Genza999/readme_cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242161559,"owners_count":20081895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","python","readme","readme-cli","terminal"],"created_at":"2024-10-20T15:02:39.295Z","updated_at":"2025-03-06T06:31:11.215Z","avatar_url":"https://github.com/Genza999.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Readme_cli\n\nReadme_cli is a command-line tool that instantly fetches and diplays Readme files of github repositories in the command \nline interface\n\n## Installation\n\n\u003eRequires Python 3.0\u003e and Pip installed.\n\n`$ pip install read-me-cli==0.2.1`\n\n## Usage\n\nRun readme_cli with the url to the github repository:\n\n`$ readme_cli [github repository url]`\n\nThis will fetch the readme.md contents of that repository and display them in the CLI.\n\n## Example\n\nIn the terminal, you type the command:\n\n`$ readme_cli https://github.com/vinta/awesome-python`\n\nThe results:\n\n![Placeholder Demo](docs/sss.png)\n\nNote: Scrolling up and down is done by the Up and Down Keyboard buttons.\n\n\n## Contributing\n\nTo 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)!\n\n## Technologies\n\nReadme_cli is written in Python and built on Urwid. Beautiful Soup is used to scrape Github content.\n\n## Acknowledgements\n\nSpecial 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!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGenza999%2Freadme_cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGenza999%2Freadme_cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGenza999%2Freadme_cli/lists"}