Skip to main content

Python Project for reviewing GitHub PRs with Open AI and Chat-GPT.

Project description

gpt-review

Actions Status Coverage Status License: MIT PyPI Downloads Code style: black

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:

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 gpt-review

export AZURE_OPENAI_API=<your azure api url>
export AZURE_OPENAI_API_KEY=<your azure key>

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]

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.4.0rc364.post1.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

gpt_review-0.4.0rc364.post1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file gpt-review-0.4.0rc364.post1.tar.gz.

File metadata

File hashes

Hashes for gpt-review-0.4.0rc364.post1.tar.gz
Algorithm Hash digest
SHA256 ef4ea4a14410fd99a9f35a33a71a3ac6ca4a0aaf48162d47e0a0615e8c32a2a0
MD5 5a667c097f9b71666f641b9b8223e368
BLAKE2b-256 8eba755ea991302b0d886e39d7a609fabe0c5311b45a5db5e96cd4b93328789b

See more details on using hashes here.

File details

Details for the file gpt_review-0.4.0rc364.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for gpt_review-0.4.0rc364.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 788c5a7296164b9fbdc9710f9ca8f074fe65c3be4e9d1625b2b9483bc37ff60c
MD5 a3db342ba6b0c6c132d6289ae072750e
BLAKE2b-256 676ae5108cb8cbb1a3e5db9b7f21eb75a8eff6025649de9f1ecf209188193a33

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