<commit_before>GitHub API - command-line interface
===================================
about
*****
for now, `github-cli <http://github.com/jsmits/github-cli/>`_ provides a 
script called ``gh-issues``, that can be used to access all of `GitHub 
<http://www.github.com/>`_'s documented `Issues API 
<http://develop.github.com/p/issues.html>`_ (v2) functionality from your 
command-line

github-cli is written in `Python <http://www.python.org/>`_

installation
************

**easy_install**

``easy_install github-cli``

or

``sudo easy_install github-cli``

if needed, you can find installation instructions for ``easy_install`` `here
<http://pypi.python.org/pypi/setuptools/>`_

**latest from source**

``git clone git://github.com/jsmits/github-cli.git``

``cd github-cli``

``python setup.py install``

or

``sudo python setup.py install``

the ``gh-issues`` executable will be installed to a system ``bin`` directory

configuration
*************
make sure your GitHub username and API token are added to the global git 
config:

``git config --global github.user <your GitHub username>``

``git config --global github.token <your GitHub API token>``

you can find the username and API token on your GitHub's account page

usage
*****
from any directory that is part of a git working directory with an origin that
is hosted on GitHub, you can do this:<commit_msg>added `pip` as installation method removed lines containing `sudo`<commit_after>GitHub API - command-line interface
===================================
about
*****
for now, `github-cli <http://github.com/jsmits/github-cli/>`_ provides a 
script called ``gh-issues``, that can be used to access all of `GitHub 
<http://www.github.com/>`_'s documented `Issues API 
<http://develop.github.com/p/issues.html>`_ (v2) functionality from your 
command-line

github-cli is written in `Python <http://www.python.org/>`_

installation
************

**pip**

``pip install github-cli``

**easy_install**

``easy_install github-cli``

**from source**

``pip install -e git://github.com/jsmits/github-cli.git#egg=github-cli``

or

``git clone git://github.com/jsmits/github-cli.git``

``cd github-cli``

``python setup.py install``

the ``gh-issues`` executable will be installed to a system ``bin`` directory

configuration
*************
make sure your GitHub username and API token are added to the global git 
config:

``git config --global github.user <your GitHub username>``

``git config --global github.token <your GitHub API token>``

you can find the username and API token on your GitHub's account page

usage
*****
from any directory that is part of a git working directory with an origin that
is hosted on GitHub, you can do this:
{'fraction_non_alphanumeric': 0.16759362254356694, 'fraction_numerical': 0.0007415647015202076, 'mean_word_length': 4.704016913319239, 'pattern_counts': {'":': 0, '<': 16, '<?xml version=': 0, '>': 16, 'https://': 0, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3156402', 'n_tokens_mistral': 846, 'n_tokens_neox': 794, 'n_words': 301}