Merge branch 'release-tools' into trunk

* release-tools:
  EHN - build eggs for multiple versions of Python
  EHN - better gitignore
  BUG - use correct name
  ENH - make script more portable
  ENH - Adapted build/release scripts from IPython (thanks to Fernando Perez)

Author: jarrodmillman

.gitignore

@@ -50,6 +50,7 @@
 ################
 build            # setup.py working directory
 _build           # sphinx build directory
+MANIFEST
 ./dist           # setup.py dist directory
 ./*.egg-info     # Egg metadata
 ./.shelf         # The shelf plugin uses this dir

tools/build_release

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+"""nibabel release build script.
+"""
+from toollib import *
+
+# Get main nibabel dir, this will raise if it doesn't pass some checks
+nibdir = get_nibdir()
+cd(nibdir)
+
+# Load release info
+execfile(pjoin('nibabel','info.py'))
+
+# Check that everything compiles
+compile_tree()
+
+# Cleanup
+for d in ['build','dist',pjoin('docs','build'),pjoin('docs','dist')]:
+    if os.path.isdir(d):
+        remove_tree(d)
+
+# Build source and binary distros
+c('./setup.py sdist --formats=gztar,zip')
+
+# Build eggs
+for version in ['2.5', '2.6', '2.7']:
+    cmd='python'+version+' ./setup_egg.py bdist_egg'
+    stat = os.system(cmd)

tools/compile.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+"""Script to check that all code in a directory compiles correctly.
+
+Usage:
+
+  compile.py
+
+This script verifies that all Python files in the directory where run, and all
+of its subdirectories, compile correctly.
+
+Before a release, call this script from the top-level directory.
+"""
+
+import sys
+
+from toollib import compile_tree
+
+if __name__ == '__main__':
+    compile_tree()

tools/make_tarball.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+"""Simple script to create a tarball with proper git info.
+"""
+
+import commands
+import os
+import sys
+import shutil
+
+from  toollib import *
+
+tag = commands.getoutput('git describe')
+base_name = 'nibabel-%s' % tag
+tar_name = '%s.tgz' % base_name
+
+# git archive is weird:  Even if I give it a specific path, it still won't
+# archive the whole tree.  It seems the only way to get the whole tree is to cd
+# to the top of the tree.  There are long threads (since 2007) on the git list
+# about this and it still doesn't work in a sensible way...
+
+start_dir = os.getcwd()
+cd('..')
+git_tpl = 'git archive --format=tar --prefix={0}/ HEAD | gzip > {1}'
+c(git_tpl.format(base_name, tar_name))
+c('mv {0} tools/'.format(tar_name))

tools/release

@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+"""nibabel release script.
+
+This should only be run at real release time.
+"""
+
+from toollib import *
+
+# Get main nibabel dir, this will raise if it doesn't pass some checks
+nibdir = get_nibdir()
+tooldir = pjoin(nibdir,'tools')
+distdir = pjoin(nibdir,'dist')
+#### Where I keep static backups of each release
+###nibbackupdir = os.path.expanduser('~/nibabel/backup')
+
+# Start in main nibabel dir
+cd(nibdir)
+
+# Load release info
+execfile(pjoin('nibabel','info.py'))
+
+print
+print "Releasing nibabel"
+print "================="
+print
+print 'Source nibabel directory:', nibdir
+print
+
+# Perform local backup, go to tools dir to run it.
+cd(tooldir)
+c('./make_tarball.py')
+c('mv nibabel-*.tgz %s' % nibbackupdir)
+
+# Build release files
+c('./build_release %s' % nibdir)
+
+# Register with the Python Package Index (PyPI)
+print "Registering with PyPI..."
+cd(nibdir)
+c('./setup.py register')
+
+#### Upload all files
+###c('./setup.py sdist --formats=gztar,zip upload')
+###cd(distdir)
+###print "Uploading distribution files..."
+###c('scp * [email protected]:www/dist/')
+###
+###print "Uploading backup files..."
+###cd(nibbackupdir)
+###c('scp `ls -1tr *tgz | tail -1` [email protected]:www/backup/')
+
+print "Done!"

tools/toollib.py

@@ -0,0 +1,46 @@
+"""Various utilities common to nibabel release and maintenance tools.
+"""
+# Library imports
+import os
+import sys
+
+from distutils.dir_util import remove_tree
+
+# Useful shorthands
+pjoin = os.path.join
+cd = os.chdir
+
+# Utility functions
+def c(cmd):
+    """Run system command, raise SystemExit if it returns an error."""
+    print "$",cmd
+    stat = os.system(cmd)
+    #stat = 0  # Uncomment this and comment previous to run in debug mode
+    if stat:
+        raise SystemExit("Command %s failed with code: %s" % (cmd, stat))
+
+
+def get_nibdir():
+    """Get nibabel directory from command line, or assume it's the one above."""
+
+    # Initialize arguments and check location
+    try:
+        nibdir = sys.argv[1]
+    except IndexError:
+        nibdir = '..'
+
+    nibdir = os.path.abspath(nibdir)
+
+    cd(nibdir)
+    if not os.path.isdir('nibabel') and os.path.isfile('setup.py'):
+        raise SystemExit('Invalid nibabel directory: %s' % nibdir)
+    return nibdir
+
+# import compileall and then get dir os.path.split
+def compile_tree():
+    """Compile all Python files below current directory."""
+    stat = os.system('python -m compileall .')
+    if stat:
+        msg = '*** ERROR: Some Python files in tree do NOT compile! ***\n'
+        msg += 'See messages above for the actual file that produced it.\n'
+        raise SystemExit(msg)