Merge lp:~barry/quickly/585617-userdirs into lp:quickly

[Barry Warsaw]

Add support for $QUICKLY_TEMPLATES environment variable for user defined template directories.

[John C Barstow (jbowtie)]

This looks like a reasonable implementation. I would be happier if there was some documentation included as part of the patch.

[Barry Warsaw (barry)]

Good point. It's not beautiful (manpages are not my favorite thing to write :), but here's an updated quickly.1 that documents $QUICKLY_TEMPLATES

r509

[lp:~barry/quickly/585617-userdirs]

509. By Barry Warsaw on 2010-05-26

Add an ENVIRONMENT section describing $QUICKLY and $QUICKLY_TEMPLATES

[John C Barstow (jbowtie)]

Looks good to me. Hopefully Didier and Rick agree.

review: Approve

[Didier Roche-Tolomelli (didrocks)]

For a more generic approach (in any case, I'll merge it next week as I want to branch 0.4.3 first and this will land in 0.6), can you remove my two lines:
     if os.path.exists(os.path.expanduser('~/quickly-templates')):
          template_directories.append(os.path.expanduser('~/quickly-templates'))

and prepend QUICKLY_TEMPLATE by ~/quickly-template please? (just to have a common template path detection code). If you don't have the time to do it, I'll do it when merging :)

Thanks a lot Barry!

review: Needs Fixing

[Barry Warsaw (barry)]

Hi Didier, sorry I don't quite understand. Do you mean you want to remove the hardcoding of ~/quickly-templates and just let the environment variable define it? I'm not sure what you mean by "prepend QUICKLY_TEMPLATE by ~/quickly-template"; do you intend for there to be no user-specific template path unless they modify their environment?

[Didier Roche-Tolomelli (didrocks)]

No, just remove:
32 if os.path.exists(os.path.expanduser('~/quickly-templates')):
33 template_directories.append(os.path.expanduser('~/quickly-templates'))

And replace:
36 + user_paths = os.environ.get('QUICKLY_TEMPLATES')
37 + if user_paths is not None:

by:
user_paths = os.environ.get('QUICKLY_TEMPLATES')
user_paths = '~/quickly-templates:' + user_paths

so that the code to insert an template template path is common.

[lp:~barry/quickly/585617-userdirs]

510. By Barry Warsaw on 2010-05-28

As per comment on merge proposal, use a common path for adding
~/quickly-templates

[Barry Warsaw (barry)]

On May 28, 2010, at 06:47 AM, Didier Roche wrote:

>No, just remove:
>32 if os.path.exists(os.path.expanduser('~/quickly-templates')):
>33 template_directories.append(os.path.expanduser('~/quickly-templates'))
>
>And replace:
>36 + user_paths = os.environ.get('QUICKLY_TEMPLATES')
>37 + if user_paths is not None:
>
>by:
>user_paths = os.environ.get('QUICKLY_TEMPLATES')
>user_paths = '~/quickly-templates:' + user_paths
>
>so that the code to insert an template template path is common.

I see now, thanks. r510 in my branch has a slightly modified approach.

[Didier Roche-Tolomelli (didrocks)]

Sweet, I'll merge in 0.5.X branch as soon as 0.4.3 is out!
Thanks a lot Barry

review: Approve

=== modified file 'quickly.1'
--- quickly.1	2010-02-18 16:04:34 +0000
+++ quickly.1	2010-05-28 17:28:31 +0000
@@ -90,8 +90,18 @@
 Get some help on a command. If no template is provided and you are outside any quickly project, you are only able to get some help from builtin commands.
 If you specify a template (or use quickly help -t template command, or you are in a quickly project directory), you will get some help from the current template context.
 
-.SH NOTES
-\fBQUICKLY\fP environment variable can contain multiple tags. The separator is \fB":"\fP.
-.P
-For instance: \fBQUICKLY=staging:verbose\fP
+.SH ENVIRONMENT
+
+.TP
+.B QUICKLY
+The \fBQUICKLY\fP environment variable can contain multiple tags. The separator is \fB":"\fP.
+
+For example: \fBQUICKLY=staging:verbose\fP
+
+.TP
+.B QUICKLY_TEMPLATES
+This variable contains additional template paths, separated by \fB":"\fP much
+like the \fBPATH\fP environment variable.
+
+E.g.: \fBQUICKLY_TEMPLATES=/home/foo/.quickly/templates:/home/foo/projects/mynewtemplate\fP
 

=== modified file 'quickly/tools.py'
--- quickly/tools.py	2010-03-28 17:45:12 +0000
+++ quickly/tools.py	2010-05-28 17:28:31 +0000
@@ -95,8 +95,14 @@
     # default to looking up templates in the current dir
     invalid_data_path = None
     template_directories = []
-    if os.path.exists(os.path.expanduser('~/quickly-templates')):
-        template_directories.append(os.path.expanduser('~/quickly-templates'))
+
+    # Add user defined, and hard-coded template directories.
+    user_paths = os.environ.get('QUICKLY_TEMPLATES', '').split(':')
+    user_paths.insert(0, '~/quickly-templates')
+    for path in user_paths:
+        path = os.path.expanduser(path)
+        if os.path.exists(path):
+            template_directories.append(path)
 
     # retrieve from trunk or installed version
     try: