Skip to main content

Summarize text using OpenAI.

Project description

# OpenAI Summarizer

Use the Completion engine from OpenAI to summarize text.

## Applications

  • Email Summarizer: Summarize your emails in less than 50 words.

## Installation

`sh pip install openai_summarizer `

## Prerequisites

If you use Gmail, you do NOT need to use your gmail’s password to share access of your mailbox with this client.

For running the binary email-summarizer through CLI, you may be able to create an “app password” by following [these instructions](https://support.google.com/accounts/answer/185833?hl=en&ref_topic=7189145) and then using the generated token as your password.

(WIP) For accessing the RESTful API, we’ll have OAuth set up for most common email providers so that you don’t have to share your email access credentials with this service.

## Usage

### Take inputs from stdin. Pass the email password (or some IMAP access token) and api key through stdin.

`sh email-summarizer --mailhost <some-imap-server> -u <some-gmail-email@gmail.com> --prompt-password --prompt-apikey `

Example

`sh email-summarizer --mailhost 'imap.gmail.com' -u user@gmail.com --prompt-password --prompt-apikey `

### Take inputs from env variable. Pass the email password (or some IMAP access token) and api key as an env variable.

`sh OPENAI_API_KEY=<API_KEY> EMAIL_SUMMARIZER_MAIL_PASSWORD=<PASSWORD> email-summarizer --mailhost 'imap.gmail.com' -u user@gmail.com `

Example

`sh OPENAI_API_KEY="somesupersecretopenaiapikey" EMAIL_SUMMARIZER_MAIL_PASSWORD="passwordtoaccessemail" email-summarizer --mailhost 'imap.gmail.com' -u user@gmail.com `

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

openai-summarizer-0.1.6.tar.gz (6.0 kB view details)

Uploaded Source

File details

Details for the file openai-summarizer-0.1.6.tar.gz.

File metadata

  • Download URL: openai-summarizer-0.1.6.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for openai-summarizer-0.1.6.tar.gz
Algorithm Hash digest
SHA256 af0bcbfa128af2d0b6e8c6bee929e5052cb956ed4afbbddb4fc2463dd182ed83
MD5 739d94a09022bb6977b48b803ba86576
BLAKE2b-256 273bdc1923a31b3303f3c1c0d2d5c297879b610ebc6ff82f4b70c46e0588b78b

See more details on using hashes here.

Supported by

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