From b7f9205c8d241cf6c095bfe00fbbaa870970b908 Mon Sep 17 00:00:00 2001 From: Dave G Date: Tue, 19 Jun 2018 10:18:33 -0400 Subject: [PATCH] display pypi badge in readme. --- README.md | 48 ++++++++++++++++++++++++++++++++++ README.rst | 64 ---------------------------------------------- rfd/__version__.py | 2 +- setup.py | 5 ++-- 4 files changed, 52 insertions(+), 67 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..7ac468d --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# RFD CLI + +Hot Deals on the command line. + +[![Build Status](https://travis-ci.org/davegallant/rfd_cli.svg?branch=master)](https://travis-ci.org/davegallant/rfd_cli) + +[![PyPI version](https://badge.fury.io/py/rfd.svg)](https://badge.fury.io/py/rfd) + +## Installation + +```bash +pip install rfd +``` + +## Usage + +```bash +rfd threads [--count 10] +``` + +### Display first 5 threads from hot deals + +![screenshot](https://user-images.githubusercontent.com/4519234/37319853-3a03fb9c-2647-11e8-806e-17156541cf43.png) + +### tail a post: + +```bash +▶ rfd posts https://forums.redflagdeals.com/koodo-targeted-public-mobile-12-120-koodo-6gb-40-no-referrals-2176935/ --tail 4 + +-------------------------------------------------------------------------- + - [0] For those worried about credit ratings, according to Boworell, my credit score rose by 44 points since last month. I did absolutely nothing except open 3 Koodo lines all with medium tabs and I paid off 1 in full the very next day (Shaner) + +-------------------------------------------------------------------------- + - [0] If we want to keep our PM plan but use the code to set up a spouse on the plan is that still okay? +I've read that the port can only be used once now, but does it matter which phone number is ported in? (kid_icarus) + +-------------------------------------------------------------------------- + - [0] blackboxvr6 wrote: ↑Mar 12th, 2018 2:13 pm +Legit 1st line on Wednesday, no shipping email yet... + + +Tuesday before noon and still waiting. (gardener28) + +-------------------------------------------------------------------------- + - [0] Ordered a SIM last Wednesday, haven't heard a peep from Koodo since the initial order confirmation e-mail. (DaJinx) + +-------------------------------------------------------------------------- +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index fb344fb..0000000 --- a/README.rst +++ /dev/null @@ -1,64 +0,0 @@ -RFD CLI -=================== - - -Get Hot Deals on the command line. - - -.. image:: https://travis-ci.org/davegallant/rfd_cli.svg?branch=master - :target: https://travis-ci.org/davegallant/rfd_cli - -.. image:: https://requires.io/github/davegallant/rfd_cli/requirements.svg?branch=master - :target: https://requires.io/github/davegallant/rfd_cli/requirements/?branch=master - :alt: Requirements Status - - -Installation: -============= - -.. code-block:: - - pip install rfd - -Usage -===== - -.. code-block:: - - - rfd threads 9 [--count 5] - - -.. image:: https://user-images.githubusercontent.com/4519234/37319853-3a03fb9c-2647-11e8-806e-17156541cf43.png - - -Examples: -========= - - -tail a post: ---------------- - -.. code-block:: - - - ▶ rfd posts https://forums.redflagdeals.com/koodo-targeted-public-mobile-12-120-koodo-6gb-40-no-referrals-2176935/ --tail 4 - - -------------------------------------------------------------------------- - - [0] For those worried about credit ratings, according to Boworell, my credit score rose by 44 points since last month. I did absolutely nothing except open 3 Koodo lines all with medium tabs and I paid off 1 in full the very next day (Shaner) - - -------------------------------------------------------------------------- - - [0] If we want to keep our PM plan but use the code to set up a spouse on the plan is that still okay? - I've read that the port can only be used once now, but does it matter which phone number is ported in? (kid_icarus) - - -------------------------------------------------------------------------- - - [0] blackboxvr6 wrote: ↑Mar 12th, 2018 2:13 pm - Legit 1st line on Wednesday, no shipping email yet... - - - Tuesday before noon and still waiting. (gardener28) - - -------------------------------------------------------------------------- - - [0] Ordered a SIM last Wednesday, haven't heard a peep from Koodo since the initial order confirmation e-mail. (DaJinx) - - -------------------------------------------------------------------------- diff --git a/rfd/__version__.py b/rfd/__version__.py index 0adcb5c..360392a 100644 --- a/rfd/__version__.py +++ b/rfd/__version__.py @@ -1,4 +1,4 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals -__version__ = '0.1.2' +__version__ = '0.1.3' diff --git a/setup.py b/setup.py index d72706e..ecd196d 100644 --- a/setup.py +++ b/setup.py @@ -9,8 +9,8 @@ from version import __version__ as version WORKING_DIR = path.abspath(path.dirname(__file__)) -# Get long description from reStructuredTExt -with io.open(path.join(WORKING_DIR, 'README.rst'), encoding='utf-8') as f: +# Get long description from README.md +with io.open(path.join(WORKING_DIR, 'README.md'), encoding='utf-8') as f: long_description = f.read() # read requirements.txt and load into list @@ -31,6 +31,7 @@ setup( keywords='cli redflagdeals', license='Apache License, Version 2.0', long_description=long_description, + long_description_content_type="text/markdown", name='rfd', packages=find_packages(), url='https://github.com/davegallant/rfd_cli',