Python Project for reviewing GitHub PRs with Open AI and Chat-GPT.
Project description
gpt-review
A Python based CLI and GitHub Action to use Open AI or Azure Open AI models to review contents of pull requests.
How to install CLI
First, install the package via pip:
pip install gpt-review
GPT API credentials
You will need to provide an OpenAI API key to use this CLI tool. In order of precedence, it will check the following methods:
-
Presence of a context file at
azure.yamlor whereverCONTEXT_FILEpoints to. Seeazure.yaml.templatefor an example. -
AZURE_OPENAI_API_URLandAZURE_OPENAI_API_KEYto connect to an Azure OpenAI API:export AZURE_OPENAI_API=<your azure api url> export AZURE_OPENAI_API_KEY=<your azure key>
-
OPENAI_API_KEYfor direct use of the OpenAI APIexport OPENAI_API_KEY=<your openai key>
-
AZURE_KEY_VAULT_URLto use Azure Key Vault. Put secrets for the url atazure-open-aiand the API Keyazure-openai-key, then run:export AZURE_KEY_VAULT_URL=https://<keyvault_name>.vault.azure.net/ az login
Main Commands
To show help information about available commands and their usage, run:
gpt --help
To display the current version of this CLI tool, run:
gpt --version
Here are the main commands for using this CLI tool:
1. Ask a Question
To submit a question to GPT and receive an answer, use the following format:
gpt ask "What is the capital of France?"
You can customize your request using various options like maximum tokens (--max-tokens), temperature (--temperature), top-p value (--top-p), frequency penalty (--frequency-penalty), presence penalty (--presence-penalty), etc.
Ask a Question about a File
To submit a question to GPT with a file and receive an answer, use the following format:
gpt ask --files WordDocument.docx "Summarize the contents of this document."
2. Review a PR
To review a PR, use the following format:
gpt github review \
--access-token $GITHUB_ACCESS_TOKEN \
--pull-request $PULL_REQUEST_NUMBER \
--repository $REPOSITORY_NAME
3. Generate a git commit message with GPT
To generate a git commit message with GPT after having added the files, use the following format:
git add .
gpt git commit
For more detailed information on each command and its options, run:
gpt COMMAND --help
Replace COMMAND with one of the main commands listed above (e.g., 'ask').
Developer Setup
To install the package in development mode, with additional packages for testing, run the following command:
pip install -e .[test]
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
Built Distribution
File details
Details for the file gpt_review-0.9.5rc933.post1.tar.gz.
File metadata
- Download URL: gpt_review-0.9.5rc933.post1.tar.gz
- Upload date:
- Size: 34.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e6fc525feeb856a4d40ae6702d539867fb4e7075c91193d4b6584943962a43c4 |
|
| MD5 | a09fa5c1c7acb0cca0994e3867774944 |
|
| BLAKE2b-256 | 059b7f7a1f5a2e35d0addde336b72d4d343a83e1b08e403c38c1e4ff48197c65 |
File details
Details for the file gpt_review-0.9.5rc933.post1-py3-none-any.whl.
File metadata
- Download URL: gpt_review-0.9.5rc933.post1-py3-none-any.whl
- Upload date:
- Size: 23.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 752231e2d43d62c7fc82cd590a38529be1096cc8e3b1da5b968511a43743d72d |
|
| MD5 | 9cb969a1bed6a1177f9d6a407cebb666 |
|
| BLAKE2b-256 | 50b2b7ed7795249dda2ff0e6c0a694a5c60a5352ea6461bb9ad3d014482d053b |
