Refactored the whole project

List of changes

+ Handling information about a tool has been improved a lot by providing a `HackingTool` class, which takes care of showing the options, running the selected option, executing the required commands
+ This class is designed with flexibililty and simplicity in mind, so adding a new tool is a lot easier, mention TITLE, DESCRIPTION, list of INSTALL_COMMANDS, RUN_COMMANDS and PROJECT_URL and there you go...

+ grouping all the `HackingTool`s is also made super simpler by providing a `HackingToolsCollection` class which groups the tools into their respective categories. Just add the instances of `HackingTool` classes to the TOOLS property of the `HackingToolsCollection`.

+ Refactored all the tools into separate files based on their categories.
+ Added a READM_template.md and generate_readme.py script to automatically generate Table of contents and the list of tools available automatically.
+ Now each tool in the README.md points to its project url if provided. This makes it easier to visit the project from the readme.

core.py

@@ -0,0 +1,185 @@
+# coding=utf-8
+import os
+import sys
+import webbrowser
+from platform import system
+from traceback import print_exc
+from typing import Any
+from typing import Callable
+from typing import List
+from typing import Tuple
+
+
+def clear_screen():
+    if system() == "Linux":
+        os.system("clear")
+    if system() == "Windows":
+        os.system("cls")
+
+
+def validate_input(ip, val_range):
+    try:
+        ip = int(ip)
+        if ip in val_range:
+            return ip
+        else:
+            return None
+    except:
+        return None
+
+
+class HackingTool(object):
+    # About the HackingTool
+    TITLE: str = ""  # used to show info in the menu
+    DESCRIPTION: str = ""
+
+    INSTALL_COMMANDS: List[str] = []
+    INSTALLATION_DIR: str = ""
+
+    UNINSTALL_COMMANDS: List[str] = []
+
+    RUN_COMMANDS: List[str] = []
+
+    OPTIONS: List[Tuple[str, Callable]] = []
+
+    PROJECT_URL: str = ""
+
+    def __init__(self, options = None, installable: bool = True,
+                 runnable: bool = True):
+        if options is None:
+            options = []
+        if isinstance(options, list):
+            self.OPTIONS = []
+            if installable:
+                self.OPTIONS.append(('Install', self.install))
+            if runnable:
+                self.OPTIONS.append(('Run', self.run))
+            self.OPTIONS.extend(options)
+        else:
+            raise Exception(
+                "options must be a list of (option_name, option_fn) tuples")
+
+    def show_info(self):
+        desc = self.DESCRIPTION
+        if self.PROJECT_URL:
+            desc += '\n\t[*] '
+            desc += self.PROJECT_URL
+        os.system(f'echo "{desc}"|boxes -d boy | lolcat')
+        # print(desc)
+
+    def show_options(self, parent = None):
+        clear_screen()
+        self.show_info()
+        for index, option in enumerate(self.OPTIONS):
+            print("[{:2}] {}".format(index + 1, option[0]))
+        if self.PROJECT_URL:
+            print("[{:2}] {}".format(98, "Open project page"))
+        print("[{:2}] {}".format(
+            99, ("Back to " + parent.TITLE) if parent is not None else "Exit"))
+        option_index = input("Select an option : ")
+        try:
+            option_index = int(option_index)
+            if option_index - 1 in range(len(self.OPTIONS)):
+                ret_code = self.OPTIONS[option_index - 1][1]()
+                if ret_code != 99:
+                    input("\n\nPress ENTER to continue:")
+            elif option_index == 98:
+                self.show_project_page()
+            elif option_index == 99:
+                if parent is None:
+                    sys.exit()
+                return 99
+        except (TypeError, ValueError):
+            print("Please enter a valid option")
+            input("\n\nPress ENTER to continue:")
+        except Exception:
+            print_exc()
+            input("\n\nPress ENTER to continue:")
+        return self.show_options(parent = parent)
+
+    def before_install(self):
+        pass
+
+    def install(self):
+        self.before_install()
+        if isinstance(self.INSTALL_COMMANDS, (list, tuple)):
+            for INSTALL_COMMAND in self.INSTALL_COMMANDS:
+                os.system(INSTALL_COMMAND)
+            self.after_install()
+
+    def after_install(self):
+        print("Successfully installed!")
+
+    def before_uninstall(self) -> bool:
+        """ Ask for confirmation from the user and return """
+        return True
+
+    def uninstall(self):
+        if self.before_uninstall():
+            if isinstance(self.UNINSTALL_COMMANDS, (list, tuple)):
+                for UNINSTALL_COMMAND in self.UNINSTALL_COMMANDS:
+                    os.system(UNINSTALL_COMMAND)
+            self.after_uninstall()
+
+    def after_uninstall(self):
+        pass
+
+    def before_run(self):
+        pass
+
+    def run(self):
+        self.before_run()
+        if isinstance(self.RUN_COMMANDS, (list, tuple)):
+            for RUN_COMMAND in self.RUN_COMMANDS:
+                os.system(RUN_COMMAND)
+            self.after_run()
+
+    def after_run(self):
+        pass
+
+    def is_installed(self, dir_to_check = None):
+        print("Unimplemented: DO NOT USE")
+        return "?"
+
+    def show_project_page(self):
+        webbrowser.open_new_tab(self.PROJECT_URL)
+
+
+class HackingToolsCollection(object):
+    TITLE: str = ""  # used to show info in the menu
+    DESCRIPTION: str = ""
+    TOOLS = []  # type: List[Any[HackingTool, HackingToolsCollection]]
+
+    def __init__(self):
+        pass
+
+    def show_info(self):
+        os.system("figlet -f standard -c {} | lolcat".format(self.TITLE))
+        # os.system(f'echo "{self.DESCRIPTION}"|boxes -d boy | lolcat')
+        # print(self.DESCRIPTION)
+
+    def show_options(self, parent = None):
+        clear_screen()
+        self.show_info()
+        for index, tool in enumerate(self.TOOLS):
+            print("[{:2}] {}".format(index, tool.TITLE))
+        print("[{:2}] {}".format(
+            99, ("Back to " + parent.TITLE) if parent is not None else "Exit"))
+        tool_index = input("Choose a tool to proceed: ")
+        try:
+            tool_index = int(tool_index)
+            if tool_index in range(len(self.TOOLS)):
+                ret_code = self.TOOLS[tool_index].show_options(parent = self)
+                if ret_code != 99:
+                    input("\n\nPress ENTER to continue:")
+            elif tool_index == 99:
+                if parent is None:
+                    sys.exit()
+                return 99
+        except (TypeError, ValueError):
+            print("Please enter a valid option")
+            input("\n\nPress ENTER to continue:")
+        except Exception as e:
+            print_exc()
+            input("\n\nPress ENTER to continue:")
+        return self.show_options(parent = parent)