feat: reorg as package (#41)

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

README.md

@@ -12,7 +12,7 @@ IDD loads two versions of the same application. The first one is the base versio
 ## :zap: Usage
 Write about how to use this project.
 
-`python3 idd.py -c gdb -ba <path to base executable> -ra <path to regressed executable>`
+`python -m idd -c gdb -ba <path to base executable> -ra <path to regressed executable>`
 
 ### :electric_plug: Installation
 - Steps on how to install this project on Ubuntu 22.04
@@ -27,7 +27,7 @@ $ source iddenv/bin/activate
 -- Installing required packages:
 
 ```
-$ pip3 install textual textual_inputs pygdbmi
+$ pip install -e.
 ```
 
 ## :cherry_blossom: Community

pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "idd"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Martin Vassilev" },
+    { name = "Vassil Vassilev" }, 
+    { name = "Alexander Penev" },
+]
+requires-python = ">=3.9"
+dependencies = [
+  "pygdbmi",
+  "rich",
+  "textual",
+]
+
+
+[project.scripts]
+idd = "idd.cli:main"

requirements.txt

@@ -0,0 +1,4 @@
+from idd.cli import main
+
+if __name__ == "__main__":
+    main()

utils/utils.py renamed to src/idd/__init__.py

@@ -10,11 +10,11 @@
 from textual.widgets import Input
 from textual.containers import Horizontal, Vertical
 
-from diff_driver import DiffDriver
+from idd.diff_driver import DiffDriver
 
-from ui.footer import Footer
-from ui.header import Header
-from ui.scrollable_area import TextScrollView
+from idd.ui.footer import Footer
+from idd.ui.header import Header
+from idd.ui.scrollable_area import TextScrollView
 
 
 class DiffDebug(App):
@@ -413,7 +413,7 @@ async def on_key(self, event: events.Key) -> None:
             self.regressed_command_bar.value = self.regressed_history[self.regressed_history_index]
 
 
-if __name__ == "__main__":
+def main() -> None:
     Debugger = None
 
     parser = argparse.ArgumentParser(description='Diff Debug for simple debugging!')
@@ -446,7 +446,7 @@ async def on_key(self, event: events.Key) -> None:
     base_only = False
 
     if comparator == 'gdb':
-        from debuggers.gdb.gdb_mi_driver import GDBMiDebugger, IDDGdbController
+        from idd.debuggers.gdb.gdb_mi_driver import GDBMiDebugger, IDDGdbController
 
         if ra == "" and rpid is None:
             Debugger = IDDGdbController(ba, bpid, bs)
@@ -455,7 +455,7 @@ async def on_key(self, event: events.Key) -> None:
             Debugger = GDBMiDebugger(ba, bs, ra, rs, base_pid=bpid, regression_pid=rpid)
 
     elif comparator == 'lldb':
-        from debuggers.lldb.lldb_driver import LLDBParallelDebugger, LLDBDebugger
+        from idd.debuggers.lldb.lldb_driver import LLDBParallelDebugger, LLDBDebugger
 
         if ra == "" and rpid is None:
             Debugger = LLDBDebugger(ba, bpid)

src/idd/__main__.py

@@ -1,6 +1,6 @@
 from pygdbmi.gdbcontroller import GdbController
 from pprint import pprint
-from driver import Driver
+from idd.driver import Driver
 
 import io
 import time