Package: github-trending-cli
![Imgur](https://i.imgur.com/dwxZr8T.gif)[![PyPI](https://img.shields.io/pypi/pyversions/github-trending-cli.svg)](https://pypi.python.org/pypi/github-trending-cli/) [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)github-trendinggithub-trendingbrings Github Trending to the terminal, allowing you toviewthe following without leaving your command line:Github TrendingRepository READMECombinegithub-trendingwith pipes, redirects, and other command line utilities.  Output to pagers, write to files, automate with cron, etc.github-trendingcomes with a handyoptional auto-completer with interactive help:![Imgur](https://i.imgur.com/fwHg07X.png)## Index### General[Syntax](#syntax)[Auto-Completer and Interactive Help](#auto-completer-and-interactive-help)[Customizable Highlighting](#customizable-highlighting)[Commands](#commands)### Features[View Trending](#view-trending)[View Repository README](#view-repository-readme)[Combine With Pipes and Redirects](#combine-with-pipes-and-redirects)[View Results in a Browser](#view-in-a-browser)### Installation[Installation](#installation)[Pip Installation](#pip-installation)[Virtual Environment Installation](#virtual-environment-installation)[Supported Python Versions](#supported-python-versions)[Supported Platforms](#supported-platforms)[Developer Installation](#developer-installation)### Misc[Contributing](#contributing)[Credits](#credits)[Contact Info](#contact-info)[License](#license)## SyntaxUsage:$ gt <command> [params] [options]## Auto-Completer and Interactive HelpOptionally, you can enable fish-style completions and an auto-completion menu with interactive help:$ github-trendingWithin the auto-completer, the same syntax applies:github> gt <command> [params] [options]![Imgur](https://i.imgur.com/fwHg07X.png)## Customizable HighlightingYou can control the ansi colors used for highlighting by updating your~/.githubtrendingconfigfile.Color options include:` 'black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white' `For no color, set the value(s) toNone.## Commands![Imgur](https://i.imgur.com/eer1XsJ.png)## View TrendingView the Github Trending.Usage:$ gt trend [option] [limit]Examples:$ gt trend
$ gt trend –language python
$ gt trend –dev
$ gt trend –monthly
$ gt trend –limit 10![Imgur](https://i.imgur.com/5Bxmdld.png)## View Repository READMEView the Repository READMEUsage:$ gt view [user/repository]![Imgur](https://i.imgur.com/Liq7Wvq.png)
![Imgur](https://i.imgur.com/VYLklBq.png)## Combine With Pipes and RedirectsOutput to pagers, write to files, automate with cron, etc.Examples:$ gt trend -la Python -d | less
$ gt view blue-9/github-trending > README.md![Imgur](https://i.imgur.com/tKjJwEU.png)## View in a BrowserView the linked web content in your default browser instead of your terminal.Usage:$ gt <command> [params] [options] -b
$ gt <command> [params] [options] –browser## Installation### Pip Intallation[![PyPI version](https://badge.fury.io/py/github-trending-cli.svg)](http://badge.fury.io/py/github-trending-cli) [![PyPI](https://img.shields.io/pypi/pyversions/github-trending-cli.svg)](https://pypi.python.org/pypi/github-trending-cli/)github-trendingis hosted on [PyPI](https://pypi.python.org/pypi/github-trending-cli).  The following command will installgithub-trending:$ pip install github-trending-cliYou can also install the latestgithub-trendingfrom GitHub source which can contain changes not yet pushed to PyPI:$ pip install git+https://github.com/blue-9/github-trending.gitIf you are not installing in a virtualenv, run withsudo:$ sudo pip install github-trending-cliOnce installed, run the optionalgithub-trendingauto-completer with interactive help:$ github-trendingRun commands:$ gt <command> [param] [optional]### Mac OS X 10.11 El Capitan UsersThere is a known issue with Apple and its included python package dependencies (more info athttps://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 VersionsPython 2.6Python 2.7Python 3.3Python 3.4Python 3.5### Supported PlatformsMac OS XTested on OS X 10.12## Developer InstallationIf you’re interested in contributing togithub-trending-cli, run the following commands:$ git clonehttps://github.com/blue-9/github-trending.git$ pip install -e .
$ github-trending
$ gt <command> [params] [options]## ContributingContributions are welcome!Review the [Contributing Guidelines](https://github.com/blue-9/github-trending/blob/master/CONTRIBUTING.md) for details on how to:Submit issuesSubmit pull requests## Credits[haxor-news](https://github.com/donnemartin/haxor-news) by [donnemartin](https://github.com/donnemartin)[mdv](https://github.com/axiros/terminal_markdown_viewer) by [axiros](https://github.com/axiros)[github-ternding](https://github.com/evyatarmeged/github-trending) by [evyatarmeged](https://github.com/evyatarmeged)[click](https://github.com/pallets/click) by [mitsuhiko](https://github.com/mitsuhiko)[python-prompt-toolkit](https://github.com/jonathanslenders/python-prompt-toolkit) by [jonathanslenders](https://github.com/jonathanslenders)[requests](https://github.com/kennethreitz/requests) by [kennethreitz](https://github.com/kennethreitz)## Contact InfoFeel free to contact me to discuss any issues, questions, or comments.My contact info can be found on my [GitHub page](https://github.com/blue-9).## License[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)Copyright 2018 Yuya ChibaLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.