diff --git a/README.md b/README.md index 4ed461a..81702d5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 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. diff --git a/README.rst b/README.rst index 7665a5d..59c41d2 100644 --- a/README.rst +++ b/README.rst @@ -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. - +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: ) + -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: ) - -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/ diff --git a/gitfeed/__init__.py b/gitfeed/__init__.py index e69de29..c11f861 100644 --- a/gitfeed/__init__.py +++ b/gitfeed/__init__.py @@ -0,0 +1 @@ +__version__ = "0.1.9" diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 7febd5a..0000000 --- a/setup.cfg +++ /dev/null @@ -1,7 +0,0 @@ -[metadata] -description-file = README.md - -[egg_info] -tag_build = -tag_date = 0 -tag_svn_revision = 0 diff --git a/setup.py b/setup.py index e7616c4..fc12d39 100644 --- a/setup.py +++ b/setup.py @@ -3,9 +3,13 @@ from setuptools import setup, find_packages import gitfeed +with open("README.rst", "r") as f: + long_description = f.read() + setup(name='GitFeed', - version='0.1.8', + version=gitfeed.__version__, description='Check your GitHub Newsfeed via the command-line.', + long_description=long_description, author='Ritiek Malhotra', author_email='ritiekmalhotra123@gmail.com', packages = find_packages(), @@ -14,10 +18,10 @@ 'gitfeed = gitfeed.gitfeed:cli', ] }, - url='https://www.github.com/Ritiek/GitFeed', + url='https://www.github.com/ritiek/GitFeed', keywords=['GitHub', 'news', 'feed', 'command-line', 'python'], license='MIT', - download_url='https://github.com/Ritiek/GitFeed/archive/v0.1.8.tar.gz', + download_url='https://github.com/Ritiek/GitFeed/archive/v' + gitfeed.__version__ + '.tar.gz', classifiers=[], install_requires=[ 'requests >= 2.17.3',