genhtml — Static HTML Inserts for Website Files

New: as of June 2017, genhtml now handles ".*" Mac/Unix cruft files in inserts and templates folders. This includes both ".DS_Store" Finder files, and any "._*" AppleDouble resource-fork files on non-Mac drives. Both are skipped in inserts to avoid errors, but are simply copied like other non-HTML in templates because more may pop up before publication—filter later with your zip or upload tools (e.g., ziptools).

See the new script's docstring for details. For a quick example of genhtml at work, see also the template file for the page you are viewing, and its genhtml expansion. There are also new example site-publisher master scripts here and here that use genhtml as a nested tool, and are used to publish the website you are viewing.

Overview

This Python 3.X program provides basic HTML macro functionality. It replaces keys in a folder's HTML-template files with the content of correspondingly named insert files. The net effect automatically updates static web pages when any common content they share is changed. Among its features, this program has:

Automatic dependency tracking
HTML files are regenerated whenever—and only when—their templates or any inserts they use have changed
Configurable Unicode support
Encodings in a sequence are tried in turn for each HTML template file
One-level nested inserts
Insert files can insert other insert files for added flexibility
Automatic generation-date insertion
Built-in date keys support multiple formats

This script addresses only static content: common text that can change over time, but need not be generated on each new page request. For such content, though, this program is a simple alternative to:

Besides its utility, this program uses and requires only Python 3.X, runs on any platform that Python 3.X supports, and illustrates a typical role for Python code.

Resources

See the main script's docstring and other items below for usage details.

Code and docs:

Example:

Usage:

Download

Use the following to fetch genhtml, or view its unzipped content.

This program was last changed: September 2018.

For more code examples, see the programs page.



[Home] Books Programs Blog Python Author Training Search Email ©M.Lutz