General clean up of setup.py

setup.py

@@ -4,31 +4,53 @@ from setuptools import setup
 import subprocess
 from os import path
 
-version = '0.2.1'
 
-# Write a version file containing the git hash and info
-try:
-    git_log = subprocess.check_output(
-        ['git', 'log', '-1', '--pretty=%h %ai']).decode('utf-8')
-    git_diff = (subprocess.check_output(['git', 'diff', '.'])
-                + subprocess.check_output(
-                    ['git', 'diff', '--cached', '.'])).decode('utf-8')
-    if git_diff == '':
-        status = '(CLEAN) ' + git_log
-    else:
-        status = '(UNCLEAN) ' + git_log
-except subprocess.CalledProcessError:
-    status = ''
-
-version_file = '.version'
-if path.isfile(version_file) is False:
-    with open('tupak/' + version_file, 'w+') as f:
-        f.write('{} - {}'.format(version, status))
-
-
-here = path.abspath(path.dirname(__file__))
-with open(path.join(here, 'README.rst')) as f:
-        long_description = f.read()
+def write_version_file(version):
+    """ Writes a file with version information to be used at run time
+
+    Parameters
+    ----------
+    version: str
+        A string containing the current version information
+
+    Returns
+    -------
+    version_file: str
+        A path to the version file
+
+    """
+    try:
+        git_log = subprocess.check_output(
+            ['git', 'log', '-1', '--pretty=%h %ai']).decode('utf-8')
+        git_diff = (subprocess.check_output(['git', 'diff', '.'])
+                    + subprocess.check_output(
+                        ['git', 'diff', '--cached', '.'])).decode('utf-8')
+        if git_diff == '':
+            status = '(CLEAN) ' + git_log
+        else:
+            status = '(UNCLEAN) ' + git_log
+    except subprocess.CalledProcessError:
+        status = ''
+
+    version_file = '.version'
+    if path.isfile(version_file) is False:
+        with open('tupak/' + version_file, 'w+') as f:
+            f.write('{} - {}'.format(version, status))
+
+    return version_file
+
+
+def get_long_description():
+    """ Finds the README and reads in the description """
+    here = path.abspath(path.dirname(__file__))
+    with open(path.join(here, 'README.rst')) as f:
+            long_description = f.read()
+    return long_description
+
+
+version = '0.2.1'
+version_file = write_version_file(version)
+long_description = get_long_description()
 
 setup(name='tupak',
       description='The User friendly Parameter estimAtion Kode',
@@ -40,7 +62,8 @@ setup(name='tupak',
       version=version,
       packages=['tupak', 'tupak.core', 'tupak.gw', 'tupak.hyper', 'cli_tupak'],
       package_dir={'tupak': 'tupak'},
-      package_data={'tupak.gw': ['prior_files/*', 'noise_curves/*.txt', 'detectors/*'],
+      package_data={'tupak.gw': ['prior_files/*', 'noise_curves/*.txt',
+                                 'detectors/*'],
                     'tupak': [version_file]},
       install_requires=[
           'future',
@@ -50,9 +73,7 @@ setup(name='tupak',
           'matplotlib>=2.0',
           'deepdish',
           'pandas',
-          'scipy',
-          ],
+          'scipy'],
       entry_points={'console_scripts':
                     ['tupak_plot=cli_tupak.plot_multiple_posteriors:main']
                     })
-