Skip to main content

Python Project for reviewing GitHub PRs with Open AI and Chat-GPT.

Project description

GPTReview Workflow 🤖🔍

Get OpenAI GPT models to suggest changes on your pull request in the comments.

How to integrate into your repo:

  1. Copy the workflow from this repo's .github/workflows/test-action.yml into your project in the same location and modify it to suit your needs, if you'd like. Update the action pointer from "./" to "microsoft/easy-gpt@"
  2. Get an OpenAI API Key here
  3. Get an OpenAI Org ID here
  4. Create two secrets in your project's settings called OPENAI_API_KEY for your OpenAI API Key and OPENAI_ORG_KEY for your OpenAI Organization ID..

How to use CLI:

Install the package via pip and set the environment variables for your OpenAI API Key and Organization ID. To use Azure OpenAI, set the environment variable AZURE_OPENAI_API_URL and AZURE_OPENAI_API_URL_KEY to the URL and key for your Azure OpenAI API.

pip install easy-gpt

export OPENAI_API_KEY=<your key>

export AZURE_OPENAI_API=<your azure api url>
export AZURE_OPENAI_API_KEY=<your azure key>

Developer Setup

To install the package in development mode, with additional packages for testing, run the following command:

pip install -e .[test]

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gpt-review-0.0.1rc58.post1.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

gpt_review-0.0.1rc58.post1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file gpt-review-0.0.1rc58.post1.tar.gz.

File metadata

  • Download URL: gpt-review-0.0.1rc58.post1.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for gpt-review-0.0.1rc58.post1.tar.gz
Algorithm Hash digest
SHA256 828d97cc7315bcf7c6ba3606b287c783147db8c01882371ac1530a42449f170a
MD5 c40b1ff68c6b843c36afe27600990159
BLAKE2b-256 4e5f807a3bd8678f97b1138a155a65a7b42fdd94c2d1014cdc9bd84beda80b57

See more details on using hashes here.

File details

Details for the file gpt_review-0.0.1rc58.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for gpt_review-0.0.1rc58.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 e81d503e33debebe25d8464a49b955cc827bd5bef8202c2c41623a0a304a10a0
MD5 49123ad3742e5c37f970a26f1d5aa653
BLAKE2b-256 e38429ff2f22d7ac8b0446c2ac2f8ea0bb6c6b162a75cdd61d0907dc6c24258a

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