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.1rc48.post1.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gpt-review-0.0.1rc48.post1.tar.gz
Algorithm Hash digest
SHA256 11e1d511ab5d4f429f4e8ada24fbea8427eebbd88ef9228ecf55b23aa20d9b6f
MD5 aa8728df12af3014836d9bf8460c2007
BLAKE2b-256 02e483680223ed3a019ab4f7b12c051ab1ad425e8699bfcbeef84f86914dba8c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gpt_review-0.0.1rc48.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe4a5038761cace5c69e462c941736fe5d3e31da7806458229e4b09d94b1ba7f
MD5 b82a95ac2110a7b2d4cd173994702509
BLAKE2b-256 6528852231f71a72150b8f1d77e55c0882adaa09348ba4a522b08c1cd816eeac

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