pysitegen 1.2.0

A tiny Python-authored static site generator for terminal-inspired static web pages.

PySiteGen

Python-authored static sites.

PySiteGen is a small static site generator for people who would rather compose HTML with Python without any runtime server, client framework, or hidden build graph. PySiteGen gives you primitives. The default visual taste is just a theme layer with terminal-dark aesthetics. It is practical. You write Python functions that return HTML nodes. PySiteGen renders them to static HTML and copies the assets you explicitly ask for. It produces plain files:

public/
  index.html
  assets/
  favicon.png
  robots.txt

Works for docs sites, small product or project pages, personal sites, link hubs, simple SPA-style hash routes, and static pages that benefit from Python data and composition.

Install

python -m pip install pysitegen
pysitegen --version

Start A Site

pysitegen init my-site
cd my-site
pysitegen serve

serve builds once, watches your site files, rebuilds when they change, and reloads the browser tab automatically.

A Page

from pysitegen import a, default_dark, h1, p, page, section

def build():
    return page(
        section(
            p("PySiteGen", class_="eyebrow"),
            h1("Hello from Python."),
            p("This is a static page generated from Python primitives.", class_="muted"),
            a("Read more", href="#more", class_="button primary"),
            class_="container stack",
        ),
        title="Hello",
        description="A PySiteGen page.",
        theme=default_dark(),
    )

Build it and serve it:

pysitegen build
pysitegen serve --host 127.0.0.1 --port 8000

Use pysitegen serve --no-reload when you want the plain static server.

Optional Visual Runtime

PySiteGen can load the !Substrate canvas engine from the CDN for procedural backgrounds. It is not part of the default theme and is only loaded when a page opts in with canvas_background().

from pysitegen import canvas_background, page, visual_canvas, visual_scene

scene = visual_scene(
    "background",
    ("grid", {"spacing": 96}),
    ("nodes", {"count": 24}),
)

page(
    visual_canvas(scene, id="hero-canvas", fps=0, class_="hero-visual"),
    title="Visual",
    behaviors=[canvas_background()],
)

This feature requires the generated page to be online when it loads, because the canvas engine is fetched from the CDN.

This Repo

This repository contains the package source, tests, and the real PySiteGen website:

src/pysitegen/  package source and bundled framework assets
tests/          fixture-based behavior tests
website/        PySiteGen website source

Develop locally:

python -m pip install -e .[dev]
python -m pytest

Build and serve the website:

cd website
pysitegen build
pysitegen serve --host 127.0.0.1 --port 8000

Do not edit website/public/ as source.

Current Limits

PySiteGen is small on purpose.

• The Markdown parser is intentionally limited.
• There is no template/layout system yet.
• There is no plugin system.
• The default theme is useful, not universal.
• The API is still young.