Skip to content

Sbhat92/QuickReaderPDF

Repository files navigation

QuickReaderPDF

License: license Issues: issues PyPi : PyPI docs status: Docs

Build: Linting, Testing Status Code coverage: Codecov

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.

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!

Usage

  1. Open a terminal in the location of the pdf file you want.

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

    Two use cases:

    1. 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>

    2. 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.

Example

  1. You can convert any url, for example: A great short story and convert it into a pdf:
➡️
  1. You can also use QuickReaderPDF to convert a pdf into a boldened pdf.

    The original PDF looks converted looks like:

    ➡️