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

Uploaded Source

Built Distribution

gpt_review-0.0.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gpt-review-0.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 2db47e20d4cf397d8c0ff613d7ff75ce2f541d42837e81fc9b223ffdd7c27c79
MD5 382a9c001040ac4b9e5b56ced1f78882
BLAKE2b-256 28437494a6a440b49f6296ea84bb3f1795f205f83a63b2ecdd55a5c96e057843

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gpt_review-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for gpt_review-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c0e22e4975cbf686df7206a067b76ef35e908e91d030b7aac55dc731190fc780
MD5 796ee4f45c41aeecbbb3b6217e65a5d8
BLAKE2b-256 4bc5fcbbf3dd668b86a6d9ac13b5ada645ed09ff94c5ed75bf8e24468c6aa25d

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