Merge pull request #84 from NeuroML/osb_test

Improved getneuroml

Author: pgleeson

getNeuroML.py

@@ -4,6 +4,8 @@
 import sys
 import os.path as op
 import subprocess
+from textwrap import dedent
+
 
 def main():
     """Main"""
@@ -21,6 +23,8 @@ def main():
                 switch_to_branch = "experimental"
             elif arg == "master":
                 switch_to_branch = "master"
+            elif "osb" in arg:
+                switch_to_branch = arg
             else:
                 help_info()
                 exit()
@@ -48,11 +52,9 @@ def main():
     lems_repos = jlems_repo + lems_spec_repos + pylems_repos
 
     # Which repos use a development branch?
-    dev_branch_repos = neuroml2_spec_repo + neuroml_repos + jlems_repo
-
-
-    all_repos = lems_repos  + neuroml_repos 
+    dev_branch_repos = neuroml2_spec_repo + java_neuroml_repos + jlems_repo
 
+    all_repos = lems_repos + neuroml_repos
 
     # Set the preferred method for cloning from GitHub
     github_pref = "HTTP"
@@ -68,32 +70,31 @@ def main():
 
         local_dir = ".." + os.sep + repo.split("/")[1]
 
-        if mode is "clean":
-            print("------ Cleaning: %s -------"%repo)
+        if mode == "clean":
+            print("------ Cleaning: %s -------" % repo)
             if repo in java_repos:
                 command = "mvn clean"
                 print("It's a Java repository, so cleaning using Maven...")
                 info = execute_command_in_dir(command, local_dir)
 
-        if mode is "update":
-
-            print("------ Updating: %s -------" %repo)
+        if mode == "update":
+            print("------ Updating: %s -------" % repo)
 
             runMvnInstall = False
 
             if not op.isdir(local_dir):
                 command = "git clone %s%s" % (pre_gh[github_pref], repo)
-                print ("Creating a new directory: %s by cloning from GitHub" % \
-                    (local_dir))
+                print("Creating a new directory: %s by cloning from GitHub" %
+                      (local_dir))
                 execute_command_in_dir(command, "..")
 
                 runMvnInstall = True
 
             if switch_to_branch:
                 if (repo in dev_branch_repos):
                     command = "git checkout %s" % (switch_to_branch)
-                    print ("Switching to branch: %s" % (switch_to_branch))
-                    exit_on_fail = switch_to_branch is not "experimental"
+                    print("Switching to branch: %s" % (switch_to_branch))
+                    exit_on_fail = switch_to_branch != "experimental"
                     execute_command_in_dir(command, local_dir, exit_on_fail)
                     runMvnInstall = True
 
@@ -107,72 +108,88 @@ def main():
                 or not op.isdir(local_dir + os.sep + "target") \
                 or ("jNeuroML" in repo)
 
-            if (repo in java_repos or repo in neuroml2_spec_repo) and runMvnInstall:
+            if (repo in java_repos or repo in neuroml2_spec_repo) \
+                    and runMvnInstall:
                 command = "mvn install"
                 print("It's a Java repository, so installing using Maven...")
                 info = execute_command_in_dir(command, local_dir)
 
-                #The code below needs a non trivial rewrite due to python3 differences.
-
-                #                
+                # The code below needs a non trivial rewrite due to python3
+                # differences.
                 if str("BUILD SUCCESS") in str(info):
-                    print("Successful installation using : %s!" %command)
+                    print("Successful installation using : %s!" % command)
                 else:
-                    print("Problem installing using : %s!" %command)
+                    print("Problem installing using : %s!" % command)
                     print(info)
                     exit(1)
 
-    if mode is "update":
+    if mode == "update":
         print("All repositories successfully updated & Java modules built!")
-        print("You should be able to run some examples straight " \
-              "away using jnml: ")
-        if os.name is not 'nt':
-            print("  ./jnml "\
-                "-validate ../NeuroML2/examples/NML2_FullNeuroML.nml")
-            print("  ./jnml " \
-                "../NeuroML2/LEMSexamples/LEMS_NML2_Ex2_Izh.xml")
+        print("You should be able to run examples straight away using jnml: ")
+        if os.name != 'nt':
+            print("  ./jnml " +
+                  "-validate ../NeuroML2/examples/NML2_FullNeuroML.nml")
+            print("  ./jnml " +
+                  "../NeuroML2/LEMSexamples/LEMS_NML2_Ex2_Izh.xml")
         else:
-            print("  jnml -validate " \
-                "..\\NeuroML2\\examples\\NML2_FullNeuroML.nml")
-            print("  jnml " \
-                "..\\NeuroML2\\LEMSexamples\\LEMS_NML2_Ex2_Izh.xml")
-    if mode is "clean":
+            print("  jnml -validate " +
+                  "..\\NeuroML2\\examples\\NML2_FullNeuroML.nml")
+            print("  jnml " +
+                  "..\\NeuroML2\\LEMSexamples\\LEMS_NML2_Ex2_Izh.xml")
+    if mode == "clean":
         print("All repositories successfully cleaned!")
 
 
-
-
 def execute_command_in_dir(command, directory, exit_on_fail=True):
     """Execute a command in specific working directory"""
     if os.name == 'nt':
         directory = os.path.normpath(directory)
 
-    print(">>>  Executing: (%s) in dir: %s (%s)" % (command, directory, os.path.abspath(directory)))
+    print(">>>  Executing: (%s) in dir: %s (%s)" %
+          (command, directory, os.path.abspath(directory)))
 
-    p = subprocess.Popen(command, cwd=directory, shell=True, stdout=subprocess.PIPE)
+    p = subprocess.Popen(command, cwd=directory, shell=True,
+                         stdout=subprocess.PIPE)
     return_str = p.communicate()
 
-    if p.returncode != 0:       
-        print("Error: %s" % p.returncode)          
-        print(return_str[0])
-        if exit_on_fail: 
+    if p.returncode != 0:
+
+        print("Error: %s" % p.returncode)
+        print(return_str[0].decode("utf-8") if sys.version_info[0]>=3 else return_str[0])
+        if exit_on_fail:
             exit(p.returncode)
+
     if (sys.version_info > (3, 0)):
         return return_str[0].decode("utf-8")
     else:
         return return_str[0]
 
 
 def help_info():
-    print("\nUsage:\n\n    python getNeuroML.py\n        " \
-        "Pull (or clone) the latest version of all NeuroML 2 repos & " \
-        "compile/install with Maven if applicable\n\n" \
-        "    python getNeuroML.py clean\n        " 
-        "Run 'mvn clean' on all Java repos\n\n" \
-        "    python getNeuroML.py master\n       " \
-        "Switch all repos to master branch\n\n" \
-        "    python getNeuroML.py development\n       " \
-        "Switch relevant repos to development branch\n\n")
+    usage = (
+        """\
+        Usage: python getNeuroML.py [OPTION]
+        Script to install NeuroML libraries.
+        Note: requires internet connectivity.
+
+        python getNeuroML.py
+            Pull (or clone) the latest version of all NeuroML 2 repos &
+            compile/install with Maven if applicable
+
+        python getNeuroML.py clean
+            Run 'mvn clean' on all Java repos
+
+        python getNeuroML.py master
+            Switch all repos to master branch
+
+        python getNeuroML.py development
+            Switch relevant repos to development branch
+
+        python getNeuroML.py experimental
+            Switch relevant repos to experimental branch
+        """
+    )
+    print(dedent(usage))
 
 
 if __name__ == "__main__":