Add a `tox-quickstart` command that asks a few questions and then

generates a simple `tox.ini` file to help users get started with tox
more easily.

3 files changed, 184 insertions, 1 deletions

diff --git a/setup.py b/setup.py
index 63acabf..b7a9196 100644
--- a/setup.py
+++ b/setup.py
@@ -55,7 +55,7 @@ def main():
         author='holger krekel',
         author_email='holger@merlinux.eu',
         packages=['tox', ],
-        entry_points={'console_scripts': 'tox=tox:cmdline'},
+        entry_points={'console_scripts': 'tox=tox:cmdline\ntox-quickstart=tox:quickstart'},
         # we use a public tox version to test, see tox.ini's testenv
         # "deps" definition for the required dependencies
         tests_require=['tox'],
diff --git a/tox/__init__.py b/tox/__init__.py
index 2f54cc7..152ba0f 100644
--- a/tox/__init__.py
+++ b/tox/__init__.py
@@ -21,3 +21,4 @@ class exception:
         """ a dependency could not be found or determined. """
 
 from tox._cmdline import main as cmdline
+from tox._quickstart import main as quickstart
diff --git a/tox/_quickstart.py b/tox/_quickstart.py
new file mode 100644
index 0000000..93c3003
--- /dev/null
+++ b/tox/_quickstart.py
@@ -0,0 +1,182 @@
+# -*- coding: utf-8 -*-
+"""
+    tox._quickstart
+    ~~~~~~~~~~~~~~~~~
+
+    Quickly setup tox.ini for a Python project
+
+    :license: GPL, see LICENSE for details.
+"""
+
+import sys
+from os import path
+from codecs import open
+
+TERM_ENCODING = getattr(sys.stdin, 'encoding', None)
+
+from tox import __version__
+
+# function to get input from terminal -- overridden by the test suite
+try:
+    # this raw_input is not converted by 2to3
+    term_input = raw_input
+except NameError:
+    term_input = input
+
+
+all_envs = ['py24', 'py25', 'py26', 'py27', 'py30', 'py31', 'py32', 'py33', 'pypy', 'jython']
+
+PROMPT_PREFIX = '> '
+
+QUICKSTART_CONF = '''\
+[tox]
+envlist = %(envlist)s
+
+[testenv]
+commands = %(commands)s
+deps = %(deps)s
+'''
+
+
+class ValidationError(Exception):
+    """Raised for validation errors."""
+
+def nonempty(x):
+    if not x:
+        raise ValidationError("Please enter some text.")
+    return x
+
+def choice(*l):
+    def val(x):
+        if x not in l:
+            raise ValidationError('Please enter one of %s.' % ', '.join(l))
+        return x
+    return val
+
+def boolean(x):
+    if x.upper() not in ('Y', 'YES', 'N', 'NO'):
+        raise ValidationError("Please enter either 'y' or 'n'.")
+    return x.upper() in ('Y', 'YES')
+
+def suffix(x):
+    if not (x[0:1] == '.' and len(x) > 1):
+        raise ValidationError("Please enter a file suffix, "
+                              "e.g. '.rst' or '.txt'.")
+    return x
+
+def ok(x):
+    return x
+
+
+def do_prompt(d, key, text, default=None, validator=nonempty):
+    while True:
+        if default:
+            prompt = PROMPT_PREFIX + '%s [%s]: ' % (text, default)
+        else:
+            prompt = PROMPT_PREFIX + text + ': '
+        x = term_input(prompt)
+        if default and not x:
+            x = default
+        if not isinstance(x, unicode):
+            # for Python 2.x, try to get a Unicode string out of it
+            if x.decode('ascii', 'replace').encode('ascii', 'replace') != x:
+                if TERM_ENCODING:
+                    x = x.decode(TERM_ENCODING)
+                else:
+                    print('* Note: non-ASCII characters entered '
+                          'and terminal encoding unknown -- assuming '
+                          'UTF-8 or Latin-1.')
+                    try:
+                        x = x.decode('utf-8')
+                    except UnicodeDecodeError:
+                        x = x.decode('latin1')
+        try:
+            x = validator(x)
+        except ValidationError, err:
+            print('* ' + str(err))
+            continue
+        break
+    d[key] = x
+
+
+def ask_user(d):
+    """Ask the user for quickstart values missing from *d*.
+
+    """
+
+    print('Welcome to the Tox %s quickstart utility.') % __version__
+    print '''
+This utility will ask you a few questions and then generate a simple tox.ini
+file to help get you started using tox.
+
+Please enter values for the following settings (just press Enter to
+accept a default value, if one is given in brackets).'''
+
+    print
+
+    for pyenv in all_envs:
+        if pyenv not in d:
+            do_prompt(d, pyenv, 'Test your project with %s (Y/n)' % pyenv, 'Y', boolean)
+
+    d['envlist'] = ', '.join([env for env in all_envs if d[env] is True])
+
+    print '''
+What command should be used to test your project -- examples:
+    - python setup.py test
+    - nosetests package.module
+    - trial package.module'''
+    do_prompt(d, 'commands', 'Command to run to test project', 'python setup.py test')
+
+    print '''
+What dependencies does your project have?'''
+    do_prompt(d, 'deps', 'Comma-separated list of dependencies', ' ')
+    d['deps'] = '\n' + '\n'.join(['    %s' % dep.strip() for dep in d['deps'].split(',')])
+
+
+def generate(d, overwrite=True, silent=False):
+    """Generate project based on values in *d*."""
+
+    conf_text = QUICKSTART_CONF % d
+
+    def write_file(fpath, mode, content):
+        if overwrite or not path.isfile(fpath):
+            print 'Creating file %s.' % fpath
+            f = open(fpath, mode, encoding='utf-8')
+            try:
+                f.write(content)
+            finally:
+                f.close()
+        else:
+            print 'File %s already exists, skipping.' % fpath
+
+    print
+
+    write_file('tox.ini', 'w', conf_text)
+
+    if silent:
+        return
+    print
+    print 'Finished: A tox.ini file has been created.'
+    print '''
+Execute `tox` to test your project.
+'''
+
+
+def main(argv=sys.argv):
+    d = {}
+    if len(argv) > 3:
+        print 'Usage: tox-quickstart [root]'
+        sys.exit(1)
+    elif len(argv) == 2:
+        d['path'] = argv[1]
+    try:
+        ask_user(d)
+    except (KeyboardInterrupt, EOFError):
+        print
+        print '[Interrupted.]'
+        return
+    generate(d)
+
+
+if __name__ == '__main__':
+    main()