github-trending brings Github Trending to the terminal, allowing you to view the following without leaving your command line:
- Github Trending
- Repository README
github-trending with pipes, redirects, and other command line utilities. Output to pagers, write to files, automate with cron, etc.
github-trending comes with a handy optional auto-completer with interactive help:
- Developer Installation
$ gt <command> [params] [options]
Auto-Completer and Interactive Help
Optionally, you can enable fish-style completions and an auto-completion menu with interactive help:
Within the auto-completer, the same syntax applies:
github> gt <command> [params] [options]
You can control the ansi colors used for highlighting by updating your
Color options include:
'black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'
For no color, set the value(s) to
View the Github Trending.
$ gt trend [option] [limit]
$ gt trend $ gt trend --language python $ gt trend --dev $ gt trend --monthly $ gt trend --limit 10
View Repository README
View the Repository README
$ gt view [user/repository]
Combine With Pipes and Redirects
Output to pagers, write to files, automate with cron, etc.
$ gt trend -la Python -d | less $ gt view blue-9/github-trending > README.md
View in a Browser
View the linked web content in your default browser instead of your terminal.
$ gt <command> [params] [options] -b $ gt <command> [params] [options] --browser
github-trending is hosted on PyPI. The following command will install
$ pip install github-trending-cli
You can also install the latest
github-trending from GitHub source which can contain changes not yet pushed to PyPI:
$ pip install git+https://github.com/blue-9/github-trending.git
If you are not installing in a virtualenv, run with
$ sudo pip install github-trending-cli
Once installed, run the optional
github-trending auto-completer with interactive help:
$ gt <command> [param] [optional]
Mac OS X 10.11 El Capitan Users
There is a known issue with Apple and its included python package dependencies (more info at https://github.com/pypa/pip/issues/3165). We are investigating ways to fix this issue but in the meantime, to install github-trending, you can run:
$ sudo pip install github-trending --upgrade --ignore-installed six
Supported Python Versions
- Python 2.6
- Python 2.7
- Python 3.3
- Python 3.4
- Python 3.5
- Mac OS X
- Tested on OS X 10.12
If you're interested in contributing to
github-trending-cli, run the following commands:
$ git clone https://github.com/blue-9/github-trending.git $ pip install -e . $ github-trending $ gt <command> [params] [options]
Contributions are welcome!
Review the Contributing Guidelines for details on how to:
- Submit issues
- Submit pull requests
- haxor-news by donnemartin
- mdv by axiros
- github-ternding by evyatarmeged
- click by mitsuhiko
- python-prompt-toolkit by jonathanslenders
- requests by kennethreitz
Feel free to contact me to discuss any issues, questions, or comments.
My contact info can be found on my GitHub page.
Copyright 2018 Yuya Chiba Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.