fix: added pkg_info

Author: satra

bin/bips

@@ -24,4 +24,9 @@ bips -m smri -t volume -w normalize -c config.py
 bips -m smri -t volume -w template -c config.py
 bips -m smri -t surface -w template -c config.py
 
+alternatively
+bips -i -u uuid # display info about workflow
+bips -u uuid -c config.json # create config for running workflow
+bips -r config.json # run workflow
+
 """

bips/pkg_info.py

@@ -0,0 +1,93 @@
+import os
+import sys
+import subprocess
+from ConfigParser import ConfigParser
+
+COMMIT_INFO_FNAME = 'COMMIT_INFO.txt'
+
+def pkg_commit_hash(pkg_path):
+    ''' Get short form of commit hash given directory `pkg_path`
+
+    There should be a file called 'COMMIT_INFO.txt' in `pkg_path`.  This is a
+    file in INI file format, with at least one section: ``commit hash``, and two
+    variables ``archive_subst_hash`` and ``install_hash``.  The first has a
+    substitution pattern in it which may have been filled by the execution of
+    ``git archive`` if this is an archive generated that way.  The second is
+    filled in by the installation, if the installation is from a git archive.
+
+    We get the commit hash from (in order of preference):
+
+    * A substituted value in ``archive_subst_hash``
+    * A written commit hash value in ``install_hash`
+    * git's output, if we are in a git repository
+
+    If all these fail, we return a not-found placeholder tuple
+
+    Parameters
+    ----------
+    pkg_path : str
+       directory containing package
+
+    Returns
+    -------
+    hash_from : str
+       Where we got the hash from - description
+    hash_str : str
+       short form of hash
+    '''
+    # Try and get commit from written commit text file
+    pth = os.path.join(pkg_path, COMMIT_INFO_FNAME)
+    if not os.path.isfile(pth):
+        raise IOError('Missing commit info file %s' % pth)
+    cfg_parser = ConfigParser()
+    cfg_parser.read(pth)
+    archive_subst = cfg_parser.get('commit hash', 'archive_subst_hash')
+    if not archive_subst.startswith('$Format'): # it has been substituted
+        return 'archive substitution', archive_subst
+    install_subst = cfg_parser.get('commit hash', 'install_hash')
+    if install_subst != '':
+        return 'installation', install_subst
+    # maybe we are in a repository
+    proc = subprocess.Popen('git rev-parse --short HEAD',
+                            stdout=subprocess.PIPE,
+                            stderr=subprocess.PIPE,
+                            cwd=pkg_path, shell=True)
+    repo_commit, _ = proc.communicate()
+    if repo_commit:
+        return 'repository', repo_commit.strip()
+    return '(none found)', '<not found>'
+
+
+def get_pkg_info(pkg_path):
+    ''' Return dict describing the context of this package
+
+    Parameters
+    ----------
+    pkg_path : str
+       path containing __init__.py for package
+
+    Returns
+    -------
+    context : dict
+       with named parameters of interest
+    '''
+    src, hsh = pkg_commit_hash(pkg_path)
+    import networkx
+    import nibabel
+    import nipype
+    import numpy
+    import scipy
+    import traits
+    return dict(
+        pkg_path=pkg_path,
+        commit_source=src,
+        commit_hash=hsh,
+        sys_version=sys.version,
+        sys_executable=sys.executable,
+        sys_platform=sys.platform,
+        nipype_version=nipype.__version__,
+        numpy_version=numpy.__version__,
+        scipy_version=scipy.__version__,
+        networkx_version=networkx.__version__,
+        nibabel_version=nibabel.__version__,
+        traits_version=traits.__version__)