Springheel

7.0.2 verified Sat May 09 auth: no python

Springheel is a static site generator specifically designed for webcomics. It helps comic artists manage pages, generate HTML templates, and deploy static sites. The current version is 7.0.2, with maintenance releases. Release cadence is irregular.

pip install springheel

Common errors

error ModuleNotFoundError: No module named 'springheel' ↓

cause Springheel is not installed or installed in a different virtual environment.

fix

Run 'pip install springheel' in the active environment.

error ImportError: cannot import name 'PageBuilder' from 'springheel' ↓

cause PageBuilder is not a top-level export; need to import from submodule.

fix

Use 'from springheel.builder import PageBuilder'.

error springheel.builder.SpringheelBuildError: Config file 'comic.yaml' not found ↓

cause Old config filename 'comic.yaml' is no longer supported.

fix

Rename file to 'springheel.yaml' or use SpringheelConfig programmatically.

Warnings

breaking Version 7.0 introduced a new configuration format; old 'comic.yaml' files are no longer supported. Use 'springheel.yaml' or programmatic SpringheelConfig. ↓

fix Migrate config to use SpringheelConfig object or springheel.yaml with new schema.

gotcha The PageBuilder.build() method overwrites the entire output directory. Back up any custom content in the output dir. ↓

fix Set a separate output directory or back up before building.

deprecated The 'theme' parameter in config is deprecated as of 7.0. Use 'template_dir' instead. ↓

fix Replace theme='...' with template_dir='.../templates' in config.

Imports

PageBuilder

wrong

from springheel import PageBuilder

correct

from springheel.builder import PageBuilder

PageBuilder is in the builder submodule, not top-level.

SpringheelConfig
wrong
```
from springheel import Config
```
correct
```
from springheel.config import SpringheelConfig
```
The config class is named SpringheelConfig in the config module.

Quickstart

Initialize a PageBuilder with a SpringheelConfig and call build() to generate the static site.

from springheel.builder import PageBuilder
from springheel.config import SpringheelConfig

config = SpringheelConfig(
    comic_name="My Comic",
    source_dir="pages",
    output_dir="site"
)
builder = PageBuilder(config)
builder.build()