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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gpt-review-0.0.1rc80.post1.tar.gz
Algorithm Hash digest
SHA256 ae7c7619dc9dbadd4503eccb243462ff6c183e7a44bf137fbfebf8725036a26d
MD5 1282bf753b729294ec4c5dd2242d0a57
BLAKE2b-256 f4b4273e84da596e8c12b05e8df793849dbb35a04f14d48af81524554af4d163

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gpt_review-0.0.1rc80.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 798d4c15ddc9b3d53b5ac9d6668faf9e01afcb87604abb6dba3bc0e18904068f
MD5 302f0c7ff65a0b1fee715c031598cd57
BLAKE2b-256 f7db7cb852470676cb8579b8138602cfd1c82cbb4c7e251adecc61a03f6b3139

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