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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: gpt-review-0.0.1rc70.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.1rc70.post1.tar.gz
Algorithm Hash digest
SHA256 436ab35ce655c2bbb1797a3031b7d92b9b321e67971b859186edf36fdeddead2
MD5 c74d3811605762207d4eb37a2632cc4a
BLAKE2b-256 d58216fcbfb90f3d5f4c2710db86f414512e678c0f8950faa92cb66ed3ce5975

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gpt_review-0.0.1rc70.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 ac3a698ab4dff63d3bbff621e07a87ceb68d72106515863f9fec91d4524ffe45
MD5 7d3ba34e9ab3a5277bddfa2e4b61c38f
BLAKE2b-256 1e73da1130a1a23720606b2ed1bef7e8d1d20dc12f65e0886c6b554f2627e9e5

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