fixes issue #6 (#7)

* fixes issue #6
* Adds GitPython requirement to setup script

Co-authored-by: JWittmeyer <jens.wittmeyer@onetask.ai>

Author: jhoetter

README.md

@@ -107,7 +107,7 @@ If you like what we're working on, please leave a ⭐!
 ```
 pip install kern-refinery
 ```
-Once the library is installed, go to the directory where you want to store the data and run `refinery start`. To stop the server, run `refinery stop`.
+Once the library is installed, go to the directory where you want to store the data and run `refinery start`. This will automatically `git clone` this repository first if you haven't done so yet. To stop the server, run `refinery stop`.
 
 ### From repository
 

cli.py

@@ -1,21 +1,61 @@
+import os
+from contextlib import contextmanager
 import sys
 import platform
 import subprocess
+from git import Repo
 from wasabi import msg
 
+REFINERY_FOLDER = "refinery"
 
-def start():
-    if platform.system() == "Windows":
-        subprocess.run(["start.bat"])
+
+def start(cur_dir: str):
+    """Starts the refinery server; if the refinery repository does not exist, it will be cloned from git first.
+
+    Args:
+        cur_dir (str): The current directory.
+    """
+
+    def _start_server():
+        if platform.system() == "Windows":
+            subprocess.run(["start.bat"])
+        else:
+            subprocess.run(["./start"])
+
+    if not os.path.exists(REFINERY_FOLDER):
+        msg.info(
+            f"Cloning from code-kern-ai/refinery into repository {REFINERY_FOLDER}"
+        )
+        Repo.clone_from("https://github.com/code-kern-ai/refinery", REFINERY_FOLDER)
+        with cd(REFINERY_FOLDER):
+            _start_server()
+    elif cur_dir == REFINERY_FOLDER:
+        _start_server()
     else:
-        subprocess.run(["./start"])
+        with cd(REFINERY_FOLDER):
+            _start_server()
+
+
+def stop(cur_dir: str):
+    """Stops the refinery server.
 
+    Args:
+        cur_dir (str): The current directory.
+    """
 
-def stop():
-    if platform.system() == "Windows":
-        subprocess.run(["stop.bat"])
+    def _stop_server():
+        if platform.system() == "Windows":
+            subprocess.run(["stop.bat"])
+        else:
+            subprocess.run(["./stop"])
+
+    if cur_dir == REFINERY_FOLDER:
+        _stop_server()
+    elif os.path.exists(REFINERY_FOLDER):
+        with cd(REFINERY_FOLDER):
+            _stop_server()
     else:
-        subprocess.run(["./stop"])
+        msg.fail(f"Could not find repository {REFINERY_FOLDER}.")
 
 
 def main():
@@ -24,11 +64,27 @@ def main():
         msg.fail("Please provide arguments when running the `refinery` command.")
         msg.fail("`refinery start` to start the server, `refinery stop` to end it.")
     command = cli_args[0]
+    cur_dir = os.path.split(os.getcwd())[-1]
     if command == "start":
-        start()
+        start(cur_dir)
     elif command == "stop":
-        stop()
+        stop(cur_dir)
     else:
         msg.fail(
             f"Could not understand command `{command}`. Type `refinery help` for some instructions."
         )
+
+
+# https://stackoverflow.com/questions/431684/equivalent-of-shell-cd-command-to-change-the-working-directory/24176022#24176022
+class cd:
+    """Context manager for changing the current working directory"""
+
+    def __init__(self, new_path):
+        self.new_path = os.path.expanduser(new_path)
+
+    def __enter__(self):
+        self.saved_path = os.getcwd()
+        os.chdir(self.new_path)
+
+    def __exit__(self, etype, value, traceback):
+        os.chdir(self.saved_path)

publish.sh

@@ -1,2 +1,3 @@
 requests
-wasabi
+wasabi
+GitPython

requirements.txt

@@ -36,6 +36,7 @@
     install_requires=[
         "requests",
         "wasabi",
+        "GitPython",
     ],
     entry_points={
         "console_scripts": [