Merge pull request #64 from guptaaastha/emojis

Add emojis in Dynamic CLI  [closed #64 ]

Author: GouravSardana

README.md

@@ -1,26 +1,28 @@
 ![dynamic-cli](https://socialify.git.ci/IndianOpenSourceFoundation/dynamic-cli/image?description=1&descriptionEditable=A%20Modern%2C%20user-friendly%20command-line%20%20for%20the%20API%20testing%2C%20and%20if%20you%27re%20stuck%20-%20Search%20and%20browse%20StackOverflow%20without%20leaving%20the%20CLI&font=Inter&forks=1&issues=1&language=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Light)
 
-
-
 ## Setup
 
 **1.** Installing pip [Python Package Manager]
-  ```shell
+
+```shell
 $ sudo apt-get install python3-pip
 ```
 
 **2.** Clone this repository to your local drive
- ```shell
+
+```shell
 $ git clone https://github.com/IndianOpenSourceFoundation/dynamic-cli.git
 ```
 
-**3.** Install dependencies  
- ```shell
+**3.** Install dependencies
+
+```shell
 $ pip3 install -r requirements.txt
 ```
 
 **4.** Install with pip
- ```shell
+
+```shell
 $ pip3 install -e .
 ```
 
@@ -31,26 +33,26 @@ Dynamic CLI allows users to search for keywords/issues with some relevant tags.
 ![ezgif com-gif-maker (1)](https://user-images.githubusercontent.com/49693160/111326116-4bcceb00-8692-11eb-9d3a-51350a006d34.gif)
 
 ## Arguments
+
 Usage: Dynamic [OPTIONS] <br>
 
 A Modern, user-friendly command-line HTTP client for the API testing, and if you're stuck - Search and browse StackOverflow without leaving the CLI. <br>
 
 Options: <br>
 
+`-st, --start -> Introduces Dynamic CLI` <br>
 `-v, --version -> Gives the Version of the CLI` <br>
 `-s, --search -> Search a question on Stackoverflow` <br>
 `-d, --debug -> Turn on Debugging mode` <br>
 `-h, --help -> Shows this message and exit` <br>
 
-
 ## License
 
-
 ### Contributing
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat&logo=git&logoColor=white)](https://github.com/IndianOpenSourceFoundation/dynamic-cli/pulls) [![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/IndianOpenSourceFoundation/dynamic-cli)
 
-**We're accepting PRs for our open and unassigned [issues](https://github.com/IndianOpenSourceFoundation/dynamic-cli/issues)**. Please check [CONTRIBUTING.md](CONTRIBUTING.md). We'd love your contributions! **Kindly follow the steps below to get started:** 
+**We're accepting PRs for our open and unassigned [issues](https://github.com/IndianOpenSourceFoundation/dynamic-cli/issues)**. Please check [CONTRIBUTING.md](CONTRIBUTING.md). We'd love your contributions! **Kindly follow the steps below to get started:**
 
 **1.** Fork [this](https://github.com/IndianOpenSourceFoundation/dynamic-cli) repository.
 
@@ -67,6 +69,14 @@ cd dynamic-cli
 ```
 
 **4.** Make changes in source code.
+<br />
+P.S. If you want to add emojis 😁, use `unicodes`.
+Emoji `unicodes` can be found at [https://unicode.org/emoji/charts/full-emoji-list.html](https://unicode.org/emoji/charts/full-emoji-list.html)
+<br />
+To include an emoji in a string, copy the unicode (Eg: `U+1F600`), replace `+` with `000` and
+prefix it with a `\`.
+<br />
+Eg: `\U0001F604`
 
 **5.** Stage your changes and commit
 
@@ -89,6 +99,7 @@ git push
 **9.** **Congratulations!** Sit and relax, you've made your contribution to Dynamic-CLI project.
 
 ## Contributors:
+
 ### Credit goes to these people:✨
 
 <table>

main.py

@@ -6,9 +6,14 @@
 version = "0.1"
 
 parser = argparse.ArgumentParser()
+parser.add_argument("-st",
+                    "--start",
+                    help="introduce you to dynamic",
+                    action="store_true")
+
 parser.add_argument("-s",
                     "--search",
-                    help="enable debug mode",
+                    help="search a question on StackOverflow",
                     action="store_true")
 
 parser.add_argument("-V",
@@ -19,7 +24,7 @@
 parser.add_argument(
     "-n",
     "--new",
-    help="Opens browser to create new Stack Overflow question.",
+    help="Opens browser to create new StackOverflow question.",
     const=True,
     metavar="title (optional)",
     nargs="?")
@@ -34,4 +39,16 @@
 search_flag = Search(ARGV)
 
 if __name__ == "__main__":
-    search_flag.search_args()
+    if ARGV.start:
+        print('''
+        \U0001F604 Hello and Welcome to Dynamic CLI 
+        \U0001F917 Use the following commands to get started 
+        \U0001F50E Search on StackOverflow with '-s' 
+        \U0001F4C4 Open browser to create new Stack Overflow question with '-n [title(optional)]' 
+        \U0001F4C2 Save answer to a file with '-file'
+        \U00002728 Know the version of Dynamic CLI with '-V' 
+        \U0001F609 See this message again with '-st'
+        \U00002755 Get help with '-h'
+        ''')
+    else:
+        search_flag.search_args()

src/arguments/search.py

@@ -17,7 +17,7 @@ def prompt(self):
         print(colored(f"{self.message} : ", 'cyan'), end='')
         data = input()
         if data == "":
-            SearchError("Input data empty", "Please try again ")
+            SearchError("\U0001F613 Input data empty", "\U0001F504 Please try again ")
             sys.exit()
         else:
             return str(data)
@@ -47,7 +47,7 @@ def search_for_results(self, save=False):
         # ask quesiton
         for each_query in queries:
             # Be careful if there are
-            # KeyBpard Interupts or EOErrors
+            # KeyBoard Interrupts or EOErrors
             try:
                 prompt = Prompt(str(each_query)).prompt()
             except:
@@ -60,12 +60,21 @@ def search_for_results(self, save=False):
         questions = self.utility_object.get_que(json_output)
         if questions == []:
             # evoke an error
-            search_error = SearchError("No answer found", "Please try reddit")
+            search_error = SearchError("\U0001F613 No answer found", "\U0001F604 Please try reddit")
         else:
             data = self.utility_object.get_ans(questions)
+            print('''
+            \U0001F604 Hopefully you found what you were looking for! 
+            \U0001F4C2 You can save an answer to a file with '-file'
+
+            Not found what you were looking for \U00002754
+            \U0001F4C4 Open browser and post your question on StackOverflow with '-n [title (optional)]'
+            
+            \U0001F50E To search more use '-s'
+            ''')
 
             if save:
                 filename = SaveSearchResults(data)
                 print(
-                    colored(f"Answers successfully saved into {filename}",
+                    colored(f"\U0001F604 Answers successfully saved into {filename}",
                             "green"))

src/arguments/utility.py

@@ -29,11 +29,11 @@ def make_request(self, que, tag: str):
         :return: Json response from the api call.
         :rtype: Json format data
         """
-        print("Searching for the answer")
+        print("\U0001F50E Searching for the answer")
         try:
             resp = requests.get(self.__get_search_url(que, tag))
         except:
-            SearchError("Search Failed", "Try connecting to the internet")
+            SearchError("\U0001F613 Search Failed", "\U0001F4BB Try connecting to the internet")
             sys.exit()
         return resp.json()
 
@@ -52,7 +52,7 @@ def get_ans(self, questions_list):
                     f"{self.search_content_url}/2.2/questions/{questions_list[questions]}/answers?order=desc&sort=votes&site=stackoverflow&filter=!--1nZwsgqvRX"
                 )
             except:
-                SearchError("Search Failed", "Try connecting to the internet")
+                SearchError("\U0001F613 Search Failed", "\U0001F4BB Try connecting to the internet")
                 sys.exit()
             json_ans_data = resp.json()
 
@@ -61,7 +61,7 @@ def get_ans(self, questions_list):
                     colored(
                         "--------------------------------------------------------",
                         'red'), data["body_markdown"],
-                    f"Link to the answer:{data['link']}"
+                    f"\U0001F517 Link to the answer:{data['link']}"
                 ]
 
                 for output_index, output_text in enumerate(output_content):