Add dual dev/publish modes to quickstart script

Certain configuration options are more useful in production than they
are in development. Some examples might be absolute URLs, external
analytics service identifiers, Disqus comments, etc. This version of the
quickstart script creates two configuration files: one for development
and the other for use when publishing. In addition, the related docs
have been expanded considerably. Last but not least, the quickstart
script will now detect whether there is a project folder associated with
the currently active virtualenv (if any) and use it by default.

pelican/tools/pelican_quickstart.py

@@ -24,6 +24,7 @@ CONF = {
     'ssh_target_dir': '/var/www',
     'dropbox_dir' : '~/Dropbox/Public/',
     'default_pagination' : 10,
+    'siteurl': '',
     'lang': 'en'
 }
 
@@ -138,35 +139,44 @@ Please answer the following questions so this script can generate the files need
 
     '''.format(v=__version__))
 
-    CONF['basedir'] = os.path.abspath(ask('Where do you want to create your new web site?', answer=str, default=args.path))
+    project = os.path.join(os.environ['VIRTUAL_ENV'], '.project')
+    if os.path.isfile(project):
+        CONF['basedir'] = open(project, 'r').read().rstrip("\n")
+        print('Using project associated with current virtual environment. Will save to:\n%s\n' % CONF['basedir'])
+    else:
+        CONF['basedir'] = os.path.abspath(ask('Where do you want to create your new web site?', answer=str, default=args.path))
+
     CONF['sitename'] = ask('What will be the title of this web site?', answer=str, default=args.title)
     CONF['author'] = ask('Who will be the author of this web site?', answer=str, default=args.author)
-    CONF['lang'] = ask('What will be the default language of this web site ?', str, args.lang or CONF['lang'], 2)
+    CONF['lang'] = ask('What will be the default language of this web site?', str, args.lang or CONF['lang'], 2)
 
-    CONF['with_pagination'] = ask('Do you want to enable article pagination ?', bool, bool(CONF['default_pagination']))
+    if ask('Do you want to specify a URL prefix? e.g., http://example.com  ', answer=bool, default=True):
+        CONF['siteurl'] = ask('What is your URL prefix? (see above example; no trailing slash)', str, CONF['siteurl'])
+
+    CONF['with_pagination'] = ask('Do you want to enable article pagination?', bool, bool(CONF['default_pagination']))
 
     if CONF['with_pagination']:
         CONF['default_pagination'] = ask('How many articles per page do you want?', int, CONF['default_pagination'])
     else:
         CONF['default_pagination'] = False
 
-    mkfile = ask('Do you want to generate a Makefile to easily manage your website ?', bool, True)
+    mkfile = ask('Do you want to generate a Makefile to easily manage your website?', bool, True)
 
     if mkfile:
-        if ask('Do you want to upload your website using FTP ?', answer=bool, default=False):
-            CONF['ftp_host'] = ask('What is the hostname of your FTP server ?', str, CONF['ftp_host'])
+        if ask('Do you want to upload your website using FTP?', answer=bool, default=False):
+            CONF['ftp_host'] = ask('What is the hostname of your FTP server?', str, CONF['ftp_host'])
             CONF['ftp_user'] = ask('What is your username on that server?', str, CONF['ftp_user'])
             CONF['ftp_target_dir'] = ask('Where do you want to put your web site on that server?', str, CONF['ftp_target_dir']) 
-        if ask('Do you want to upload your website using SSH ?', answer=bool, default=False):
-            CONF['ssh_host'] = ask('What is the hostname of your SSH server ?', str, CONF['ssh_host'])
+        if ask('Do you want to upload your website using SSH?', answer=bool, default=False):
+            CONF['ssh_host'] = ask('What is the hostname of your SSH server?', str, CONF['ssh_host'])
             CONF['ssh_port'] = ask('What is the port of your SSH server?', int, CONF['ssh_port'])
             CONF['ssh_user'] = ask('What is your username on that server?', str, CONF['ssh_user'])
             CONF['ssh_target_dir'] = ask('Where do you want to put your web site on that server?', str, CONF['ssh_target_dir'])
-        if ask('Do you want to upload your website using Dropbox ?', answer=bool, default=False):
-            CONF['dropbox_dir'] = ask('Where is your Dropbox directory ?', str, CONF['dropbox_dir'])
+        if ask('Do you want to upload your website using Dropbox?', answer=bool, default=False):
+            CONF['dropbox_dir'] = ask('Where is your Dropbox directory?', str, CONF['dropbox_dir'])
 
     try:
-        os.makedirs(os.path.join(CONF['basedir'], 'src'))
+        os.makedirs(os.path.join(CONF['basedir'], 'content'))
     except OSError, e:
         print('Error: {0}'.format(e))
 
@@ -176,8 +186,17 @@ Please answer the following questions so this script can generate the files need
         print('Error: {0}'.format(e))
 
     try:
-        with open(os.path.join(CONF['basedir'], 'pelican.conf.py'), 'w') as fd:
-            for line in get_template('pelican.conf.py'):
+        with open(os.path.join(CONF['basedir'], 'pelicanconf.py'), 'w') as fd:
+            for line in get_template('pelicanconf.py'):
+                template = string.Template(line)
+                fd.write(template.safe_substitute(CONF))
+            fd.close()
+    except OSError, e:
+        print('Error: {0}'.format(e))
+
+    try:
+        with open(os.path.join(CONF['basedir'], 'publishconf.py'), 'w') as fd:
+            for line in get_template('publishconf.py'):
                 template = string.Template(line)
                 fd.write(template.safe_substitute(CONF))
             fd.close()

pelican/tools/templates/Makefile.in

@@ -2,9 +2,10 @@ PELICAN=$pelican
 PELICANOPTS=$pelicanopts
 
 BASEDIR=$$(PWD)
-INPUTDIR=$$(BASEDIR)/src
+INPUTDIR=$$(BASEDIR)/content
 OUTPUTDIR=$$(BASEDIR)/output
-CONFFILE=$$(BASEDIR)/pelican.conf.py
+CONFFILE=$$(BASEDIR)/pelicanconf.py
+PUBLISHCONF=$$(BASEDIR)/publishconf.py
 
 FTP_HOST=$ftp_host
 FTP_USER=$ftp_user
@@ -23,10 +24,11 @@ help:
 	@echo 'Usage:                                                                 '
 	@echo '   make html                        (re)generate the web site          '
 	@echo '   make clean                       remove the generated files         '
-	@echo '   ftp_upload                       upload the web site using FTP      '
-	@echo '   ssh_upload                       upload the web site using SSH      '
-	@echo '   dropbox_upload                   upload the web site using Dropbox  '
-	@echo '   rsync_upload                     upload the web site using rsync/ssh'
+	@echo '   make publish                     generate using production settings '
+	@echo '   ftp_upload                       upload the web site via FTP        '
+	@echo '   ssh_upload                       upload the web site via SSH        '
+	@echo '   dropbox_upload                   upload the web site via Dropbox    '
+	@echo '   rsync_upload                     upload the web site via rsync/ssh  '
 	@echo '                                                                       '
 
 
@@ -37,23 +39,31 @@ $$(OUTPUTDIR)/%.html:
 	$$(PELICAN) $$(INPUTDIR) -o $$(OUTPUTDIR) -s $$(CONFFILE) $$(PELICANOPTS)
 
 clean:
-	rm -fr $$(OUTPUTDIR)
-	mkdir $$(OUTPUTDIR)
+	find $$(OUTPUTDIR) -mindepth 1 -delete
 
-dropbox_upload: $$(OUTPUTDIR)/index.html
+regenerate: clean
+	$$(PELICAN) -r $$(INPUTDIR) -o $$(OUTPUTDIR) -s $$(CONFFILE) $$(PELICANOPTS)
+
+serve:
+	cd $$(OUTPUTDIR) && python -m SimpleHTTPServer
+
+publish:
+	$$(PELICAN) $$(INPUTDIR) -o $$(OUTPUTDIR) -s $$(PUBLISHCONF) $$(PELICANOPTS)
+
+dropbox_upload: publish
 	cp -r $$(OUTPUTDIR)/* $$(DROPBOX_DIR)
 
-ssh_upload: $$(OUTPUTDIR)/index.html
+ssh_upload: publish
 	scp -P $$(SSH_PORT) -r $$(OUTPUTDIR)/* $$(SSH_USER)@$$(SSH_HOST):$$(SSH_TARGET_DIR)
 
-rsync_upload: $$(OUTPUTDIR)/index.html
+rsync_upload: publish
 	rsync -e "ssh -p $(SSH_PORT)" -P -rvz --delete $(OUTPUTDIR)/* $(SSH_USER)@$(SSH_HOST):$(SSH_TARGET_DIR)
 
-ftp_upload: $$(OUTPUTDIR)/index.html
+ftp_upload: publish
 	lftp ftp://$$(FTP_USER)@$$(FTP_HOST) -e "mirror -R $$(OUTPUTDIR) $$(FTP_TARGET_DIR) ; quit"
 
-github: $$(OUTPUTDIR)/index.html
+github: publish
 	ghp-import $$(OUTPUTDIR)
 	git push origin gh-pages
 
-.PHONY: html help clean ftp_upload ssh_upload rsync_upload dropbox_upload github
+.PHONY: html help clean regenerate serve publish ftp_upload ssh_upload rsync_upload dropbox_upload github

pelican/tools/templates/publishconf.py.in

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*- #
+
+from pelicanconf import *
+
+SITEURL = '$siteurl'
+
+DELETE_OUTPUT_DIRECTORY = True
+
+# Following items are often useful when publishing
+
+# Uncomment following line for absolute URLs in production:
+#RELATIVE_URLS = False
+
+#DISQUS_SITENAME = ""
+#GOOGLE_ANALYTICS = ""
+