Skip to main content
https://travis-ci.com/JenkinsDev/pelican-readtime.svg?branch=master

Plugin for Pelican that computes a piece of content’s read time.

It adds a readtime and readtime_string attributes to every article and/or page, with the time estimation for reading the article.

Setting Up

Adding ‘ReadTime’ to the list of plugins:

In pelicanconf.py:

PLUGINS = [
    ... ,
    'readtime'
]

1. Words Per Minute Only

In your settings you would use assign the READTIME_WPM variable to an integer like so:

In pelicanconf.py:

READTIME_WPM = 180

Every article’s read time would be calculated using this average words per minute count. (See the Usage section for how to use the calculated read times in templates). This is the simplest read time method.

2. Words Per Minute per language

This is the preferred method if you are dealing with multiple languages. Take a look at the following settings

In pelicanconf.py:

READTIME_WPM = {
    'default': {
        'wpm': 200,
        'min_singular': 'minute',
        'min_plural': 'minutes',
        'sec_singular': 'second',
        'sec_plural': 'seconds'
    },
    'es': {
        'wpm': 220,
        'min_singular': 'minuto',
        'min_plural': 'minutos',
        'sec_singular': 'segundo',
        'sec_plural': 'segundos'
    }
}

In this example the default reading time for all articles is 200 words per minute. Any articles in spanish will be calculated at 220 wpm. This is useful for information dense languages where the read time varies rapidly.

Chances are the average reading time will not vary rapidly from language to language, however using this method also allows you to set plurals which make templating easier in the long run.

Usage

Four variables are accessible through the read time plugin: readtime, readtime_string, readtime_with_seconds, and readtime_string_with_seconds

{% if article.readtime %} This article takes {{article.readtime}} minute(s) to read.{% endif %}
// This article takes 4 minute(s) to read.
{% if article.readtime_string %} This article takes {{article.readtime_string}} to read.{% endif %}
// This article takes 4 minutes to read.
{% if article.readtime_with_seconds %}
  This article takes {{article.read_with_seconds[0]}} minutes(s) and {{article.read_with_seconds[1]}} second(s) to read.
{% endif %}
// This article takes 4 minutes and 21 second(s) to read.
{% if article.readtime_string_with_seconds %} This article takes {{article.readtime_string_with_seconds}} to read.{% endif %}
// This article takes 4 minutes, 1 second to read.

Release files for pelican-readtime 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pelican-readtime 0.2.1
File Size Uploaded
pelican_readtime-0.2.1.tar.gz 7.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pelican-readtime 0.2.1
File Interpreter ABI Platform
pelican_readtime-0.2.1-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 14.3 kB

Release files / pelican_readtime-0.2.1.tar.gz

Download URL pelican_readtime-0.2.1.tar.gz
Size 7.1 kB
Tags Source
SHA-256 checksum
How to use checksums
d83fda594e05ba53ade767d1d702b79f2b1074a2f09eda69380b1ea32b71598a
BLAKE2b-256 checksum
How to use checksums
d8fca8384503aae7ac947ccf3a8fbe612a2d24ab1099e08ede64ae43ba3864eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.12

Release files / pelican_readtime-0.2.1-py2.py3-none-any.whl

Download URL pelican_readtime-0.2.1-py2.py3-none-any.whl
Size 7.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
22497c9dc83554f188d13af6a362d023b2c6e811af703553d99dfc404c52feec
BLAKE2b-256 checksum
How to use checksums
9586b8ad83fd38d6ac6736f5082e18b17d40c2f5c801e14ae4b05d3ff8a86e0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.12

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2.0

2 release files

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page