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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: gpt-review-0.0.1rc56.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.1rc56.post1.tar.gz
Algorithm Hash digest
SHA256 c2161c4d2b5fad30640327be58d87584cf54333abb96eb5805dfc573309e4104
MD5 0a7005b847d539bf38dd4d33ff29cdc6
BLAKE2b-256 8ca6aa518eb958dc4e62e8cef1d1303b687ad0ba2a9a75b52aed7dae8aa3ef7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gpt_review-0.0.1rc56.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 3670c5d7cf2ceece46c6c397b32665ef6c8d7b0b0b6f0db8ac3e942775da0247
MD5 45844bdbc085133730269ebb05173d5f
BLAKE2b-256 cd5f29433a674b4f8b40ce6061a117a721e64268a3d4436bc85a94a5e3be75dd

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