https://github.com/truskovskiyk/pr-reviewer
Use LLM to help you with PR review
https://github.com/truskovskiyk/pr-reviewer
Last synced: 4 months ago
JSON representation
Use LLM to help you with PR review
- Host: GitHub
- URL: https://github.com/truskovskiyk/pr-reviewer
- Owner: truskovskiyk
- License: apache-2.0
- Created: 2023-04-16T01:21:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-18T03:20:45.000Z (over 2 years ago)
- Last Synced: 2024-11-30T05:12:07.988Z (about 1 year ago)
- Language: Python
- Size: 113 KB
- Stars: 71
- Watchers: 3
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-llm-devops - truskovskiyk/pr-reviewer
README
# pr-reviewer
Streamline Your GitHub Pull Requests with AI, co-authored with GPT4.
🚀 Excited to announce our new open-source project: PR Review Bot, a GitHub Pull Request review bot powered by OpenAI's GPT-3.5-turbo!
🤖 PR Review Bot automatically reviews open PRs in your GitHub repository, providing helpful feedback and even approving or requesting changes based on the analysis of the PR text and comments.
🔧 Save time and effort in your development workflow by automating the initial review process, ensuring PRs adhere to your project's guidelines and best practices.
🌟 Key features:
- Automatically reviews open PRs
- Leverages OpenAI's GPT-3.5-turbo for intelligent analysis and feedback
- Can be easily customized to fit your project needs
- Easy to set up and use
- Costs analysis of each review
## Example
## Install
```
pip install pr-review-bot
```
## Setup
```
export PR_REVIEW_BOT_TOKEN='your github token'
export PR_REVIEW_BOT_OPEN_AI_KEY='your open ai key'
export PR_REVIEW_BOT_OWNER='github user'
export PR_REVIEW_BOT_REPO_NAME='github repo'
```
How to get [Github token](https://docs.github.com/en/enterprise-server@3.4/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
How to get [Open AI key](https://platform.openai.com/account/api-keys)
## Usage
To review all open pull requests:
```
pr-review-bot review-all-open-pr
```
To review a specific pull request:
```
pr-review-bot review-pr
```
For help:
```
pr-review-bot --help
```
## Testing
```
pytest --cov=pr_review_bot ./tests
```