Giter VIP home page Giter VIP logo

quick-ref's Introduction

Quick Ref

This Chrome Extension helps to find similar keywords and sentences from local pdfs. it uses NLP. It also provides a summarised version of the results. It also provides a way to open the pdfs in browser or Adobe Reader or SumatraPDF. It also opens pdf with given page no. and highlighted text.

So, this helps you to quickly find stuff from your local books/notes when you see similar info on web. (I'm looking for contributors, please hmu if you want to contribute.)

Setup

  1. Clone the repo
  2. Go to chrome://extensions and enable developer mode
  3. Click on Load unpacked and select the quick-ref folder to load the extension
  4. set openAI key in api_key.py (optional)
  5. install dependencies pip install -r requirements.txt (use venv in case of conflicts)
  6. run python main.py
  7. Add Path of Adobe Reader or SumatraPDF in integrations.py and set READER_TO_USE to 'Adobe' or 'Sumatra'
  8. Add your pdfs in content folder, (or change LIB_PATH for different location)
  9. Enjoy!

Setup Using venv (Windows)

python -m venv venv
venv\\Scripts\\activate
pip install -r requirements.txt
python main.py

Features

  • Search terms, sentences from local pdfs
  • Summarise the results
  • Open PDFs in browser or Adobe Reader or SumatraPDF
  • Opens pdf with given page no. and highlighted text

Problems

OpenAI Embeds don't work for now. other LIB_PATH isn't tested.

Features To Add

  • Multiple Directory PDFs Support
  • OpenAI Embeds
  • Port to FireFox (Someone else will work on this)
  • Support Normal Text Files/More Formats?

Bug Fixes

  • Skip Blank Pages from PDF
  • Refactoring required (break main.py into api.py , nlp.py,config.py)

Screenshots

Sample Hack1 Hack2 Hack3

quick-ref's People

Contributors

whispard avatar

Stargazers

Jan Kubica avatar  avatar  avatar  avatar David avatar Chirag Ahuja avatar  avatar Jan Vlnas avatar Joseph Mearman avatar Eren Akbulut avatar

Watchers

 avatar

Forkers

ccaiccie

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.