{"id":28288,"library":"springheel","title":"Springheel","description":"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.","status":"active","version":"7.0.2","language":"python","source_language":"en","source_url":"https://github.com/springheel/springheel","tags":["static-site-generator","webcomics","comic","builder"],"install":[{"cmd":"pip install springheel","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"PageBuilder is in the builder submodule, not top-level.","wrong":"from springheel import PageBuilder","symbol":"PageBuilder","correct":"from springheel.builder import PageBuilder"},{"note":"The config class is named SpringheelConfig in the config module.","wrong":"from springheel import Config","symbol":"SpringheelConfig","correct":"from springheel.config import SpringheelConfig"}],"quickstart":{"code":"from springheel.builder import PageBuilder\nfrom springheel.config import SpringheelConfig\n\nconfig = SpringheelConfig(\n    comic_name=\"My Comic\",\n    source_dir=\"pages\",\n    output_dir=\"site\"\n)\nbuilder = PageBuilder(config)\nbuilder.build()","lang":"python","description":"Initialize a PageBuilder with a SpringheelConfig and call build() to generate the static site."},"warnings":[{"fix":"Migrate config to use SpringheelConfig object or springheel.yaml with new schema.","message":"Version 7.0 introduced a new configuration format; old 'comic.yaml' files are no longer supported. Use 'springheel.yaml' or programmatic SpringheelConfig.","severity":"breaking","affected_versions":"<7.0 to >=7.0"},{"fix":"Set a separate output directory or back up before building.","message":"The PageBuilder.build() method overwrites the entire output directory. Back up any custom content in the output dir.","severity":"gotcha","affected_versions":"all"},{"fix":"Replace theme='...' with template_dir='.../templates' in config.","message":"The 'theme' parameter in config is deprecated as of 7.0. Use 'template_dir' instead.","severity":"deprecated","affected_versions":">=7.0"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"Run 'pip install springheel' in the active environment.","cause":"Springheel is not installed or installed in a different virtual environment.","error":"ModuleNotFoundError: No module named 'springheel'"},{"fix":"Use 'from springheel.builder import PageBuilder'.","cause":"PageBuilder is not a top-level export; need to import from submodule.","error":"ImportError: cannot import name 'PageBuilder' from 'springheel'"},{"fix":"Rename file to 'springheel.yaml' or use SpringheelConfig programmatically.","cause":"Old config filename 'comic.yaml' is no longer supported.","error":"springheel.builder.SpringheelBuildError: Config file 'comic.yaml' not found"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}