generateSite.py

#! python3

# Generates the Automate the Boring Stuff site from the jinja2 templates.

import os
import logging
import shelve
import sys
import distutils.dir_util
import jinja2

GENERATE_ALL = False # If True, all templates are generated regardless if timestamp says they are up to date
if len(sys.argv) > 1:
    GENERATE_ALL = sys.argv[1] == 'all'

logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')
logging.debug('Started.')
#logging.disable(logging.CRITICAL)

# if the output folder has been deleted, completely delete the old shelf folder so that everything is generated.
if not os.path.exists('output'):
    for shelfFile in [f for f in os.listdir('.') if f.startswith('.templateTimestamps')]:
        os.unlink(shelfFile)

timestampsShelf = shelve.open('.templateTimestamps')

env = jinja2.Environment(loader=jinja2.FileSystemLoader(['templates', os.path.dirname(__file__)]))

renderCount = 0

# Render all the templates and place them in the output folder
os.makedirs('output', exist_ok=True)
for dirpath, dirnames, filenames in os.walk('content'):
    for filename in filenames:
        if not filename.endswith('.html'):
            continue # skip non-template files

        templateFilename = os.path.join(dirpath, filename).replace('\\', '/') # Jinja REQUIRES unix-style separators :P
        if not GENERATE_ALL and (templateFilename in timestampsShelf and timestampsShelf[templateFilename] >= os.path.getmtime(templateFilename)):
            #logging.debug('%s is up to date. Skipping.' % (templateFilename))
            continue # not new. skip it

        timestampsShelf[templateFilename] = os.path.getmtime(templateFilename)

        outputFolder = os.path.join('output', dirpath[len('content' + os.path.sep):])
        os.makedirs(outputFolder, exist_ok=True)
        outputFilename = os.path.join('output', dirpath[len('content' + os.path.sep):], filename)
        logging.debug('Rendering and writing %s...' % (outputFilename))

        # Render the template
        print(templateFilename)
        t = env.get_template(templateFilename)

        # Write the template to the output folder
        outputFo = open(outputFilename, 'w', encoding='UTF-8')
        outputFo.write(t.render())
        outputFo.close()

        renderCount += 1

logging.debug('%s templates rendered.' % (renderCount))

# Copy the static folder to the output folder
logging.debug('Copying static files...')
distutils.dir_util.copy_tree('static', 'output', update=True)

logging.debug('Done.')