Skip to main content

A tool leveraged by ML to aid the reading experience through bionic reading.

Project description

Textboost

A bionic reading tool that leverages the power of machine learning to enhance the reading experience and organization, particularly for individuals with an inability to focus.

How TextBoost Harnesses Machine Learning

  • Folder Management: The model can create subsections such as modified/food, modified/space, modified/politics, and more and store the respected pdf within their folder.
  • Text Summarization: Textboost provides the capability to summarize the text within a given PDF. Optionally, the user can turn on this feature and the summarization will appear at the last page of the PDF.

PLEASE NOTE THE FOLLOWING
Please note that this tool supports simple text extraction from PDFs. Complex elements like tables and code blocks will not be rendered properly.
The updated PDF will be automatically placed in appropriate folders based on the text context. You can find your modified file in a folder similar to ./modified/space/your_file.py.
Don't forget to check your current directory for the outputted file.

Usage

  • Install Python.
  • Git clone this repository by running the command https://github.com/boushrabettir/textboost.git
  • Move to the textboost directory by running cd ./textboost
  • Pip install requirements by running pip install -r requirements.txt
  • Convert your PDF to a Markdown using this tool.
  • Place your modified Markdown file in the pre-modified folder.
  • Run the script by typing python ./main.py

Key Features

  • Bold formatting to emphasize specific letters within words.
  • Organized file locations for modified files generated by a model
  • Optional text summarization generated by the model

Demo

https://github.com/boushrabettir/textboost/assets/116927138/f729e7f1-36aa-449d-b1a1-5f37d2026150


Made with 🐱💛 by Boushra Bettir

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

textboost-0.1.1.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

textboost-0.1.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file textboost-0.1.1.tar.gz.

File metadata

  • Download URL: textboost-0.1.1.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for textboost-0.1.1.tar.gz
Algorithm Hash digest
SHA256 50f9a7685a07b29feaf9225e5f3cd52bfdac9e006088ec30956733c03a4cfa97
MD5 e065feff1db95ad619aabbdac932f566
BLAKE2b-256 3d3858b3e90d54d2feeab9e4698e782ccbd207561beec598df61332eb701781a

See more details on using hashes here.

File details

Details for the file textboost-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: textboost-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for textboost-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bd5844183d2b00730f439e639f0ade550f235be08438d656cacca762c5261f3d
MD5 67914e9b537cefc6a4f5219964efebf8
BLAKE2b-256 bee4ee607d281f845f46f87cce16dfa5905ffe247435f666a4e39baee0e66abf

See more details on using hashes here.

Supported by

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