Metadata-Version: 2.0
Name: GitFeed
Version: 0.1.9
Summary: Check your GitHub Newsfeed via the command-line.
Home-page: https://www.github.com/ritiek/GitFeed
Author: Ritiek Malhotra
Author-email: ritiekmalhotra123@gmail.com
License: MIT
Download-URL: https://github.com/Ritiek/GitFeed/archive/v0.1.9.tar.gz
Keywords: GitHub,news,feed,command-line,python
Platform: UNKNOWN
Requires-Dist: colorama (>=0.3.7)
Requires-Dist: requests (>=2.17.3)

GitFeed
=======

|pypi.python.org| |build Status|

-  Check your GitHub Newsfeed via the command-line.

-  Newsfeed includes all the news from people you are following on
   GitHub, repositories you are watching, etc. All news you would find
   on your GitHub dashboard.

Screenshots
-----------

Installation
------------

GitFeed can be installed from pypi.

For best results (compatibility with Pager), use Python3

::

    pip install gitfeed

or if you like to live on the bleeding edge

::

    git clone https://github.com/Ritiek/GitFeed
    cd GitFeed
    python setup.py install

Usage
-----

-  Run it using ``gitfeed``

-  The first time you launch ``gitfeed``, it will ask you for GitHub
   username and set it as the default username to fetch news for.

-  You can even fetch news for any other user provided you know their
   GitHub username.

-  Full list of supported options:

::

    usage: gitfeed [-h] [-u USER] [-p PAGES] [-q] [-nt] [-ns]

    Check your GitHub Newsfeed via the command-line.

    optional arguments:
      -h, --help            show this help message and exit
      -u USER, --user USER  GitHub username for the user to fetch newsfeed for
                            (default: <user>)
      -p PAGES, --pages PAGES
                            number of newsfeed pages to fetch (default: 1)
      -q, --quiet           hide comment body in issues & PRs (default: False)
      -nt, --no-time-stamp  hide time-stamp of events (default: False)
      -ns, --no-style       show plain white text with no colors or style
                            (default: False)

-  You can modify the default configuration by editing
   ``~/.gitfeed/gitfeed.ini``

License
-------

``The MIT License``

.. |pypi.python.org| image:: https://img.shields.io/pypi/v/GitFeed.svg
   :target: https://pypi.org/project/GitFeed/
.. |build Status| image:: https://travis-ci.org/ritiek/GitFeed.svg?branch=master
   :target: https://travis-ci.org/ritiek/GitFeed/


