Add requirements.txt... (#63)

* Add requirements.txt...

and also some minor formatting

* Add docs

Author: Ryan Clancy

README.md

@@ -8,6 +8,12 @@ To get started, download + compile `trec_eval` with the following:
 git clone https://github.com/usnistgov/trec_eval.git && make -C trec_eval
 ```
 
+Make sure the Docker Python package is installed (via pip, conda, etc.):
+```
+pip install -r requirements.txt
+```
+
+
 For common test collections, [topics](topics/) and [qrels](qrels/) are already checked into this repo.
 
 To test the jig with an Anserini image using default parameters, try:

interactor.py

@@ -1,15 +1,15 @@
 import json
-import os
 import sys
 
+
 class Interactor:
 
     def __init__(self, interactor_config=None):
         self.config = interactor_config
-    
+
     def set_config(self, interactor_config):
         self.config = interactor_config
-    
+
     def interact(self, client, generate_save_tag):
         """
         Starts a container from a saved image that has already been initialized/indexed.
@@ -23,7 +23,7 @@ def interact(self, client, generate_save_tag):
         exists = len(client.images.list(filters={"reference": "{}:{}".format(self.config.repo, save_tag)})) != 0
         if not exists:
             sys.exit("Must prepare image first...")
-        
+
         interact_args = {
             "opts": {key: value for (key, value) in map(lambda x: x.split("="), self.config.opts)}
         }
@@ -32,11 +32,11 @@ def interact(self, client, generate_save_tag):
         # create with sh command to override any default command
         container = client.containers.create("{}:{}".format(self.config.repo, save_tag), command="sh", tty=True)
         container.start()
-        
+
         print("Running interact script in container...")
-        log = container.exec_run("sh -c '/interact --json {}'".format(json.dumps(json.dumps(interact_args))), 
-                                stdout=True, stderr=True, stream=True)
-        
+        log = container.exec_run("sh -c '/interact --json {}'".format(json.dumps(json.dumps(interact_args))),
+                                 stdout=True, stderr=True, stream=True)
+
         print("Logs for interact in container with ID {}...".format(container.id))
         for line in log[1]:
             print(str(line.decode('utf-8')), end="")
@@ -47,7 +47,7 @@ def interact(self, client, generate_save_tag):
             print("Exiting...")
             print("Don't forget to stop and remove the container after you are done!")
             return
-        
+
         wait = input("Press ENTER to stop and remove container")
         print("Stopping container {}...".format(container.id))
         container.stop()

manager.py

@@ -1,11 +1,11 @@
-import os
 import hashlib
+import os
 
 import docker
 
+from interactor import Interactor
 from preparer import Preparer
 from searcher import Searcher
-from interactor import Interactor
 
 TOPIC_PATH_HOST = os.path.abspath("topics")
 TOPIC_PATH_GUEST = "/input/topics/"
@@ -28,7 +28,7 @@ def set_preparer_config(self, preparer_config):
 
     def set_searcher_config(self, searcher_config):
         self.searcher.set_config(searcher_config)
-    
+
     def set_interactor_config(self, interactor_config):
         self.interactor.set_config(interactor_config)
 

requirements.txt

@@ -0,0 +1,9 @@
+certifi==2019.3.9
+chardet==3.0.4
+docker==3.7.2
+docker-pycreds==0.4.0
+idna==2.8
+requests==2.21.0
+six==1.12.0
+urllib3==1.24.2
+websocket-client==0.56.0

run.py

@@ -2,14 +2,15 @@
 
 from manager import Manager
 
+
 def str_to_bool(s):
-        s = s.lower()
-        if s == "true":
-            return True
-        elif s == "false":
-            return False
-        else:
-            raise argparse.ArgumentTypeError("Expected boolean value.")
+    s = s.lower()
+    if s == "true":
+        return True
+    elif s == "false":
+        return False
+    else:
+        raise argparse.ArgumentTypeError("Expected boolean value.")
 
 
 if __name__ == "__main__":