Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
63 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,75 @@ | ||
# GitFeed | ||
GitFeed | ||
======= | ||
|
||
- Check your GitHub Newsfeed via the command-line. | ||
|pypi.python.org| |build Status| | ||
|
||
- 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. | ||
- Check your GitHub Newsfeed via the command-line. | ||
|
||
## Screenshots | ||
- 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. | ||
|
||
<img src="http://i.imgur.com/TPzBlVQ.png" width="600"> | ||
Screenshots | ||
----------- | ||
|
||
## Installation | ||
Installation | ||
------------ | ||
|
||
GitFeed can be installed from pypi. | ||
|
||
``` | ||
pip install gitfeed | ||
``` | ||
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 | ||
``` | ||
:: | ||
|
||
git clone https://github.com/Ritiek/GitFeed | ||
cd GitFeed | ||
python setup.py install | ||
|
||
Usage | ||
----- | ||
|
||
- Run it using ``gitfeed`` | ||
|
||
## Usage | ||
- The first time you launch ``gitfeed``, it will ask you for GitHub | ||
username and set it as the default username to fetch news for. | ||
|
||
- Run it using `gitfeed` | ||
- You can even fetch news for any other user provided you know their | ||
GitHub username. | ||
|
||
- The first time you launch `gitfeed`, it will ask you for GitHub username and set it as the default username to fetch news for. | ||
- Full list of supported options: | ||
|
||
- 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] | ||
|
||
``` | ||
usage: gitfeed [-h] [-u USER] [-p PAGES] [-q] [-nt] [-ns] | ||
Check your GitHub Newsfeed via the command-line. | ||
|
||
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) | ||
|
||
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`` | ||
|
||
- You can modify the default configuration by editing `~/.gitfeed/gitfeed.ini` | ||
License | ||
------- | ||
|
||
## License | ||
``The MIT 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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__version__ = "0.1.9" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters