# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-readtime
VERSION=		3.0.0
KEYWORDS=		python
VARIANTS=		v11 v12
SDESC[v11]=		Texing reading time calculator (3.11)
SDESC[v12]=		Texing reading time calculator (3.12)
HOMEPAGE=		https://github.com/alanhamlett/readtime
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPI/r/readtime
DISTFILE[1]=		readtime-3.0.0.tar.gz:main
DF_INDEX=		1
SPKGS[v11]=		single
SPKGS[v12]=		single

OPTIONS_AVAILABLE=	PY311 PY312
OPTIONS_STANDARD=	none
VOPTS[v11]=		PY311=ON PY312=OFF
VOPTS[v12]=		PY311=OFF PY312=ON

DISTNAME=		readtime-3.0.0

GENERATED=		yes

[PY311].BUILDRUN_DEPENDS_ON=		python-beautifulsoup4:single:v11
					python-markdown2:single:v11
					python-pyquery:single:v11
[PY311].USES_ON=			python:v11,sutools

[PY312].BUILDRUN_DEPENDS_ON=		python-beautifulsoup4:single:v12
					python-markdown2:single:v12
					python-pyquery:single:v12
[PY312].USES_ON=			python:v12,sutools

[FILE:2023:descriptions/desc.single]
# readtime

[Tests]
[Coverage]

Calculates the time some text takes the average human to read, based on
Medium's [read time forumula].

### Algorithm

Medium's Help Center says,

> Read time is based on the average reading speed of an adult (roughly 265
WPM). We take the total word count of a post and translate it into minutes,
with an adjustment made for images. For posts in Chinese, Japanese and
Korean, it's a function of number of characters (500 characters/min) with
an adjustment made for images.

Source: https://help.medium.com/hc/en-us/articles/214991667-Read-time (Read
Sept 23rd, 2018)

Double checking with real articles, the English algorithm is:

    seconds = num_words / 265 * 60 + img_weight * num_images

With `img_weight` starting at `12` and decreasing one second with each
image encountered, with a minium `img_weight` of `3` seconds.

### Installation

    virtualenv venv
    . venv/bin/activate
    pip install readtime

Or if you like to live dangerously:

    sudo pip install readtime

### Usage

Import `readtime` and pass it some text, HTML, or Markdown to get back the
time it takes to read:

    >>> import readtime
    >>> result = readtime.of_text('The shortest blog post in the world!')
    >>> result.seconds
    2
    >>> result.text
    u'1 min'

The result can also be used as a string:

    >>> str(readtime.of_text('The shortest blog post in the world!'))
    u'1 min read'

To calculate read time of Markdown:

    >>> readtime.of_markdown('This is **Markdown**')
    1 min read

To calculate read time of HTML:

    >>> readtime.of_html('This is <strong>HTML</strong>')
    1 min read

To customize the WPM (default 265):

    >>> result = readtime.of_text('The shortest blog post in the world!',
wpm=5)
    >>> result.seconds
    96
    >>> result.text
    u'2 min'
    >>> result.wpm
    5

### Contributing

Before contributing a pull request, make sure tests pass:

    virtualenv venv
    . venv/bin/activate
    pip install tox
    tox

Many thanks to all [contributors]!


[FILE:100:distinfo]
76c5a0d773ad49858c53b42ba3a942f62fbe20cc8c6f07875797ac7dc30963a9         6271 readtime-3.0.0.tar.gz