pelican

library4.12.0pypypi✓ verified 83d ago

Pelican is a static site generator written in Python. It supports Markdown and reStructuredText content, offers theming via Jinja2 templates, and generates static HTML files suitable for deployment on GitHub Pages, Netlify, etc. Current version is 4.12.0, with releases roughly twice a year.

web-framework serialization

pip install pelican

github ↗package ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · PELICAN

pelican

web-frameworkpythonv4.12.0

Install

4.3s avg

Import

897ms

Disk

48MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v4.11.0.post0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.925s · 48.2MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 4.3s · import 0.868s · 48MB

48MB installed

● package 48MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Pelican

✓ from pelican import Pelican

✗ import pelican

Pelican is a class; direct import of the module doesn't give access to the main class.

read_settings

✓ from pelican.settings import read_settings

Generator

✓ from pelican.generators import Generator

Basic usage: read settings from a configuration file and run Pelican to generate the site.

from pelican import Pelican from pelican.settings import read_settings settings = read_settings('pelicanconf.py') pelican = Pelican(settings) pelican.run() # Or use the command line: # pelican content -s pelicanconf.py -o output

pelican --version

Debug

Known issues

breakingPelican dropped support for Python 3.8 in version 4.12.0. Python 3.11 or later is required.

fix

Upgrade to Python 3.11+.

affects: >=4.12.0

deprecatedThe `pelican-quickstart` script is deprecated and may be removed in a future release. Use `pelican quickstart` subcommand instead.

fix

Replace `pelican-quickstart` with `pelican quickstart`.

affects: >=4.10.0

gotchaSettings are case-sensitive. Common mistake: using `SITEURL` instead of `SITEURL` (correct), but many users misspell it.

fix

Check your pelicanconf.py for correct spelling of settings.

affects: all

gotchaIf you upgrade from Pelican < 4.10 to >= 4.10, the default summary generation changed: `SUMMARY_MAX_PARAGRAPHS` now defaults to None (full content), and `SUMMARY_MAX_LENGTH` also changed. Check your summaries.

fix

Explicitly set `SUMMARY_MAX_PARAGRAPHS` and `SUMMARY_MAX_LENGTH` in your config if you rely on them.

affects: >=4.10.0

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'pelican'

Pelican is not installed in the current Python environment.

fix

Run `pip install pelican`.

TypeError: 'NoneType' object is not callable

Often caused by a misconfigured `PAGE_ORDER_BY` or `ARTICLE_ORDER_BY` setting that references a nonexistent metadata field.

fix

Verify that the order key exists in all your pages/articles or set a default.

pelican: error: unrecognized arguments: -r -l

The `-r` (auto-reload) and `-l` (launch server) flags were merged into `--autoreload` or `-r` in Pelican 4.10+.

fix

Use `pelican -r -l` still works, but if you see this error, update Pelican. Alternatively use `pelican --autoreload --listen`.

Upgrade

Version history

4.12.0latest on PyPI · released Apr 20, 2026

Audit

Dependencies

markdownoptionalRequired to process Markdown content

docutilsoptionalRequired to process reStructuredText content

jinja2requiredTemplating engine used by Pelican themes

pygmentsoptionalSyntax highlighting for code blocks in generated content

Agent activity

16 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/getpelican/pelican ↗

packagehttps://pypi.org/project/pelican/ ↗

homepagehttps://getpelican.com ↗

docshttps://docs.getpelican.com ↗