Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Github inside the Command Line

Project description

cli-github

A Python App to display Github from the command-line!

Version Downloads
Version Downloads

Version 1.0.9

  • Option to show the contents of a file/folder
  • Conformed to pep8 guidelines
  • URL input parsing made better
  • List the user followers

Live Demo

DEMO : Display the list of a user’s repositories from the username/URL, along with the number of stargazers

DEMO : Display all the folders and files within a repository recursively from the repository URL, along with their sizes

DEMO : To get the RAW version of the readme file of a repository from the repository URL

DEMO : To get the list of releases from the user’s repository URL

DEMO : Download the tarball from the user’s repository URL

DEMO : Download the zipball from the user’s repository URL

DEMO : To show the contents of a file/folder

DEMO : List the followers of the user

Installation

Using pip

$ pip install cli-github

Latest build from the Source

  • Clone the repo

    $ git clone https://github.com/harshasrinivas/cli-github.git
    
  • Run

    $ python setup.py install
    

Dependencies

  • prettytable

    $ pip install prettytable
    
  • future

    $ pip install future
    
  • python-dateutil

    $ pip install python-dateutil
    

Setting Up

Github Token as Permanent Environment Variable

Set your Github Personal Access Token as the environment variable GITHUB_TOKEN

$ echo "export GITHUB_TOKEN=<your-token-with-quotes>" | sudo tee -a /etc/environment

Github Token as Temporary Environment Variable

$ GITHUB_TOKEN=<your-token-with-quotes>

Without saving your Environment Variable

$ cat cli_github/mains.py | sed -e "s/API_TOKEN = os.environ.get('GITHUB_TOKEN')/API_TOKEN = <your-token-with-quotes>/" > cli_github/mains.py

Options

-h, --help            show this help message and exit
-n URL, --url URL
                    Get repos from the user profile URL/username
-r RECURSIVE, --recursive RECURSIVE
                    Get the file structure from the repo link URL
-R README, --readme README
                    Get the raw version of the repository readme file from repo link URL
-re RELEASES, --releases RELEASES
                    Get the list of releases from repo link
-dt TARBALL, --tarball TARBALL
                    Download the tarball from repo link
-dz ZIPBALL, --zipball ZIPBALL
                    Download the zipball from repo link
-op OPENFILE, --openfile OPENFILE
                    Show the contents of the given file in a repo
-f FOLLOWERS, --followers FOLLOWERS
                    Get followers of the user

Usage

Display the list of a user’s repositories from the username/URL

$ cli-github -n harshasrinivas

Display all the files and folders within a repository recursively from the repository URL

$ cli-github -r harshasrinivas/cli-github

Get the RAW version of the readme file of a repository from the repository URL

$ cli-github -R harshasrinivas/cli-github

Get the list of releases from the user’s repository URL

$ cli-github -re harshasrinivas/cli-github

Download the tarball of the any repo

$ cli-github -dt harshasrinivas/cli-github

Download the zipball of the any repo

$ cli-github -dz harshasrinivas/cli-github

Show the contents of a file/folder

$ cli-github -op harshasrinivas/cli-github/setup.py

List the followers of a user

$ cli-github -f harshasrinivas

Contribute

If you want to add features, improve them, or report issues, feel free to send a pull request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cli-github, version 1.0.9
Filename, size File type Python version Upload date Hashes
Filename, size cli-github-1.0.9.zip (57.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page