Welcome to QuickReaderPDF’s documentation!

==========================================

QuickReaderPDF

License: https://img.shields.io/badge/license-MIT-bluelicense

Issues: https://img.shields.io/github/issues/Sbhat92/QuickReaderPDFissues

PyPi : https://img.shields.io/pypi/v/QuickReaderPDFPyPI

docs status: https://img.shields.io/readthedocs/quickreaderpdfDocs

Build: https://github.com/Sbhat92/QuickReaderPDF/actions/workflows/setup.yaml/badge.svgLinting, Testing Status

Code coverage: https://codecov.io/gh/Sbhat92/QuickReaderPDF/branch/main/graph/badge.svgCodecov

Read a PDF up to 20% faster!

A library that converts web pages or existing PDFs to new, easier to read PDFs

Description

This package converts a pdf or a web page that the user wants to read to an new pdf file, which can be read faster! The idea is “bionic reading”, where we bold the first three letters of every word. We hope you enjoy reading your files faster!

Use case

People with ADHD and people who have trouble reading find it easier to concentrate reading files of this type. If you find yourself zoning out while reading often, try this library

Features:

The user can input a pdf file or a html file, and QuickReaderPDF will output a pdf with the first three letters boldened.

QuickReader PDF maintains the structure of the PDF and maintains links in the original PDF or URL.

It also maintains

  • Background

  • Formatting

  • Paragraph structure

  • Links

  • Images

No Ads!

If the webpage you are trying to convert to a PDF has embedded ads, QuickReaderPDF will not have ads in the PDF

Installation

To install, simply open a terminal and type:

pip install QuickReaderPDF

You’re ready to go! The library can now be invoked in the directory of your choice.

Usage

  1. Open a terminal in the location of the pdf file you want(iif you are using the url functionality, you can use any directory).

  2. Use the provided functions to convert a PDF file or URL to a PDF file with bold text:

Two use cases:

URL to PDF boldened

To convert a URL to a PDF file with bold text, say this url:

url = "https://example.com"

python -m QuickReaderPDF <url> url <name of new pdf>

Note that <url> is a keyword, which indicates to us that the input is a url.

It will make a new pdf in the same directory, with name <name of new pdf>

PDF to PDF boldened

To convert a PDF file to a PDF file with bold text:

input_file = “input.pdf”

python -m QuickReaderPDF <pdf> input_file <name of new pdf>

Make sure to replace “https://example.com” with the desired URL and “input.pdf” with the path to your input PDF file.

Contents:

Indices and tables