https://github.com/ritiek/gitfeed

Check your GitHub Newsfeed via the command-line
https://github.com/ritiek/gitfeed

command-line feed github news python

Last synced: 10 months ago
JSON representation

Check your GitHub Newsfeed via the command-line

• Host: GitHub
• URL: https://github.com/ritiek/gitfeed
• Owner: ritiek
• License: mit
• Created: 2017-04-25T15:49:13.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-16T21:58:03.000Z (over 8 years ago)
• Last Synced: 2025-03-18T21:50:55.602Z (10 months ago)
• Topics: command-line, feed, github, news, python
• Language: Python
• Homepage:
• Size: 26.4 KB
• Stars: 17
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GitFeed

[![pypi.python.org](https://img.shields.io/pypi/v/GitFeed.svg)](https://pypi.org/project/GitFeed/) [![build Status](https://travis-ci.org/ritiek/GitFeed.svg?branch=master)](https://travis-ci.org/ritiek/GitFeed/)

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

  -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`