Skip to content

u8slvn/bionic-writer

Repository files navigation

Bionic Writer

Pypi Version Python Version GitHub Actions Workflow Status Codecov Project license

Bionic Writer is a Python library to write text with Bionic Reading style for any kind of format.

About Bionic Reading method

From: bionic-reading.com/

Bionic Reading® revises texts so that the most concise parts of words are highlighted. This guides the eye over the text and the brain remembers previously learned words more quickly. Save precious time. Gain advantages. Learn new things faster.

Does Bionic Reading really speed-up your reading speed? According to this paper, probably not. Whatsoever it's still a nice screen reading technique that seems to help many people to stay focused during their reading sessions.

Usage

Installation

pip install bionic-writer

Quickstart examples

Write a Bionic Reading text in Markdown format:

import bionic_writer

text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit."

bionic_md = bionic_writer.write(text=text, affix="**", postfix="**")

print(bionic_md)

Output:

**Lo**rem **ip**sum **do**lor **s**it **am**et, **conse**ctetur **adipi**scing **el**it.

Write a Bionic Reading text in HTML format:

import bionic_writer

text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit."

bionic_html = bionic_writer.write(text=text, affix="<b>", postfix="</b>")

print(bionic_html)

Output:

<b>Lo</b>rem <b>ip</b>sum <b>do</b>lor <b>s</b>it <b>am</b>et, <b>conse</b>ctetur <b>adipi</b>scing <b>el</b>it.