restructed src according to installation using hatch

Author: shashkat

pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "slithbot"
+dynamic = ["version"]
+license = "MIT"
+dependencies = [
+    "numpy == 2.3.5",
+    "pygame == 2.6.1",
+    "pyyaml == 6.0.3"
+]
+
+[tool.hatch.version]
+source = "vcs"
+
+[project.scripts]
+slithbot-run = "slithbot.main:main" # main function within slithbot/main.py
+
+

requirements.txt

@@ -3,7 +3,7 @@
 import random
 import numpy as np
 from typing import List, Tuple, Dict, Optional
-from utils import *
+from slithbot.utils import *
 
 # Colors
 BACKGROUND = (45, 52, 54)

src/__init__.py src/slithbot/__init__.pysrc/__init__.py renamed to src/slithbot/__init__.py

@@ -7,14 +7,23 @@
 # Initialize Pygame
 pygame.init()
 
-from game import SlitherGame
+from slithbot.game import SlitherGame
 
 # from a supplied path, reads the config yaml, and returns a dict
 def load_config(config_path: str) -> dict:
     with open(Path(config_path)) as f:
         return yaml.safe_load(f)
 
-def main(config_path: str):
+# this function will be called when the slithbot-run script will be executed from the terminal. argv will 
+# hold all the argument values (including this script's name)
+def main():
+
+    argv = sys.argv
+    # ensure that exactly one argument was supplied (so something like $slithbot-run config.yaml).
+    if len(argv) != 2:
+        raise Exception(f'\n Exactly 1 argument (location of config file) should be supplied to slithbot-run. You supplied {len(argv)-1} arguments! \n Example usage: \n $ slithbot-run config/base.yaml')
+    
+    config_path = argv[1]
     config = load_config(config_path)
     game = SlitherGame(config)
 
@@ -39,9 +48,10 @@ def main(config_path: str):
     game.close()
 
 
-if __name__ == "__main__":
-    if len(sys.argv) != 2:
-        print("Usage: python scripts/run_simulation.py <config.yaml>")
-        sys.exit(1)
-    main(sys.argv[1])
-    # main(config_path='/Users/shashankkatiyar/Documents/github_repos/slithbot/config/base.yaml')
+# TO REMOVE
+# if __name__ == "__main__":
+#     if len(sys.argv) != 2:
+#         print("Usage: python scripts/run_simulation.py <config.yaml>")
+#         sys.exit(1)
+#     main(sys.argv[1])
+#     # main(config_path='/Users/shashankkatiyar/Documents/github_repos/slithbot/config/base.yaml')