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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: gpt-review-0.0.1rc49.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.1rc49.post1.tar.gz
Algorithm Hash digest
SHA256 bc93e366e802b2687d1e46788fb478148937e62adb9549de8f75cbba2b7be86d
MD5 4a78513c4033a90dfe66a3eba6a880c1
BLAKE2b-256 661c05b6377810dab6e465d9a996f8a9b23a55a91cba05953b82596efe204b51

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gpt_review-0.0.1rc49.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 edee07306c3314a751c3b5a4e04336d4fa9cd74d3545085c68d55910910b27b6
MD5 33161194aa6cdc36119fce8ea68ada4b
BLAKE2b-256 5662ae89dd93b81b6c2ee7c468f4a90969dfebedb3e3b4c11d4904e190c84f97

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