ajayrahul1 / doc-summariser-geekl

Your helper assistant to save time in reading lengthy documents.

Document Summariser using Generative AI

Version 0.4.0

• 🧑🏻‍💻 This application displays summary for the given input story or an essay provided using OpenAI text-davinci-003 and Cohere Co.summarize API.
• 🥚 Contains a hidden easter egg.
• 🈸 Summaries are not only limited to English. They can be translated to other languages as well.
• 🖥️ This is a responsive website that gets adjusted according to screen size.

Views

Desktop View of Summary Page	Mobile View of Summary Page
Cars Movie Summary Screenshot in Desktop View Desktop View of Summary Page	Mobile View of Summary Page

Steps to Clone, Install, Run the project

Cloning the project locally

For HTTPS Method,

# Cloning the GitHub Repository
git clone https://github.com/AjayRahul1/doc-summariser-geekl.git

# Going into the directory
cd doc-summariser-geekl/

For SSH Method (Prefer this only if SSH Key was setup on your computer),

# Cloning the GitHub Repository
git clone [email protected]:AjayRahul1/doc-summariser-geekl.git

# Going into the directory
cd doc-summariser-geekl/

For Windows

Create a virtual environment with Python 3.11.x version

Python Version 3.11 Installation

• Go to Python Official Downloads Page (or) Click here to download Python 3.11.7 installer directly.

• Download 3.11.x version (x can be any number you find there)

• Run the installer file.

• Check tick the Add Python to PATH.

• During installation, make sure to select the option Customize installation.

• Choose a unique installation directory for Python 3.11.x to avoid overwriting your existing Python version 3.x.x installation.

• If 'Add Python to Path' is not checked, open PATH Environment Variables and edit PATH variable by adding Python 3.11 version.

• Verify Python Version

  • py -3.11 --version

Creation of Virtual Environment

• py -3.11 -m venv venv
• Activating Virtual Environment
  • In Windows 10, Open Powershell (or) In Windows 11, Windows Terminal.
  • venv\Scripts\Activate
  • If you face any error with this command, it's because Microsoft disables Running Scripts by default.
  • To enable it temporarily, we run following command and try above command again.
    • powershell -ExecutionPolicy bypass

Installing Requirements

• Check whether you can see (venv) in the terminal that gives the sign of successful virtual environment activation
• pip install -r requirements.txt
• Take a moment of rest and comeback later while the requirements gets installed.

Setting Environment Variables

• If you have an OpenAI API Key, then you can try with text-davinci-003 model by using your key with the following command
• $Env:OPENAI_API_KEY = "openai_api_key"
• Create an API KEY on Cohere Dashboard and copy it.
• $Env:COHERE_API_KEY = "your_cohere_api_key"

Run the project on LocalHost

• flask --app main run
• Open LocalHost on 5000 Port on your computer

The Summarizer is at your feet now. Summarize and buy you some time!

For Linux (CLI Commands)

• First go to the folder where you want to clone using cd your-directory-path/
• Then copy below commands in your terminal in Linux. All done.

Ubuntu

# Installing Python 3.11.x
sudo apt install python3.11
# Verifying Python v3.11
python3.11 --version
# Create Virtual Environment with name 'venv'
python3.11 -m venv venv
# Activating Virtual Environment
source venv/bin/activate
# Installing Requirements
pip install -r requirements.txt
# Setting Environment Variables
export COHERE_API_KEY="your_key_here"
# Run the project on LocalHost
flask --app main run

Fedora

# Installing Python 3.11.x
sudo dnf install python3.11
# Verifying Python v3.11
python3.11 --version
# Create Virtual Environment with name 'venv'
python3.11 -m venv venv
# Activating Virtual Environment
source venv/bin/activate
# Installing Requirements
pip install -r requirements.txt
# Setting Environment Variables
export COHERE_API_KEY="your_key_here"
# Run the project on LocalHost
flask --app main run

Yet to be implemented

• Translation for the summary (output)
• Faster loading times.
• Responsive Website for Desktop and Mobile.
• Displaying Statistics & Metrics for the input and output.
• Word Cloud in Version 0.5.0

♥ Developed by

• Ajay Rahul •
• Rajesh Kuchhadia •
• Shaik Shaarikh •
• Hamsini Pulugurtha •