Skip to content

summurai fetches and summarizes a webpage using OpenAI chat models. Its interactive mode allows you to chat and ask questions regarding the fetched webpage.

Notifications You must be signed in to change notification settings

jlyons210/summurai

Repository files navigation

summurai banner

summurai

Have you ever wanted a tool to get the tl;dr of a long webpage or article? How about one better: the ability to discuss and ask questions about the content?

summurai fetches and summarizes a webpage using OpenAI chat models. Its interactive mode allows you to chat and ask questions regarding the fetched webpage.

Contents

Demo screenshots

Typical use: one-shot webpage summary

Demo screenshot

Interactive use: chat about the article

Interactive Demo screenshot

Usage

summurai.py [-h] [-a API_KEY] [-m MODEL] [-i] url

Summarize a webpage using the OpenAI chat completion API

positional arguments:
  url                   URL of the webpage to summarize

options:
  -h, --help            show this help message and exit
  -a API_KEY, --api-key API_KEY
                        OpenAI API key
  -m MODEL, --model MODEL
                        Chat model to use for summarization
  -i, --interactive     Interactive mode

Setup

For convenience, the summurai.conf file allows you to configure the OpenAI API key and chat model to be used, so that they don't need to be provided on the command line. Command line arguments take precedence over configuration file values to allow easy overrides.

Install dependencies

pip install -r requirements.txt

Configure the application

💡 Copy the configuration file template and add your API key using your favorite editor.

cp summurai.conf.template summurai.conf

Have fun!

./summurai.py url_to_summarize

About

summurai fetches and summarizes a webpage using OpenAI chat models. Its interactive mode allows you to chat and ask questions regarding the fetched webpage.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages