Merge lp:~quickly-committers/quickly/add_widgets into lp:quickly

[Tony Byrne]

Allows $quickly add to add files from outside a quickly template

[Michael Terry (mterry)]

This would be a lot easier to read if the ide branch wasn't interwoven. You can specify a prerequisite branch when filing a merge (and unfortunately, seemingly only then) which would hide that prerequisite branch on this page. Just FYI. For now I can review this using bzr directly.

Changes like this and the preferences might best be discussed on quickly-talk first, to get a sense of your direction and the technical ramifications. Especially if the discussion might change how you implement it (so you don't waste work).

I'm not sure what the goal of adding outside files from quickly widgets is? Quickly widgets is an external library meant to be used like any other python library, not pulled in directly.

[Tony Byrne (tony-badwolf)]

The point of this branch is for the developer who wants to make a
small modification to the template but have most of it maintained by
quickly-maintainers. One way to do that is to allow $quickly add to
pull in the developer's mods to the project itself.

Without $quickly add <outside files> means that the developer needs to
$quickly create ubuntu-application app. Then put in his favourite
files manually, app/app/foo.py, app/tests/test_foo.py. Mangle
contents of test_foo.py so it can import app.foo.

Imagine having commands like
$quickly add foo that does all of the above
$quickly add company-logo (not general enough for quickly)
$quickly add dbus-client
$quickly add dbus-server
$quickly add threading (unpopular)

 Using quickly-widgets is only a proof of concept - the simplest
plugin does not need to conform to any requirements. $quickly help add
can read the plugin docstring but doesn't require it.

 A complex plugin will have a loader like store/dialog.py.

 The primary use case, developer's favourite files, are unlikely to be
importable on the target box.

On 27/05/2011, Michael Terry <email address hidden> wrote:
> This would be a lot easier to read if the ide branch wasn't interwoven. You
> can specify a prerequisite branch when filing a merge (and unfortunately,
> seemingly only then) which would hide that prerequisite branch on this page.
> Just FYI. For now I can review this using bzr directly.
>
> Changes like this and the preferences might best be discussed on
> quickly-talk first, to get a sense of your direction and the technical
> ramifications. Especially if the discussion might change how you implement
> it (so you don't waste work).
>
> I'm not sure what the goal of adding outside files from quickly widgets is?
> Quickly widgets is an external library meant to be used like any other
> python library, not pulled in directly.
> --
> https://code.launchpad.net/~quickly-committers/quickly/add_widgets/+merge/62222
> You proposed lp:~quickly-committers/quickly/add_widgets for merging.
>

Unmerged revisions

622. By Tony Byrne <email address hidden> on 2011-05-24

moved function file_from_template(...) from quicklyutils to templatetools
updated $quickly preferences command (introduced in branch ide) to display default values
$quickly add command can add files from outside quickly
default outside files are from quickly-widgets

621. By Tony Byrne <email address hidden> on 2011-05-17

removed some junk

620. By Tony Byrne <email address hidden> on 2011-05-17

allow preferences to be edited outside project
removed quickly configure preferences
added quickly preferences
moved read_input from templates/ubuntu-application/quicklyutils.py
to quickly/templatetools.py

619. By Tony Byrne <email address hidden> on 2011-05-16

added command configure preferences

618. By Tony Byrne <email address hidden> on 2011-05-16

moved get_quickly_editors() into templatetools: same code for all templates
use a config file to allow developer use an ide for editing project keeping gedit for read_input()

=== modified file 'data/templates/ubuntu-application/add.py'
--- data/templates/ubuntu-application/add.py	2010-11-12 00:28:53 +0000
+++ data/templates/ubuntu-application/add.py	2011-05-24 23:28:25 +0000
@@ -16,61 +16,199 @@
 #You should have received a copy of the GNU General Public License along 
 #with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+'''Add something to your project
+
+where something can identify a python file or a script
+usual role for script is to mangle a file, load non-python files, or both'''
+
+import ast
+import glob
+import os.path
+import subprocess
 import sys
-from quickly import templatetools, commands
-
-import gettext
-from gettext import gettext as _
+
+
+from gettext import textdomain, gettext as _
 # set domain text
-gettext.textdomain('quickly')
+textdomain('quickly')
 
-argv = sys.argv
+from quickly import templatetools, commands, configurationhandler
 
 from store import *
 import store
 
-addable = [x for x in dir(store) if x[0] != '_']
+ADDABLE = [x for x in dir(store) if x[0] != '_']
 
-options = {}
-for module in addable:
+OPTIONS = {}
+for module in ADDABLE:
     try:
-        options[module] = getattr(store, module).option
+        OPTIONS[module] = getattr(store, module).option
     except AttributeError:
         # ignore files in store that have no option for us
         pass
 
+# if config not already loaded
+if not configurationhandler.project_config:
+    configurationhandler.loadConfig()
+    PROJECT_CONFIG = configurationhandler.project_config
+
+def get_options_from_plugin(plugin):
+    '''if the plugin needs options it should describe them'''
+
+    quickly_options = ''
+    for subnode in ast.iter_child_nodes(plugin[2]):
+        if type(subnode) == ast.Assign:
+
+            result_as_dict = {}
+            for item in ast.iter_child_nodes(subnode):
+                field =  dict(ast.iter_fields(item))
+                if field.get('id') == 'QUICKLY_OPTIONS':
+                    result_as_dict['id'] = 'QUICKLY_OPTIONS'
+                if field.get('s') is not None:
+                    result_as_dict['s'] = field.get('s')
+
+            if result_as_dict.get('id') == 'QUICKLY_OPTIONS':
+                quickly_options  = result_as_dict.get('s')
+
+    result = 'quickly add %s %s' % (plugin[0], quickly_options)
+    return result
+    
+
+def get_plugins_from_path(_path):
+    '''parse plugin files using ast'''
+    _path = os.path.expanduser(_path)
+    globs = glob.glob('%s/*' % _path)
+    # get only files
+    plugin_files = [y for y in globs if os.path.isfile(y)]
+    # exclude __init__.py
+    plugin_files = [y for y in plugin_files if os.path.basename(y)[0] != '_']
+
+    _basenames = [os.path.basename(y) for y in plugin_files]
+    _names = [os.path.splitext(y)[0] for y in _basenames]
+
+    nodes = []
+    for plugin_file in plugin_files:
+        with open(plugin_file) as filepointer:
+            contents = filepointer.read()
+        node = ast.parse(contents)
+        nodes.append(node)
+
+    plugin_list = zip(_names, plugin_files, nodes)
+    results = [(y[0], y[1:]) for y in plugin_list]
+
+    _adds = [get_options_from_plugin(y) for y in plugin_list]
+
+    plugin_options = zip(_names, _adds)
+    OPTIONS.update(plugin_options)
+
+    return results
+
+PLUGIN_PATH = templatetools.option(
+    PROJECT_CONFIG['template'], 'plugin_path')
+
+PLUGINS = {}
+PLUGIN_PATHS = PLUGIN_PATH.split(':')
+for path in PLUGIN_PATHS:
+    # handle preference with superfluous colons e.g. plugin_path = :::/path1:
+    if len(path):
+        PLUGINS.update(get_plugins_from_path(path))
+
+def get_help_from_plugin(_plugin_name):
+    'use first line of docstring as help text'
+    
+    _docstring = ast.get_docstring(PLUGINS.get(_plugin_name)[1], clean=True)
+    if _docstring is not None:
+        docstring_lines = _docstring.split('\n')
+        help_text = docstring_lines[0]
+    else:
+        help_text = 'no help for %s yet' % _plugin_name
+
+    return '%s\n%s' % (_plugin_name, help_text)
+
+def insert_plugin(chosen_plugin):
+    '''copy plugin to project
+    or run plugin in project'''
+    _path = chosen_plugin[0]
+    if not os.access(_path, os.X_OK):
+        project_name = PROJECT_CONFIG['project']
+        python_name = templatetools.python_name(project_name)
+
+        #to add non-python files use a runnable plugin script
+        target_dir = os.path.join(os.getcwd(), python_name)
+        templatetools.file_from_template(
+            '', _path, target_dir, [], False)
+    else:
+        # run a plugin script - similar to store/dialog.py
+        _instance = subprocess.Popen([_path] + sys.argv[2:], cwd=os.getcwd())
+        _instance.wait()
+
+# skeleton for runnable plugin script
+"""#!/usr/bin/python
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+### BEGIN LICENSE
+# This file is in the public domain
+### END LICENSE
+
+'''A simple plugin'''
+import os
+import sys
+
+QUICKLY_OPTIONS = '<option>'
+
+if __name__ == "__main__":
+    SRC, DEST = os.path.dirname(os.path.abspath(__file__)), os.getcwd()
+    print __doc__
+    print 'plugin files path', SRC
+    print 'quickly project path', DEST
+    print 'options', sys.argv
+    assert SRC != DEST """
+
 def usage():
-    templatetools.print_usage(options.values())
+    '''a quickly API'''
+    templatetools.print_usage(OPTIONS.values())
 
-def help():
+def help(): # pylint: disable=W0622
+    '''a quickly API'''
     help_list = [_('Add something to your project\n')]
-    for module in addable:
+    for store_module in ADDABLE:
         try:
-            help_list.append(getattr(store, module).help_text)
+            help_list.append(getattr(store, store_module).help_text)
         except AttributeError:
             # ignore files in store that have no help for us
             pass
+    for plugin in PLUGINS:
+        help_list.append(get_help_from_plugin(plugin))
+
     help_text = '\n\n'.join(help_list)
     print help_text
 
+ARGV = sys.argv
+
 def shell_completion(argv):
     ''' Complete args '''
     # option completion
-    rv = []
+    allowable_args = []
     if len(argv) == 1:
-        rv = options.keys()
-    if rv:
-        rv.sort()
-        print ' '.join(rv)
-templatetools.handle_additional_parameters(sys.argv, help, shell_completion, usage=usage)
+        allowable_args = OPTIONS.keys()
+    if allowable_args:
+        allowable_args.sort()
+        print ' '.join(allowable_args)
+
+templatetools.handle_additional_parameters(
+    sys.argv, help, shell_completion, usage=usage)
 
 if len(sys.argv) < 2:
-    cmd = commands.get_command('add', 'ubuntu-application')
-    templatetools.usage_error(_("Cannot add, no plugin name provided."), cmd=cmd, template='ubuntu-application')
+    CMD = commands.get_command('add', 'ubuntu-application')
+    templatetools.usage_error(_("Cannot add, no plugin name provided."),
+        cmd=CMD, template='ubuntu-application')
 
-if argv[1] in addable:
-    getattr(store, argv[1]).add(options)
+if sys.argv[1] in ADDABLE:
+    getattr(store, sys.argv[1]).add(OPTIONS)
+elif sys.argv[1] in PLUGINS.keys():
+    insert_plugin(PLUGINS[sys.argv[1]])
 else:
-    cmd = commands.get_command('add', 'ubuntu-application')
-    templatetools.usage_error(_('Cannot add, did not recognize plugin name: %s' % argv[1]), cmd=cmd, template='ubuntu-application')
+    CMD = commands.get_command('add', 'ubuntu-application')
+    templatetools.usage_error(
+        _('Cannot add, did not recognize plugin name: %s' % sys.argv[1]),
+         cmd=CMD, template='ubuntu-application')
     sys.exit(4)
 
=== modified file 'data/templates/ubuntu-application/configure.py'
--- data/templates/ubuntu-application/configure.py	2010-10-18 18:39:04 +0000
+++ data/templates/ubuntu-application/configure.py	2011-05-24 23:28:25 +0000
@@ -82,7 +82,7 @@
     if len(argv) > 2:
         project_name = argv[2]
     else:
-        project_name = quicklyutils.read_input()
+        project_name = templatetools.read_input()
     # need to try and get the original project name if it exists.  We'll need this
     # to replace any existing settings
     if not configurationhandler.project_config:
@@ -158,7 +158,7 @@
         dependencies = [elem.strip() for elem in configurationhandler.project_config['dependencies'].split(',') if elem]
     except KeyError:
         dependencies = []
-    userinput = quicklyutils.read_input('\n'.join(dependencies))
+    userinput = templatetools.read_input('\n'.join(dependencies))
     dependencies = []
     for depends in userinput.split('\n'):
         dependencies.extend([elem.strip() for elem in depends.split(',') if elem])
@@ -174,4 +174,3 @@
         configurationhandler.loadConfig()
     configurationhandler.project_config["target_distribution"] = argv[2]
     configurationhandler.saveConfig()
-
 
=== modified file 'data/templates/ubuntu-application/create.py'
--- data/templates/ubuntu-application/create.py	2011-02-08 14:30:08 +0000
+++ data/templates/ubuntu-application/create.py	2011-05-24 23:28:25 +0000
@@ -90,7 +90,7 @@
             directory = directory.replace('python', python_name)
         os.mkdir(os.path.join(relative_dir, directory))
     for filename in files:
-        quicklyutils.file_from_template(root, filename, relative_dir, substitutions)
+        templatetools.file_from_template(root, filename, relative_dir, substitutions)
 
 # set the mode to executable for executable file 
 exec_file = os.path.join('bin', project_name)
 
=== modified file 'data/templates/ubuntu-application/edit.py'
--- data/templates/ubuntu-application/edit.py	2011-04-27 15:02:41 +0000
+++ data/templates/ubuntu-application/edit.py	2011-05-24 23:28:25 +0000
@@ -65,7 +65,8 @@
 # add helpfile sources
 filelist.extend(glob.glob('help/C/*.page'))
 
-editor = quicklyutils.get_quickly_editors()
+editor = templatetools.get_ide(configurationhandler.project_config['template'])
+
 if templatetools.in_verbose_mode():
     instance = subprocess.Popen([editor] + filelist)
 else:
 
=== modified file 'data/templates/ubuntu-application/internal/apportutils.py'
--- data/templates/ubuntu-application/internal/apportutils.py	2011-04-04 14:28:36 +0000
+++ data/templates/ubuntu-application/internal/apportutils.py	2011-05-24 23:28:25 +0000
@@ -80,13 +80,13 @@
             print _("Creating new apport crashdb configuration")
             if not os.path.isdir(relative_crashdb_dir):
                 os.makedirs(relative_crashdb_dir)
-            quicklyutils.file_from_template(template_crashdb_dir, "project_name-crashdb.conf", relative_crashdb_dir, subst_new)
+            templatetools.file_from_template(template_crashdb_dir, "project_name-crashdb.conf", relative_crashdb_dir, subst_new)
 
         if not os.path.isfile(existing_hook) and os.path.isdir(template_hook_dir):
             print _("Creating new apport hooks")
             if not os.path.isdir(relative_apport_dir):
                 os.makedirs(relative_apport_dir)
-            quicklyutils.file_from_template(template_hook_dir, "source_project_name.py", relative_apport_dir, subst_new)
+            templatetools.file_from_template(template_hook_dir, "source_project_name.py", relative_apport_dir, subst_new)
 
 def insert_lpi_if_required(project_name):
     camel_case_project_name = quickly.templatetools.get_camel_case_name(project_name)
 
=== modified file 'data/templates/ubuntu-application/internal/quicklyutils.py'
--- data/templates/ubuntu-application/internal/quicklyutils.py	2011-03-02 15:04:44 +0000
+++ data/templates/ubuntu-application/internal/quicklyutils.py	2011-05-24 23:28:25 +0000
@@ -43,30 +43,6 @@
     camel_case_name = templatetools.get_camel_case_name(name)
     return sentence_name, camel_case_name
 
-def file_from_template(template_dir, template_file, target_dir, substitutions=[], rename = True):
-
-    if not os.path.isfile(os.path.join(template_dir, template_file)):
-        return
-    target_file = os.path.basename(template_file) # to get only file name (template_file can be internal/file)
-    if rename:
-        for s in substitutions:
-            pattern, sub = s
-            target_file = target_file.replace(pattern,sub)
-
-    fin = open(os.path.join(template_dir, template_file),'r')
-    file_contents = fin.read()
-    for s in substitutions:
-        pattern, sub = s
-        file_contents = file_contents.replace(pattern,sub)
-
-    target_path = os.path.join(target_dir, target_file)
-    if os.path.exists(target_path):
-        print _("Failed to add file to project\n cannot add: %s - this file already exists." % target_path)
-        sys.exit(4)        
-
-    templatetools.set_file_contents(target_path, file_contents)
-    fin.close()
-
 def update_file(target_file, substitutions=[], rename = True):
 
     if not os.path.isfile(target_file):
@@ -229,44 +205,6 @@
             buffered_message +=' %s' % line
     return(changelog)
 
-
-def get_quickly_editors():
-    '''Return prefered editor for ubuntu-application template'''
-
-    default_editor = os.environ.get("QUICKLY_EDITOR")
-    if not default_editor:
-        default_editor = os.environ.get("EDITOR")
-    if not default_editor:
-        default_editor = os.environ.get("SELECTED_EDITOR")
-    if default_editor:
-        editor = default_editor
-    elif templatetools.is_X_display():
-        editor = "gedit"
-    else:
-        editor = "nano"
-    return editor
-
-def read_input(start=''):
-    depfile_name = tempfile.mkstemp()[1]
-    open(depfile_name,'w').write(start)
-
-    # Run the editor with a new tmpdir.  This is because gedit uses tmpdir
-    # to find other instances of gedit, and we don't want that.  If we allowed
-    # that, gedit would return immediately and open a new tab in the other
-    # gedit.  This makes it difficult to tell when user is done editing (how
-    # to detect that vs nano opening and closing without the user saving it?).
-    editor = get_quickly_editors()
-    subenv = dict(os.environ)
-    subenv['TMPDIR'] = tempfile.mkdtemp()
-    subprocess.call([editor, depfile_name], stdout=subprocess.PIPE, env=subenv)
-    os.rmdir(subenv['TMPDIR'])
-
-    # Grab file contents
-    rv = file(depfile_name, 'r').read().strip()
-    os.remove(depfile_name)
-
-    return rv
-
 def take_email_from_string(value):
     '''Try to take an email from a string'''
 
 
=== modified file 'data/templates/ubuntu-application/store/dialog.py'
--- data/templates/ubuntu-application/store/dialog.py	2010-11-12 00:28:53 +0000
+++ data/templates/ubuntu-application/store/dialog.py	2011-05-24 23:28:25 +0000
@@ -109,17 +109,17 @@
                      ("dialog_sentence_name",dialog_sentence_name),
                      ("python_name",python_name))
 
-    quicklyutils.file_from_template(template_ui_dir, 
+    templatetools.file_from_template(template_ui_dir, 
                                     "dialog_camel_case_nameDialog.ui", 
                                     target_ui_dir, 
                                     substitutions)
 
-    quicklyutils.file_from_template(template_ui_dir, 
+    templatetools.file_from_template(template_ui_dir, 
                                     "dialog_python_name_dialog.xml", 
                                     target_ui_dir,
                                     substitutions)
 
-    quicklyutils.file_from_template(template_python_dir, 
+    templatetools.file_from_template(template_python_dir, 
                                     "dialog_camel_case_nameDialog.py", 
                                     target_python_dir, 
                                     substitutions)
 
=== modified file 'data/templates/ubuntu-application/store/help-guide.py'
--- data/templates/ubuntu-application/store/help-guide.py	2010-11-22 16:01:03 +0000
+++ data/templates/ubuntu-application/store/help-guide.py	2011-05-24 23:28:25 +0000
@@ -80,6 +80,6 @@
     ('sentence_name', sentence_name),
     )
 
-    quicklyutils.file_from_template(template_help_dir, 
+    templatetools.file_from_template(template_help_dir, 
                                     'g_u_i_d_e.page', 
                                     target_help_dir, substitutions)
 
=== modified file 'data/templates/ubuntu-application/store/help-topic.py'
--- data/templates/ubuntu-application/store/help-topic.py	2010-11-22 16:01:03 +0000
+++ data/templates/ubuntu-application/store/help-topic.py	2011-05-24 23:28:25 +0000
@@ -83,6 +83,6 @@
     ('sentence_name', sentence_name),
     )
 
-    quicklyutils.file_from_template(template_help_dir, 
+    templatetools.file_from_template(template_help_dir, 
                                     't_o_p_i_c.page', 
                                     target_help_dir, substitutions)
 
=== modified file 'data/templates/ubuntu-application/store/indicator.py'
--- data/templates/ubuntu-application/store/indicator.py	2010-11-22 16:01:03 +0000
+++ data/templates/ubuntu-application/store/indicator.py	2011-05-24 23:28:25 +0000
@@ -59,7 +59,7 @@
     substitutions = (("project_name",project_name),
                     ( "python_name",python_name))
 
-    quicklyutils.file_from_template(template_python_dir, 
+    templatetools.file_from_template(template_python_dir, 
                                     "indicator.py", 
                                     target_python_dir, 
                                     substitutions)
 
=== modified file 'data/templates/ubuntu-application/upgrade.py'
--- data/templates/ubuntu-application/upgrade.py	2011-01-31 21:59:12 +0000
+++ data/templates/ubuntu-application/upgrade.py	2011-05-24 23:28:25 +0000
@@ -150,7 +150,7 @@
     if not os.path.isfile('%s/helpers.py' % python_name) and os.path.isdir(python_name):
         source_dir = os.path.join(os.path.dirname(__file__), 'project_root',
                                   'python')
-        quicklyutils.file_from_template(source_dir, 
+        templatetools.file_from_template(source_dir, 
                                         "helpers.py", 
                                         python_name, 
                                         substitutions)
 
=== modified file 'data/templates/ubuntu-flash-game/create.py'
--- data/templates/ubuntu-flash-game/create.py	2011-01-31 21:12:12 +0000
+++ data/templates/ubuntu-flash-game/create.py	2011-05-24 23:28:25 +0000
@@ -121,7 +121,7 @@
             directory = python_name
         os.mkdir(os.path.join(relative_dir, directory))
     for filename in files:
-        quicklyutils.file_from_template(root, filename, relative_dir, substitutions)
+        templatetools.file_from_template(root, filename, relative_dir, substitutions)
 
 # set the mode to executable for executable file 
 exec_file = os.path.join('bin', project_name)
 
=== modified file 'data/templates/ubuntu-flash-game/internal/apportutils.py'
--- data/templates/ubuntu-flash-game/internal/apportutils.py	2011-01-03 15:07:28 +0000
+++ data/templates/ubuntu-flash-game/internal/apportutils.py	2011-05-24 23:28:25 +0000
@@ -6,6 +6,7 @@
 
 import quickly
 import quicklyutils
+from quickly import templatetools
 
 from lxml import etree
 
@@ -66,18 +67,18 @@
 
         if os.path.isfile(existing_crashdb):
             print _("Updating project name references in existing apport crashdb configuration")
-            quicklyutils.file_from_template(relative_crashdb_dir, crashdb_file, relative_crashdb_dir, subst_existing)
+            templatetools.file_from_template(relative_crashdb_dir, crashdb_file, relative_crashdb_dir, subst_existing)
         elif os.path.isdir(template_crashdb_dir):
             print _("Creating new apport crashdb configuration")
             if not os.path.isdir(relative_crashdb_dir):
                 os.makedirs(relative_crashdb_dir)
-            quicklyutils.file_from_template(template_crashdb_dir, "project_name-crashdb.conf", relative_crashdb_dir, subst_new)
+            templatetools.file_from_template(template_crashdb_dir, "project_name-crashdb.conf", relative_crashdb_dir, subst_new)
 
         if not os.path.isfile(existing_hook) and os.path.isdir(template_hook_dir):
             print _("Creating new apport hooks")
             if not os.path.isdir(relative_apport_dir):
                 os.makedirs(relative_apport_dir)
-            quicklyutils.file_from_template(template_hook_dir, "source_project_name.py", relative_apport_dir, subst_new)
+            templatetools.file_from_template(template_hook_dir, "source_project_name.py", relative_apport_dir, subst_new)
 
 def insert_lpi_if_required(project_name):
     existing_bin_filename = os.path.join("bin",project_name)
 
=== modified file 'data/templates/ubuntu-flash-game/internal/quicklyutils.py'
--- data/templates/ubuntu-flash-game/internal/quicklyutils.py	2011-01-03 15:07:28 +0000
+++ data/templates/ubuntu-flash-game/internal/quicklyutils.py	2011-05-24 23:28:25 +0000
@@ -42,33 +42,6 @@
     camel_case_name = templatetools.get_camel_case_name(name)
     return sentence_name, camel_case_name
 
-def file_from_template(template_dir, template_file, target_dir, substitutions=[], rename = True):
-
-    if not os.path.isfile(os.path.join(template_dir, template_file)):
-        return
-    target_file = os.path.basename(template_file) # to get only file name (template_file can be internal/file)
-    if rename:
-        for s in substitutions:
-            pattern, sub = s
-            target_file = target_file.replace(pattern,sub)
-
-    fin = open(os.path.join(template_dir, template_file),'r')
-    file_contents = fin.read()
-    for s in substitutions:
-        pattern, sub = s
-        file_contents = file_contents.replace(pattern,sub)
-
-    target_path = os.path.join(target_dir, target_file)
-    if os.path.exists(target_path):
-        print _("Failed to add file to project\n cannot add: %s - this file already exists." % target_path)
-        sys.exit(4)        
-
-    fout = open(target_path, 'w')
-    fout.write(file_contents)
-    fout.flush()
-    fout.close()
-    fin.close()
-
 def get_setup_value(key):
     """ get value from setup.py file.
     
@@ -209,19 +182,6 @@
             buffered_message +=' %s' % line
     return(changelog)
 
-
-def get_quickly_editors():
-    '''Return prefered editor for ubuntu-application template'''
-
-    editor = "gedit"
-    default_editor = os.environ.get("EDITOR")
-    if not default_editor:
-        default_editor = os.environ.get("SELECTED_EDITOR")
-    if default_editor:
-       editor = default_editor
-    return editor
-
-
 def take_email_from_string(value):
     '''Try to take an email from a string'''
 
 
=== modified file 'quickly/builtincommands.py'
--- quickly/builtincommands.py	2010-11-29 15:18:46 +0000
+++ quickly/builtincommands.py	2011-05-24 23:28:25 +0000
@@ -15,8 +15,10 @@
 #You should have received a copy of the GNU General Public License along 
 #with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import ConfigParser
 import os
 import shutil
+import StringIO
 import sys
 
 import configurationhandler
@@ -211,7 +213,37 @@
         os.rename(filedest.name, commandsconfig_path)
     return 0
 
-
+help_preferences = _("Edit developers preferences")
+usage_preferences = _("Usage: quickly preferences")
+def preferences(project_template, project_dir, command_args, shell_completion=False):
+    """Configure preferences"""
+
+    # We have nothing for this
+    if shell_completion:
+        return("")
+
+    preferences = templatetools.get_preferences()
+    
+    #convert preferences into editable contents
+    fp_current = StringIO.StringIO()
+    # TODO use a pretty printer
+    preferences.write(fp_current)
+    contents = fp_current.getvalue()
+    fp_current.close()
+
+    # ask developer to edit the contents
+    newcontents = templatetools.read_input(contents)
+
+    # convert the contents back into a ConfigParser object
+    newIO = StringIO.StringIO(newcontents)
+    new_preferences = ConfigParser.SafeConfigParser()
+    # an exception here reject bad edits
+    new_preferences.readfp(newIO)
+
+    templatetools.set_preferences(new_preferences)
+
+
+    return 0
 
 # here, special builtin commands properties (if nothing specified, commands can be launched inside and outside projects)
 launched_inside_project_only = []
 
=== modified file 'quickly/templatetools.py'
--- quickly/templatetools.py	2010-12-20 20:33:12 +0000
+++ quickly/templatetools.py	2011-05-24 23:28:25 +0000
@@ -15,15 +15,20 @@
 #You should have received a copy of the GNU General Public License along
 #with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import ConfigParser
 import os
 import stat
 import string
+import subprocess
 import sys
 import re
+import tempfile
 
 import gettext
 from gettext import gettext as _
 
+import glib
+
 import configurationhandler
 import tools
 import quicklyconfig
@@ -256,3 +261,116 @@
         print_command_candidates(template)
     sys.exit(4)
 
+def get_preferences():
+    'parse ~/.config/quickly/preferences for configuration'
+
+    # fill in defaults
+    defaults = {}
+    defaults['plugin_path'] = '/usr/share/pyshared/quickly/widgets'
+    defaults['#plugin_path'] = 'files which can be used with quickly add command'
+    
+    ide = get_quickly_editors()
+    defaults['ide'] = get_quickly_editors()
+    defaults['#ide'] = 'editor defined in environment'
+
+    preferences = ConfigParser.RawConfigParser(defaults)
+
+    # ensure there is a section for each template
+    template_names = commands.get_all_templates()
+    for template_name in template_names:
+        preferences.add_section(template_name)
+
+    config_dir = os.path.join(glib.get_user_config_dir(), 'quickly')
+    config_file = os.path.join(config_dir, 'preferences')
+    preferences.read(config_file)
+
+    return preferences
+
+def set_preferences(new_preferences):
+    'write ~/.config/quickly/preferences'
+
+    config_dir = os.path.join(glib.get_user_config_dir(), 'quickly')
+    config_file = os.path.join(config_dir, 'preferences')
+
+    # ensure config_dir exists
+    if not os.path.isdir(config_dir):
+        os.makedirs(config_dir)
+
+    # write the preferences file
+    with open(config_file, 'w') as fp:
+        new_preferences.write(fp)
+
+def get_quickly_editors():
+    '''Return prefered editor for any template'''
+
+    default_editor = os.environ.get("QUICKLY_EDITOR")
+    if not default_editor:
+        default_editor = os.environ.get("EDITOR")
+    if not default_editor:
+        default_editor = os.environ.get("SELECTED_EDITOR")
+    if default_editor:
+        editor = default_editor
+    elif is_X_display():
+        editor = "gedit"
+    else:
+        editor = "nano"
+    return editor
+
+def read_input(start=''):
+    depfile_name = tempfile.mkstemp()[1]
+    open(depfile_name,'w').write(start)
+
+    # Run the editor with a new tmpdir.  This is because gedit uses tmpdir
+    # to find other instances of gedit, and we don't want that.  If we allowed
+    # that, gedit would return immediately and open a new tab in the other
+    # gedit.  This makes it difficult to tell when user is done editing (how
+    # to detect that vs nano opening and closing without the user saving it?).
+    editor = get_quickly_editors()
+    subenv = dict(os.environ)
+    subenv['TMPDIR'] = tempfile.mkdtemp()
+    subprocess.call([editor, depfile_name], stdout=subprocess.PIPE, env=subenv)
+    os.rmdir(subenv['TMPDIR'])
+
+    # Grab file contents
+    rv = file(depfile_name, 'r').read().strip()
+    os.remove(depfile_name)
+
+    return rv
+
+def get_ide(template):
+    '''Return prefered editor for specified template'''
+    preferences = get_preferences()
+    
+    if preferences.has_option(template, 'ide'):
+        return preferences.get(template, 'ide')
+    else:
+        return get_quickly_editors()
+
+def option(template, option):
+    '''Return prefered option for specified template'''
+    preferences = get_preferences()
+    return preferences.get(template, option)
+
+def file_from_template(template_dir, template_file, target_dir, substitutions=[], rename = True):
+
+    if not os.path.isfile(os.path.join(template_dir, template_file)):
+        return
+    target_file = os.path.basename(template_file) # to get only file name (template_file can be internal/file)
+    if rename:
+        for s in substitutions:
+            pattern, sub = s
+            target_file = target_file.replace(pattern,sub)
+
+    fin = open(os.path.join(template_dir, template_file),'r')
+    file_contents = fin.read()
+    for s in substitutions:
+        pattern, sub = s
+        file_contents = file_contents.replace(pattern,sub)
+
+    target_path = os.path.join(target_dir, target_file)
+    if os.path.exists(target_path):
+        print _("Failed to add file to project\n cannot add: %s - this file already exists." % target_path)
+        sys.exit(4)        
+
+    set_file_contents(target_path, file_contents)
+    fin.close()