pelican_stat

Generate Pelican article statistics from the command line or expose them to Pelican themes and content through a plugin.

Getting Started

Prerequisites

• uv tool

Pelican plugin

Install pelican_stat in the same environment as your Pelican site:

uv add pelican_stat

Then enable the plugin in pelicanconf.py:

PLUGINS = [
    "pelican.plugins.stat",
]

The plugin adds these values to the template context:

• pelican_stat_word_count: a mapping containing post_count, cjk_char_count, english_word_count, total_char_count, writing_years, average_chars_per_article, and median_chars_per_article.
• pelican_stat_trend_plot_html: a Plotly HTML fragment. Render it with the Jinja safe filter and make sure the theme loads Plotly.js.

For example:

{{ pelican_stat_word_count.total_char_count }}
{{ pelican_stat_trend_plot_html | safe }}

Writing statistics shortcode

In Markdown content, put the full widget on its own line:

{% writing_stats %}

The full widget shows CJK characters, English words, total characters, average characters per post, and median characters per post. A compact variant shows only total and average characters:

{% writing_stats compact %}

The widget includes scoped styles and chooses its labels from the content's Lang metadata, then DEFAULT_LANG, and finally English. English (en) and Taiwanese Mandarin (zh-TW) labels are built in; language matching is case-insensitive. Other language tags, including bare zh, fall back to English.

Plugin settings

All settings are optional and belong in pelicanconf.py:

Label overrides are merged with the selected built-in locale, so unspecified labels keep their defaults:

PELICAN_STAT_LABELS = {
    "en": {
        "total_char_count": "Characters Written",
    },
    "zh-TW": {
        "total_char_count": "累積字元數",
        "average_chars_per_article": "平均每篇字元數",
    },
}

The available label keys are the seven keys listed under pelican_stat_word_count above.

Command-line usage

For installing this tool, I suggest using uv tool, pipx or something similar.

uv tool install pelican_stat

After installation, you can see the detail by add --help flag.

e.g.,

pelican-stat --help

or

pelican-stat collect --help

or

pelican-stat plot --help

or

pelican-stat wordcount --help

Contributing

See Contributing

Authors

Wei Lee weilee.rx@gmail.com

Created from Lee-W/cookiecutter-python-template version 3.0.0