Skip to main content

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

Project description

Tests Coverage

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

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**')

To calculate read time of HTML:

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

Contributing

Before contributing a pull request, make sure tests pass:

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

Many thanks to all contributors!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readtime-1.0.3.tar.gz (5.1 kB view details)

Uploaded Source

File details

Details for the file readtime-1.0.3.tar.gz.

File metadata

  • Download URL: readtime-1.0.3.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for readtime-1.0.3.tar.gz
Algorithm Hash digest
SHA256 915244aaeb9e1b7115a7d3fa4dbe396a60f6663ffcde527eddec9861d541f567
MD5 2acf531ab6d22c4dcbb3a0e5725cbdbb
BLAKE2b-256 19b51d96e2551ff89bcf5822918135a02a8c4068325fb8d19584243bb9dbdeea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page