Metadata-Version: 2.1
Name: QuickReaderPDF
Version: 0.3.3
Summary: This package converts a pdf or a html file 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!
Author-email: Shreyas Bhat <shreyasbhat92@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Shreyas Bhat
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://github.com/Sbhat92/QuickReaderPDF
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: develop
License-File: LICENSE


  

  

# QuickReaderPDF

  

  

  

License:    ![license](https://img.shields.io/badge/license-MIT-blue)				Issues: 		![issues](https://img.shields.io/github/issues/Sbhat92/QuickReaderPDF)	PyPi :     [ ![PyPI](https://img.shields.io/pypi/v/QuickReaderPDF)](https://pypi.org/project/QuickReaderPDF/)	docs status: [![Docs](https://img.shields.io/readthedocs/quickreaderpdf)](https://quickreaderpdf.readthedocs.io/en/latest/index.html)

  
Build: [![Linting, Testing Status](https://github.com/Sbhat92/QuickReaderPDF/actions/workflows/setup.yaml/badge.svg)](https://github.com/Sbhat92/QuickReaderPDF/actions/workflows/setup.yaml)	Code coverage: [![Codecov](https://codecov.io/gh/Sbhat92/QuickReaderPDF/branch/main/graph/badge.svg)](https://codecov.io/gh/Sbhat92/QuickReaderPDF)

  

  

  

## 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"](https://www.huffingtonpost.co.uk/entry/what-is-bionic-reading-does-it-work_uk_628749a3e4b05cfc268a59ff), 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](https://americanliterature.com/author/philip-k-dick/short-story/the-eyes-have-it) and convert it into a pdf:

  

<div style="display: flex; align-items: center;">
    <img src="https://drive.google.com/uc?id=1tRH3PCZFTXmvremGEdDzHud1lBLHrWCJ" style="width: 400px; height: 300px;">
    <span style="font-size: 100px; margin: 0 20px;">➡️</span>
    <img src="https://drive.google.com/uc?id=1YfQ1A8f25FnTiMjLNwGDHZQs5S3Zsw6D" style="width: 300px; height: 300px;">
</div>
  

2. You can also use QuickReaderPDF to convert a pdf into a boldened pdf.
	
	The original PDF looks converted looks like:

	<div style="display: flex; align-items: center;">
    <img src="https://drive.google.com/uc?id=1R7XDMS8hlB7v12XIpU06-q_-yybJBrkf" style="width: 400px; height: 300px;">
    <span style="font-size: 100px; margin: 0 20px;">➡️</span>
    <img src="https://drive.google.com/uc?id=1YfQ1A8f25FnTiMjLNwGDHZQs5S3Zsw6D"  style="width: 300px; height: 300px;">
</div>
	
