Giter Club home page Giter Club logo

github-trending's Introduction

Imgur

PyPI License

github-trending

github-trending brings Github Trending to the terminal, allowing you to view the following without leaving your command line:

  • Github Trending
  • Repository README

Combine 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:

Imgur

Index

General

Features

Installation

Misc

Syntax

Usage:

$ gt <command> [params] [options]

Auto-Completer and Interactive Help

Optionally, you can enable fish-style completions and an auto-completion menu with interactive help:

$ github-trending

Within the auto-completer, the same syntax applies:

github> gt <command> [params] [options]

Imgur

Customizable Highlighting

You can control the ansi colors used for highlighting by updating your ~/.githubtrendingconfig file.

Color options include:

'black', 'red', 'green', 'yellow',
'blue', 'magenta', 'cyan', 'white'

For no color, set the value(s) to None.

Commands

Imgur

View Trending

View 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

View Repository README

View the Repository README

Usage:

$ gt view [user/repository]

Imgur Imgur

Combine With Pipes and Redirects

Output 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

View in a Browser

View 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 PyPI

github-trending is hosted on PyPI. The following command will install github-trending:

$ 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:

$ sudo pip install github-trending-cli

Once installed, run the optional github-trending auto-completer with interactive help:

$ github-trending

Run commands:

$ 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 pypa/pip#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

Supported Platforms

  • Mac OS X
    • Tested on OS X 10.12

Developer Installation

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]

Contributing

Contributions are welcome!

Review the Contributing Guidelines for details on how to:

  • Submit issues
  • Submit pull requests

Credits

Contact Info

Feel free to contact me to discuss any issues, questions, or comments.

My contact info can be found on my GitHub page.

License

License

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.

github-trending's People

Contributors

cyblue9 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

github-trending's Issues

Can GT be used to search for repos by keyword?

Hello cyblue9,

This is an awesome project. It is making a great addition to my CLI only lifestyle.

I find Github to be a great place to find open source shell programs. so naturally the next step for me would be to browse Github itself from the command line.

Although this somewhat goes against the project title, I am wondering if it is possible to use this app to search for repos by keyword sometimes instead of by trending?

If it is not yet possible, do you have any quick advice how a new contributor might implement this in a fork?

Thanks in advance!
-S

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.