Merge pull request #124 from matthew-brett/checkfor-missing-scripts

RF: refactor installation checks to check scripts

Rewrite of testers module for clarity, in part. Add a routine that
allows us to check if any scripts have been missed in the installation.
Add this to the Makefile as a target and to the release checklist.

Refactor nifti diagnostic script, rename to nib-nifti-dx

Add nib-dicomfs, nib-nifti-dx to setup.py

Author: matthew-brett

Makefile

@@ -229,6 +229,9 @@ bdist_rpm:
 bdist_mpkg:
 	$(PYTHON) tools/mpkg_wrapper.py setup.py install
 
+# Check for files not installed
+check-files:
+	$(PYTHON) -c 'from nisext.testers import check_files; check_files("nibabel")'
 
 # Print out info for possible install methods
 check-version-info:

bin/nib-nifti-dx

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+# emacs: -*- mode: python-mode; py-indent-offset: 4; indent-tabs-mode: nil -*-
+# vi: set ft=python sts=4 ts=4 sw=4 et:
+### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
+#
+#   See COPYING file distributed along with the NiBabel package for the
+#   copyright and license terms.
+#
+### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
+''' Print nifti diagnostics for header files '''
+
+import sys
+
+from optparse import OptionParser
+
+import nibabel as nib
+
+
+def main():
+    """ Go go team """
+    parser = OptionParser(
+        usage="%s [FILE ...]\n\n" % sys.argv[0] + __doc__,
+        version="%prog " + nib.__version__)
+    (opts, files) = parser.parse_args()
+
+    for fname in files:
+        fobj = nib.volumeutils.allopen(fname)
+        hdr =  fobj.read(nib.nifti1.header_dtype.itemsize)
+        result = nib.Nifti1Header.diagnose_binaryblock(hdr)
+        if len(result):
+            print 'Picky header check output for "%s"\n' % fname
+            print result
+            print
+        else:
+            print 'Header for "%s" is clean' % fname
+
+
+if __name__ == '__main__':
+    main()

bin/nifti1_diagnose.py

@@ -96,11 +96,20 @@ Release checklist
     {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'archive substitution', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
     /var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel/__init__.pyc
     {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'installation', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/var/folders/jg/jgfZ12ZXHwGSFKD85xLpLk+++TI/-Tmp-/tmpGPiD3E/pylib/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
-    Files not taken across by the installation:
-    []
     /Users/mb312/dev_trees/nibabel/nibabel/__init__.pyc
     {'sys_version': '2.6.6 (r266:84374, Aug 31 2010, 11:00:51) \n[GCC 4.0.1 (Apple Inc. build 5493)]', 'commit_source': 'repository', 'np_version': '1.5.0', 'commit_hash': '25b4125', 'pkg_path': '/Users/mb312/dev_trees/nibabel/nibabel', 'sys_executable': '/Library/Frameworks/Python.framework/Versions/2.6/Resources/Python.app/Contents/MacOS/Python', 'sys_platform': 'darwin'}
 
+* Check the ``setup.py`` file is picking up all the library code and scripts,
+  with::
+
+    make check-files
+
+  Look for output at the end about missed files, such as::
+
+    Missed script files:  /Users/mb312/dev_trees/nibabel/bin/nib-dicomfs, /Users/mb312/dev_trees/nibabel/bin/nifti1_diagnose.py
+
+  Fix ``setup.py`` to carry across any files that should be in the distribution.
+
 * You probably have virtualenvs for different python versions.  Check the tests
   pass for different configurations.  If you have pytox_ and a network
   connnection, and lots of pythons installed, you might be able to do::