使用Open AI和Chat-GPT审查GitHub PR的Python项目。
项目描述
gpt-review
一个基于Python的命令行工具和GitHub Action，用于使用Open AI或Azure Open AI模型审查拉取请求的内容。
如何安装CLI
首先，使用pip安装软件包
pip install gpt-review
GPT API凭证
您需要提供一个OpenAI API密钥来使用此CLI工具。按照优先级顺序，它将检查以下方法
-
在
azure.yaml或CONTEXT_FILE指向的位置存在上下文文件。请参阅azure.yaml.template获取示例。 -
AZURE_OPENAI_API_URL和AZURE_OPENAI_API_KEY用于连接到Azure Open AI APIexport AZURE_OPENAI_API=<your azure api url> export AZURE_OPENAI_API_KEY=<your azure key>
-
OPENAI_API_KEY用于直接使用OpenAI APIexport OPENAI_API_KEY=<your openai key>
-
AZURE_KEY_VAULT_URL用于使用Azure Key Vault。在azure-open-ai中放置URL的秘密，并将API密钥放在azure-openai-key中，然后运行export AZURE_KEY_VAULT_URL=https://<keyvault_name>.vault.azure.net/ az login
主要命令
要显示有关可用命令及其使用方法的帮助信息，请运行
gpt --help
要显示此CLI工具的当前版本，请运行
gpt --version
以下是使用此CLI工具的主要命令
1. 提出问题
要向GPT提交问题并获得答案，请使用以下格式
gpt ask "What is the capital of France?"
您可以使用各种选项自定义请求，例如最大令牌数（--max-tokens）、温度（--temperature）、top-p值（--top-p）、频率惩罚（--frequency-penalty）、存在惩罚（--presence-penalty）等。
关于文件的提问
要向GPT提交一个带有文件的问题并获得答案，请使用以下格式
gpt ask --files WordDocument.docx "Summarize the contents of this document."
2. 审查PR
要审查PR，请使用以下格式
gpt github review \
--access-token $GITHUB_ACCESS_TOKEN \
--pull-request $PULL_REQUEST_NUMBER \
--repository $REPOSITORY_NAME
3. 使用GPT生成git提交信息
在添加文件后，使用以下格式使用 GPT 生成 git 提交信息
git add .
gpt git commit
有关每个命令及其选项的更详细信息，请运行
gpt COMMAND --help
将 COMMAND 替换为上述列出的主要命令之一（例如，'ask'）。
开发者设置
要使用测试的附加包以开发模式安装包，请运行以下命令
pip install -e .[test]
下载文件
下载您平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源分发
构建版本
gpt_review-0.9.5.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | c9a9e48ec7a561bce38d98ced8a87d54ec831c3553d263ed724607292460ffd5 |
|
| MD5 | 181778e055c0c08d728600622ba3760b |
|
| BLAKE2b-256 | 67c73759e37e09f7597ea07c4c8fcfbf1ae43e0e43c24fa92911cb06b71bd9c5 |
gpt_review-0.9.5-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 04a4a996f3742715ffef18ab3f9d847766285d341b9bdd179bc2100fcaf1be73 |
|
| MD5 | 2656870fd721afb0196caae69e56cd3c |
|
| BLAKE2b-256 | 5bf36dd9c4ee43adeda507e70b65361d5f6cc5b30a2ce2ee2a53e0fce65e6fbb |