feat: change output to echo via pager

Makefile

@@ -35,6 +35,15 @@ lint:
 test: tmp/.tests-passed.sentinel
 .PHONY: test
 
+## examples: Run basic commands
+examples: tmp/.tests-passed.sentinel
+> rfd --version
+> rfd threads >/dev/null
+> rfd threads --sort-by score >/dev/null
+> rfd search 'pizza' >/dev/null
+> rfd search '(coffee|starbucks)' >/dev/null
+.PHONY: examples
+
 # Tests - re-ran if any file under src has been changed since tmp/.tests-passed.sentinel was last touched
 tmp/.tests-passed.sentinel: $(shell find ${SRC} -type f)
 > mkdir -p $(@D)
@@ -45,7 +54,7 @@ tmp/.tests-passed.sentinel: $(shell find ${SRC} -type f)
 pr: precommit lint test
 .PHONY: pr
 
-ci: lint test
+ci: lint test examples
 .PHONY: ci
 
 ## help: Print this help message

README.md

@@ -7,10 +7,8 @@ Hot deals on the command line.
 [![Dependabot](https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot)](https://dependabot.com/)
 [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/davegallant/rfd.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/davegallant/rfd/context:python)
 
-
 ![screenshot](https://user-images.githubusercontent.com/4519234/85969861-e10a4100-b996-11ea-9a31-6203322c60ee.png)
 
-
 ## Install
 
 ```bash
@@ -37,6 +35,7 @@ Commands:
 ## Examples
 
 ### View Hot Deals
+
 ```console
 $ rfd threads
 ```
@@ -48,10 +47,11 @@ $ rfd threads --sort-by score
 ```
 
 ```console
-$ rfd threads --sort-by total_views --limit 40
+$ rfd threads --sort-by views --limit 40
 ```
 
 ### Simple Search
+
 ```console
 $ rfd search 'pizza'
 ```
@@ -61,7 +61,7 @@ $ rfd search 'pizza'
 Regular expressions can be used for search.
 
 ```console
-$ rfd search '(coffee|starbucks)' --num-pages 100
+$ rfd search '(coffee|starbucks)' --pages 10 --sort-by views
 ```
 
 ## Shell Completion

rfd/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

rfd/cli.py

@@ -42,13 +42,15 @@ def print_version(ctx, value):
     ctx.exit()
 
 
-def display_thread(click, thread, count):  # pylint: disable=redefined-outer-name
+def generate_thread_output(_threads):
+    for count, thread in enumerate(_threads, 1):
+        output = ""
         dealer = thread.dealer_name
         if dealer and dealer is not None:
             dealer = "[" + dealer + "] "
         else:
             dealer = ""
-    click.echo(
+        output += (
             " "
             + str(count)
             + "."
@@ -56,11 +58,13 @@ def display_thread(click, thread, count):  # pylint: disable=redefined-outer-nam
             + Fore.RESET
             + "%s%s" % (dealer, thread.title)
             + Fore.LIGHTYELLOW_EX
-        + " (%d views)" % thread.total_views
+            + " (%d views)" % thread.views
             + Fore.RESET
         )
-    click.echo(Fore.BLUE + " {}".format(thread.url))
-    click.echo(Style.RESET_ALL)
+        output += Fore.BLUE + " {}".format(thread.url)
+        output += Style.RESET_ALL
+        output += "\n\n"
+        yield output
 
 
 @click.group(invoke_without_command=True)
@@ -137,17 +141,17 @@ def threads(limit, forum_id, sort_by):
     _threads = sort_threads(
         parse_threads(get_threads(forum_id, limit), limit), sort_by=sort_by
     )
-    for count, thread in enumerate(_threads, 1):
-        display_thread(click, thread, count)
+    click.echo_via_pager(generate_thread_output(_threads))
 
 
 @cli.command(short_help="Search deals based on a regular expression.")
-@click.option("--num-pages", default=5, help="Number of pages to search.")
+@click.option("--pages", default=5, help="Number of pages to search.")
 @click.option(
     "--forum-id", default=9, help="The forum id number. Defaults to 9 (hot deals)."
 )
+@click.option("--sort-by", default=None, help="Sort threads by")
 @click.argument("regex")
-def search(num_pages, forum_id, regex):
+def search(pages, forum_id, sort_by, regex):
     """Search deals based on regex.
 
     Popular forum ids:
@@ -165,9 +169,12 @@ def search(num_pages, forum_id, regex):
     88 \t cell phones
     """
 
-    count = 0
-    for page in range(1, num_pages):
+    matched_threads = []
+
+    for page in range(1, pages):
         _threads = parse_threads(get_threads(forum_id, 100, page=page), limit=100)
         for thread in search_threads(threads=_threads, regex=regex):
-            count += 1
-            display_thread(click, thread, count)
+            matched_threads.append(thread)
+    click.echo_via_pager(
+        generate_thread_output(sort_threads(matched_threads, sort_by=sort_by))
+    )

rfd/threads.py

@@ -4,12 +4,12 @@ from .scores import calculate_score
 
 # pylint: disable=old-style-class
 class Thread:
-    def __init__(self, title, dealer_name, score, url, total_views):
+    def __init__(self, title, dealer_name, score, url, views):
         self.dealer_name = dealer_name
         self.score = score
         self.title = title
         self.url = url
-        self.total_views = total_views
+        self.views = views
 
     def __repr__(self):
         return "Thread(%s)" % self.title
@@ -48,7 +48,7 @@ def parse_threads(threads, limit):
                 dealer_name=get_dealer(topic),
                 score=calculate_score(topic),
                 url=build_web_path(topic.get("web_path")),
-                total_views=topic.get("total_views"),
+                views=topic.get("total_views"),
             )
         )
     return parsed_threads
@@ -58,7 +58,7 @@ def sort_threads(threads, sort_by):
     """Sort threads by an attribute"""
     if sort_by is None:
         return threads
-    assert sort_by in ["total_views", "score", "title"]
+    assert sort_by in ["views", "score", "title"]
     threads = sorted(threads, key=lambda x: getattr(x, sort_by), reverse=True)
     return threads
 

tox.ini

@@ -9,8 +9,3 @@ envlist = py{27,
 passenv = SSH_AUTH_SOCK
 commands =
     make ci
-    rfd --version
-    rfd threads
-    rfd threads --sort-by score
-    rfd search 'pizza'
-    rfd search '(coffee|starbucks)'