Merge pull request #29 from pranavbaburaj/master

Refactor and beatified the CLI #29

Author: GouravSardana

main.py

@@ -1,12 +1,17 @@
 #!/usr/bin/env python
+
 import argparse
 from src.arguments.search import Search
-search_obj = Search()
+
 PARSER = argparse.ArgumentParser()
-PARSER.add_argument("-s", "--search", help="enable debug mode",
+PARSER.add_argument("-s",
+                    "--search",
+                    help="enable debug mode",
                     action="store_true")
 
 ARGV = PARSER.parse_args()
 
+search_flag = Search(ARGV)
+
 if __name__ == "__main__":
-    search_obj.search_args()
+    search_flag.search_args()

requirements.txt

@@ -4,3 +4,4 @@ idna==2.10
 requests==2.24.0
 termcolor==1.1.0
 urllib3==1.25.10
+rich==9.9.0

setup.py

@@ -1,10 +1,24 @@
-from setuptools import setup
-setup(
-    name='dynamic',
-    version='0.0.1',
-    entry_points={
-        'console_scripts': [
-            'dynamic=main:search_obj.search_args'
-        ]
-    }
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+DEPENDENCIES = []
+
+setuptools.setup(
+    name="dynamic",
+    version="0.0.1",
+    description="Search for your questions in stackoverflow",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/IndianOpenSourceFoundation/dynamic-cli",
+    packages=setuptools.find_packages(),
+    install_requires=DEPENDENCIES,
+    entry_points={"console_scripts": ['dynamic=main:search_obj.search_args']},
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.6',
 )

src/arguments/search.py

@@ -1,28 +1,45 @@
 #!/usr/bin/env python
 import argparse
 from termcolor import colored
-from .utility import Utility
+from .utility import Utility, SearchError
+import sys as sys
 
-PARSER = argparse.ArgumentParser()
-PARSER.add_argument(
-    "-s", "--search", help="enable debug mode", action="store_true")
+class Prompt():
+    def __init__(self, message):
+        self.message = message
 
-ARGV = PARSER.parse_args()
-utility_obj = Utility()
+    def prompt(self):
+        print(colored(f"{self.message} [?] ", 'cyan'), end='')
+        data = input()
 
-
-class Search:
+        return str(data)
+class Search():
+    def __init__(self, arguments):
+        self.arguments = arguments
+        self.utility_object = Utility()
 
     def search_args(self):
-        if ARGV.search:
-            print("What do you want to search - ", end=" ")
-            question = input()
-            print("Tags : ", end=" ")
-            tags = input()
-            json_output = utility_obj.make_request(question, tags)
-            questions = utility_obj.get_que(json_output)
+        if self.arguments.search:
+            queries = ["What do you want to search", "Tags"]
+            query_solutions = []
+
+            # ask quesiton
+            for each_query in queries:
+                # Be careful if there are 
+                # KeyBpard Interupts or EOErrors
+                try:
+                    prompt = Prompt(str(each_query)).prompt()
+                except:
+                    sys.exit()
+
+                query_solutions.append(prompt)
+
+            question, tags = query_solutions[0], query_solutions[1]
+            json_output = self.utility_object.make_request(question, tags)
+            questions = self.utility_object.get_que(json_output)
             if questions == []:
-                print(colored('No answer found,', 'red'),
-                      colored('Please try reddit', 'green'))
+                # evoke an error
+                search_error = SearchError("No answer found",
+                                           "Please try reddit")
             else:
-                utility_obj.get_ans(questions)
+                self.utility_object.get_ans(questions)

src/arguments/utility.py

@@ -1,8 +1,67 @@
 import requests
 from termcolor import colored
+from rich.console import Console
+from rich.markdown import Markdown
+import sys as sys
 
+# the rich console
+console = Console()
 
-class Utility:
+# render markdown text in the terminal
+# def print_markdown(markdown):
+#     md = Markdown(markdown)
+#     console.print(md)
+
+
+class MarkdownRenderer(object):
+    def __init__(self, markdown_text, console_print=True):
+        assert isinstance(markdown_text, str), "Expected a string"
+
+        self.markdown_text = markdown_text
+        self.do_console_print = bool(console_print)
+
+        self.console = Console()  # rich console
+
+        self.render = self.print_mark_down_text()
+
+    def print_mark_down_text(self):
+        rendered_markdown = Markdown(self.markdown_text)
+
+        if self.do_console_print:
+            self.console.print(rendered_markdown)
+
+        return rendered_markdown
+
+    def __repr__(self):
+        return str(self.render)
+
+
+class SearchError():
+    def __init__(self, error_statement, suggestion="Try again"):
+        # the error statement
+        self.error_statement = error_statement
+
+        # the suggestion statement
+        self.suggestion = suggestion
+
+        self.evoke_search_error(self.error_statement)
+
+    def evoke_search_error(self, error_statement):
+        print_text = [
+            colored(error_statement, 'red'),
+            colored(self.suggestion, 'green')
+        ]
+        for text_to_print in print_text:
+            print(text_to_print)
+
+
+class Utility():
+    def __init__(self):
+        # the parent url
+        self.search_content_url = "https://api.stackexchange.com/"
+
+    def __get_search_url(self, question, tags):
+        return f"{self.search_content_url}/2.2/search/advanced?order=desc&sort=relevance&tagged={tags}&title={question}&site=stackoverflow"
 
     def make_request(self, que, tag: str):
         """
@@ -16,8 +75,11 @@ def make_request(self, que, tag: str):
         :rtype: Json format data
         """
         print("Searching for the answer")
-        resp = requests.get("https://api.stackexchange.com/" +
-                            "/2.2/search/advanced?order=desc&sort=relevance&tagged={}&title={}&site=stackoverflow".format(tag, que))
+        try:
+            resp = requests.get(self.__get_search_url(que, tag))
+        except:
+            SearchError("Search Failed", "Try connecting to the internet")
+            sys.exit()
         return resp.json()
 
     def get_que(self, json_data):
@@ -30,14 +92,40 @@ def get_que(self, json_data):
     def get_ans(self, questions_list):
         # ans = []
         for questions in range(1):
-            resp = requests.get("https://api.stackexchange.com/" +
-                                "/2.2/questions/{}/answers?order=desc&sort=activity&site=stackoverflow&filter=!--1nZwsgqvRX".format(questions_list[questions]))
+            try:
+                resp = requests.get(
+                    f"{self.search_content_url}/2.2/questions/{questions_list[questions]}/answers?order=desc&sort=activity&site=stackoverflow&filter=!--1nZwsgqvRX"
+                )
+            except:
+                SearchError("Search Failed", "Try connecting to the internet")
+                sys.exit()
             json_ans_data = resp.json()
-            print(
-                colored("--------------------------------------------------------", 'red'))
-            for data in json_ans_data['items']:
-                print(data["body_markdown"])
-                print("Link to answer : ", end=" ")
-                print(data["link"])
-                print(
-                    colored("--------------------------------------------------------", 'red'))
+
+            for data in json_ans_data["items"]:
+                output_content = [
+                    colored(
+                        "--------------------------------------------------------",
+                        'red'), data["body_markdown"],
+                    f"Link to the answer:{data['link']}"
+                ]
+
+                for output_index, output_text in enumerate(output_content):
+                    """
+                    Loop through the output_text and print the element
+                    if it the last one, the text[0] is printed
+                    along with text[-1]
+
+                    if text is markdown , render the markdown
+                    """
+                    if output_index == len(output_content) - 1:
+                        console.print(output_text)
+
+                        console.print(output_content[0])
+                        break
+
+                    if output_index == len(output_content) - 2:
+                        renderer = MarkdownRenderer(output_text)
+
+                        continue
+
+                    console.print(output_text)