| Name | pr-agent JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions. |
| upload_time | 2024-05-20 06:30:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [2023] [Codium ltd] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| keywords |
ai
agents
pull request
automation
code review
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
aiohttp
atlassian-python-api
azure-devops
azure-identity
boto3
dynaconf
fastapi
GitPython
google-cloud-aiplatform
google-cloud-storage
Jinja2
litellm
loguru
msrest
openai
pytest
PyGithub
PyYAML
python-gitlab
retry
starlette-context
tiktoken
ujson
uvicorn
tenacity
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://codium.ai/images/pr_agent/logo-dark.png" width="330">
<source media="(prefers-color-scheme: light)" srcset="https://codium.ai/images/pr_agent/logo-light.png" width="330">
<img src="https://codium.ai/images/pr_agent/logo-light.png" alt="logo" width="330">
</picture>
<br/>
CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions
</div>
[](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
[](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl)
[](https://discord.com/channels/1057273017547378788/1126104260430528613)
[](https://twitter.com/codiumai)
<a href="https://github.com/Codium-ai/pr-agent/commits/main">
<img alt="GitHub" src="https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge" height="20">
</a>
</div>
### [Documentation](https://pr-agent-docs.codium.ai/)
- See the [Installation Guide](https://pr-agent-docs.codium.ai/installation/) for instructions on installing PR-Agent on different platforms.
- See the [Usage Guide](https://pr-agent-docs.codium.ai/usage-guide/) for instructions on running PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened.
- See the [Tools Guide](https://pr-agent-docs.codium.ai/tools/) for a detailed description of the different tools, and the available configurations for each tool.
## Table of Contents
- [News and Updates](#news-and-updates)
- [Overview](#overview)
- [Example results](#example-results)
- [Try it now](#try-it-now)
- [PR-Agent Pro 💎](#pr-agent-pro-)
- [How it works](#how-it-works)
- [Why use PR-Agent?](#why-use-pr-agent)
## News and Updates
### May 19, 2024
GPT-4o is now the default fast model ("Turbo"). This model will be used for all commands except `review` and `improve`, which will still use "GPT-4-2024-04-09", since they are harder and would still benefit from the larger model.
### May 12, 2024
Inspired by [AlphaCodium](https://github.com/Codium-ai/AlphaCodium) flow engineering scheme, PR-Agent now performs **self-reflection** on the code suggestions it provides,
enabling to remove invalid suggestions, and score the valid ones. The suggestions will be presented sorted by their score, enabling to focus on the most important ones first.
You can also choose to automatically remove suggestions below a certain importance score threshold, by setting the `pr_code_suggestions.suggestions_score_threshold` [configuration](https://pr-agent-docs.codium.ai/tools/improve/#configuration-options).
<kbd><img src="https://codium.ai/images/pr_agent/self_reflection1.png" width="512"></kbd>
<kbd><img src="https://codium.ai/images/pr_agent/self_reflection2.png" width="512"></kbd>
### May 2, 2024
Check out the new [PR-Agent Chrome Extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) 🚀🚀🚀
This toolbar integrates seamlessly with your GitHub environment, allowing you to access PR-Agent tools [directly from the GitHub interface](https://www.youtube.com/watch?v=gT5tli7X4H4).
You can also easily export your chosen configuration, and use it for the automatic commands.
<kbd><img src="https://codium.ai/images/pr_agent/toolbar1.png" width="512"></kbd>
<kbd><img src="https://codium.ai/images/pr_agent/toolbar2.png" width="512"></kbd>
## Overview
<div style="text-align:left;">
Supported commands per platform:
| | | GitHub | Gitlab | Bitbucket | Azure DevOps |
|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:|
| TOOLS | Review | ✅ | ✅ | ✅ | ✅ |
| | ⮑ Incremental | ✅ | | | |
| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎 | ✅ | ✅ | ✅ | ✅ |
| | Describe | ✅ | ✅ | ✅ | ✅ |
| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | ✅ | | | |
| | Improve | ✅ | ✅ | ✅ | ✅ |
| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ |
| | Ask | ✅ | ✅ | ✅ | ✅ |
| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | ✅ | ✅ | | |
| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | ✅ |
| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | ✅ |
| | Reflect and Review | ✅ | ✅ | ✅ | ✅ |
| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ✅ |
| | Find Similar Issue | ✅ | | | |
| | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | ✅ | ✅ | | ✅ |
| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | ✅ |
| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | ✅ | ✅ | | ✅ |
| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | |
| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | ✅ | | | |
| | | | | | |
| USAGE | CLI | ✅ | ✅ | ✅ | ✅ |
| | App / webhook | ✅ | ✅ | ✅ | ✅ |
| | Tagging bot | ✅ | | | |
| | Actions | ✅ | | ✅ | |
| | | | | | |
| CORE | PR compression | ✅ | ✅ | ✅ | ✅ |
| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ |
| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ |
| | Multiple models support | ✅ | ✅ | ✅ | ✅ |
| | [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) 💎 | ✅ | ✅ | ✅ | ✅ |
| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | ✅ |
| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | | | |
- 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/)
[//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md))
___
‣ **Auto Description ([`/describe`](https://pr-agent-docs.codium.ai/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
\
‣ **Auto Review ([`/review`](https://pr-agent-docs.codium.ai/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
\
‣ **Code Suggestions ([`/improve`](https://pr-agent-docs.codium.ai/tools/improve/))**: Code suggestions for improving the PR.
\
‣ **Question Answering ([`/ask ...`](https://pr-agent-docs.codium.ai/tools/ask/))**: Answering free-text questions about the PR.
\
‣ **Update Changelog ([`/update_changelog`](https://pr-agent-docs.codium.ai/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes.
\
‣ **Find Similar Issue ([`/similar_issue`](https://pr-agent-docs.codium.ai/tools/similar_issues/))**: Automatically retrieves and presents similar issues.
\
‣ **Add Documentation 💎 ([`/add_docs`](https://pr-agent-docs.codium.ai/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR.
\
‣ **Generate Custom Labels 💎 ([`/generate_labels`](https://pr-agent-docs.codium.ai/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user.
\
‣ **Analyze 💎 ([`/analyze`](https://pr-agent-docs.codium.ai/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
\
‣ **Custom Prompt 💎 ([`/custom_prompt`](https://pr-agent-docs.codium.ai/tools/custom_prompt/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
\
‣ **Generate Tests 💎 ([`/test component_name`](https://pr-agent-docs.codium.ai/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes.
\
‣ **CI Feedback 💎 ([`/checks ci_job`](https://pr-agent-docs.codium.ai/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.
\
‣ **Similar Code 💎 ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
___
## Example results
</div>
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
<div align="center">
<p float="center">
<img src="https://www.codium.ai/images/pr_agent/describe_new_short_main.png" width="512">
</p>
</div>
<hr>
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151">/review</a></h4>
<div align="center">
<p float="center">
<kbd>
<img src="https://www.codium.ai/images/pr_agent/review_new_short_main.png" width="512">
</kbd>
</p>
</div>
<hr>
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159">/improve</a></h4>
<div align="center">
<p float="center">
<kbd>
<img src="https://www.codium.ai/images/pr_agent/improve_new_short_main.png" width="512">
</kbd>
</p>
</div>
<hr>
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/generate_labels</a></h4>
<div align="center">
<p float="center">
<kbd><img src="https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png" width="300"></kbd>
</p>
</div>
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/78#issuecomment-1639739496">/reflect_and_review:</a></h4>)
[//]: # (<div align="center">)
[//]: # (<p float="center">)
[//]: # (<img src="https://www.codium.ai/images/reflect_and_review.gif" width="800">)
[//]: # (</p>)
[//]: # (</div>)
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695020538">/ask:</a></h4>)
[//]: # (<div align="center">)
[//]: # (<p float="center">)
[//]: # (<img src="https://www.codium.ai/images/ask-2.gif" width="800">)
[//]: # (</p>)
[//]: # (</div>)
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695024952">/improve:</a></h4>)
[//]: # (<div align="center">)
[//]: # (<p float="center">)
[//]: # (<img src="https://www.codium.ai/images/improve-2.gif" width="800">)
[//]: # (</p>)
[//]: # (</div>)
<div align="left">
</div>
<hr>
## Try it now
Try the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command.
For example, add a comment to any pull request with the following text:
```
@CodiumAI-Agent /review
```
and the agent will respond with a review of your PR
To set up your own PR-Agent, see the [Installation](https://pr-agent-docs.codium.ai/installation/) section below.
Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`.
---
[//]: # (## Installation)
[//]: # (To use your own version of PR-Agent, you first need to acquire two tokens:)
[//]: # ()
[//]: # (1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.)
[//]: # (2. A GitHub personal access token (classic) with the repo scope.)
[//]: # ()
[//]: # (There are several ways to use PR-Agent:)
[//]: # ()
[//]: # (**Locally**)
[//]: # (- [Using pip package](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package))
[//]: # (- [Using Docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image))
[//]: # (- [Run from source](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source))
[//]: # ()
[//]: # (**GitHub specific methods**)
[//]: # (- [Run as a GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action))
[//]: # (- [Run as a GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app))
[//]: # ()
[//]: # (**GitLab specific methods**)
[//]: # (- [Run a GitLab webhook server](https://pr-agent-docs.codium.ai/installation/gitlab/))
[//]: # ()
[//]: # (**BitBucket specific methods**)
[//]: # (- [Run as a Bitbucket Pipeline](https://pr-agent-docs.codium.ai/installation/bitbucket/))
## PR-Agent Pro 💎
[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\GitLab\BitBucket repo.
2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results.
See [here](https://pr-agent-docs.codium.ai/#pr-agent-pro) for a list of features available in PR-Agent Pro.
## How it works
The following diagram illustrates PR-Agent tools and their flow:
Check out the [PR Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt
## Why use PR-Agent?
A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
Here are some advantages of PR-Agent:
- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
- Our [PR Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs.
- Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
- We support **multiple git providers** (GitHub, Gitlab, Bitbucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
## Data privacy
### Self-hosted PR-Agent
- If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
https://openai.com/enterprise-privacy
### CodiumAI-hosted PR-Agent Pro 💎
- When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention.
- For certain clients, CodiumAI-hosted PR-Agent Pro will use CodiumAI’s proprietary models — if this is the case, you will be notified.
- No passive collection of Code and Pull Requests’ data — PR-Agent will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request.
### PR-Agent Chrome extension
- The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of PR-Agent.
## Links
[](https://discord.gg/kG35uSHDBc)
- Discord community: https://discord.gg/kG35uSHDBc
- CodiumAI site: https://codium.ai
- Blog: https://www.codium.ai/blog/
- Troubleshooting: https://www.codium.ai/blog/technical-faq-and-troubleshooting/
- Support: support@codium.ai
Raw data
{
"_id": null,
"home_page": null,
"name": "pr-agent",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Tal Ridnik <tal.r@codium.ai>, Ori Kotek <ori.k@codium.ai>, Hussam Lawen <hussam.l@codium.ai>",
"keywords": "AI, Agents, Pull Request, Automation, Code Review",
"author": null,
"author_email": "CodiumAI <tal.r@codium.ai>",
"download_url": "https://files.pythonhosted.org/packages/0d/2c/4236049e66f5ba5e1076a57b7cd023b846b8d6776501ed5bcb5abe4d6e92/pr_agent-0.2.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<div align=\"center\">\n\n\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://codium.ai/images/pr_agent/logo-dark.png\" width=\"330\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://codium.ai/images/pr_agent/logo-light.png\" width=\"330\">\n <img src=\"https://codium.ai/images/pr_agent/logo-light.png\" alt=\"logo\" width=\"330\">\n\n</picture>\n<br/>\nCodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions\n</div>\n\n[](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)\n[](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl)\n[](https://discord.com/channels/1057273017547378788/1126104260430528613)\n[](https://twitter.com/codiumai)\n <a href=\"https://github.com/Codium-ai/pr-agent/commits/main\">\n <img alt=\"GitHub\" src=\"https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge\" height=\"20\">\n </a>\n</div>\n\n### [Documentation](https://pr-agent-docs.codium.ai/)\n- See the [Installation Guide](https://pr-agent-docs.codium.ai/installation/) for instructions on installing PR-Agent on different platforms.\n\n- See the [Usage Guide](https://pr-agent-docs.codium.ai/usage-guide/) for instructions on running PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened.\n\n- See the [Tools Guide](https://pr-agent-docs.codium.ai/tools/) for a detailed description of the different tools, and the available configurations for each tool.\n\n\n## Table of Contents\n- [News and Updates](#news-and-updates)\n- [Overview](#overview)\n- [Example results](#example-results)\n- [Try it now](#try-it-now)\n- [PR-Agent Pro \ud83d\udc8e](#pr-agent-pro-)\n- [How it works](#how-it-works)\n- [Why use PR-Agent?](#why-use-pr-agent)\n \n## News and Updates\n\n### May 19, 2024\nGPT-4o is now the default fast model (\"Turbo\"). This model will be used for all commands except `review` and `improve`, which will still use \"GPT-4-2024-04-09\", since they are harder and would still benefit from the larger model.\n\n### May 12, 2024\nInspired by [AlphaCodium](https://github.com/Codium-ai/AlphaCodium) flow engineering scheme, PR-Agent now performs **self-reflection** on the code suggestions it provides,\nenabling to remove invalid suggestions, and score the valid ones. The suggestions will be presented sorted by their score, enabling to focus on the most important ones first.\n\nYou can also choose to automatically remove suggestions below a certain importance score threshold, by setting the `pr_code_suggestions.suggestions_score_threshold` [configuration](https://pr-agent-docs.codium.ai/tools/improve/#configuration-options).\n\n<kbd><img src=\"https://codium.ai/images/pr_agent/self_reflection1.png\" width=\"512\"></kbd>\n\n<kbd><img src=\"https://codium.ai/images/pr_agent/self_reflection2.png\" width=\"512\"></kbd>\n\n\n### May 2, 2024\nCheck out the new [PR-Agent Chrome Extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) \ud83d\ude80\ud83d\ude80\ud83d\ude80\n\nThis toolbar integrates seamlessly with your GitHub environment, allowing you to access PR-Agent tools [directly from the GitHub interface](https://www.youtube.com/watch?v=gT5tli7X4H4).\nYou can also easily export your chosen configuration, and use it for the automatic commands.\n\n<kbd><img src=\"https://codium.ai/images/pr_agent/toolbar1.png\" width=\"512\"></kbd>\n\n<kbd><img src=\"https://codium.ai/images/pr_agent/toolbar2.png\" width=\"512\"></kbd>\n\n## Overview\n<div style=\"text-align:left;\">\n\nSupported commands per platform:\n\n| | | GitHub | Gitlab | Bitbucket | Azure DevOps |\n|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:|\n| TOOLS | Review | \u2705 | \u2705 | \u2705 | \u2705 |\n| | \u2b91 Incremental | \u2705 | | | |\n| | \u2b91 [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) \ud83d\udc8e | \u2705 | \u2705 | \u2705 | \u2705 |\n| | Describe | \u2705 | \u2705 | \u2705 | \u2705 |\n| | \u2b91 [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) \ud83d\udc8e | \u2705 | | | |\n| | Improve | \u2705 | \u2705 | \u2705 | \u2705 |\n| | \u2b91 Extended | \u2705 | \u2705 | \u2705 | \u2705 |\n| | Ask | \u2705 | \u2705 | \u2705 | \u2705 |\n| | \u2b91 [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | \u2705 | \u2705 | | |\n| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) \ud83d\udc8e | \u2705 | \u2705 | \u2705 | \u2705 |\n| | [Test](https://pr-agent-docs.codium.ai/tools/test/) \ud83d\udc8e | \u2705 | \u2705 | | \u2705 |\n| | Reflect and Review | \u2705 | \u2705 | \u2705 | \u2705 |\n| | Update CHANGELOG.md | \u2705 | \u2705 | \u2705 | \u2705 |\n| | Find Similar Issue | \u2705 | | | |\n| | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) \ud83d\udc8e | \u2705 | \u2705 | | \u2705 |\n| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) \ud83d\udc8e | \u2705 | \u2705 | | \u2705 |\n| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) \ud83d\udc8e | \u2705 | \u2705 | | \u2705 |\n| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) \ud83d\udc8e | \u2705 | | | |\n| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) \ud83d\udc8e | \u2705 | | | |\n| | | | | | |\n| USAGE | CLI | \u2705 | \u2705 | \u2705 | \u2705 |\n| | App / webhook | \u2705 | \u2705 | \u2705 | \u2705 |\n| | Tagging bot | \u2705 | | | |\n| | Actions | \u2705 | | \u2705 | |\n| | | | | | |\n| CORE | PR compression | \u2705 | \u2705 | \u2705 | \u2705 |\n| | Repo language prioritization | \u2705 | \u2705 | \u2705 | \u2705 |\n| | Adaptive and token-aware file patch fitting | \u2705 | \u2705 | \u2705 | \u2705 |\n| | Multiple models support | \u2705 | \u2705 | \u2705 | \u2705 |\n| | [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) \ud83d\udc8e | \u2705 | \u2705 | \u2705 | \u2705 |\n| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) \ud83d\udc8e | \u2705 | \u2705 | \u2705 | \u2705 |\n| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) \ud83d\udc8e | \u2705 | | | |\n- \ud83d\udc8e means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/)\n\n[//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md))\n___\n\n\u2023 **Auto Description ([`/describe`](https://pr-agent-docs.codium.ai/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.\n\\\n\u2023 **Auto Review ([`/review`](https://pr-agent-docs.codium.ai/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.\n\\\n\u2023 **Code Suggestions ([`/improve`](https://pr-agent-docs.codium.ai/tools/improve/))**: Code suggestions for improving the PR.\n\\\n\u2023 **Question Answering ([`/ask ...`](https://pr-agent-docs.codium.ai/tools/ask/))**: Answering free-text questions about the PR.\n\\\n\u2023 **Update Changelog ([`/update_changelog`](https://pr-agent-docs.codium.ai/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes.\n\\\n\u2023 **Find Similar Issue ([`/similar_issue`](https://pr-agent-docs.codium.ai/tools/similar_issues/))**: Automatically retrieves and presents similar issues.\n\\\n\u2023 **Add Documentation \ud83d\udc8e ([`/add_docs`](https://pr-agent-docs.codium.ai/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR.\n\\\n\u2023 **Generate Custom Labels \ud83d\udc8e ([`/generate_labels`](https://pr-agent-docs.codium.ai/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user.\n\\\n\u2023 **Analyze \ud83d\udc8e ([`/analyze`](https://pr-agent-docs.codium.ai/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.\n\\\n\u2023 **Custom Prompt \ud83d\udc8e ([`/custom_prompt`](https://pr-agent-docs.codium.ai/tools/custom_prompt/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.\n\\\n\u2023 **Generate Tests \ud83d\udc8e ([`/test component_name`](https://pr-agent-docs.codium.ai/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes.\n\\\n\u2023 **CI Feedback \ud83d\udc8e ([`/checks ci_job`](https://pr-agent-docs.codium.ai/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.\n\\\n\u2023 **Similar Code \ud83d\udc8e ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.\n___\n\n## Example results\n</div>\n<h4><a href=\"https://github.com/Codium-ai/pr-agent/pull/530\">/describe</a></h4>\n<div align=\"center\">\n<p float=\"center\">\n<img src=\"https://www.codium.ai/images/pr_agent/describe_new_short_main.png\" width=\"512\">\n</p>\n</div>\n<hr>\n\n<h4><a href=\"https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151\">/review</a></h4>\n<div align=\"center\">\n<p float=\"center\">\n<kbd>\n<img src=\"https://www.codium.ai/images/pr_agent/review_new_short_main.png\" width=\"512\">\n</kbd>\n</p>\n</div>\n<hr>\n\n<h4><a href=\"https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159\">/improve</a></h4>\n<div align=\"center\">\n<p float=\"center\">\n<kbd>\n<img src=\"https://www.codium.ai/images/pr_agent/improve_new_short_main.png\" width=\"512\">\n</kbd>\n</p>\n</div>\n<hr>\n\n<h4><a href=\"https://github.com/Codium-ai/pr-agent/pull/530\">/generate_labels</a></h4>\n<div align=\"center\">\n<p float=\"center\">\n<kbd><img src=\"https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png\" width=\"300\"></kbd>\n</p>\n</div>\n\n[//]: # (<h4><a href=\"https://github.com/Codium-ai/pr-agent/pull/78#issuecomment-1639739496\">/reflect_and_review:</a></h4>)\n\n[//]: # (<div align=\"center\">)\n\n[//]: # (<p float=\"center\">)\n\n[//]: # (<img src=\"https://www.codium.ai/images/reflect_and_review.gif\" width=\"800\">)\n\n[//]: # (</p>)\n\n[//]: # (</div>)\n\n[//]: # (<h4><a href=\"https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695020538\">/ask:</a></h4>)\n\n[//]: # (<div align=\"center\">)\n\n[//]: # (<p float=\"center\">)\n\n[//]: # (<img src=\"https://www.codium.ai/images/ask-2.gif\" width=\"800\">)\n\n[//]: # (</p>)\n\n[//]: # (</div>)\n\n[//]: # (<h4><a href=\"https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695024952\">/improve:</a></h4>)\n\n[//]: # (<div align=\"center\">)\n\n[//]: # (<p float=\"center\">)\n\n[//]: # (<img src=\"https://www.codium.ai/images/improve-2.gif\" width=\"800\">)\n\n[//]: # (</p>)\n\n[//]: # (</div>)\n<div align=\"left\">\n\n\n</div>\n<hr>\n\n\n## Try it now\n\nTry the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command.\nFor example, add a comment to any pull request with the following text:\n```\n@CodiumAI-Agent /review\n```\nand the agent will respond with a review of your PR\n\n\n\n\nTo set up your own PR-Agent, see the [Installation](https://pr-agent-docs.codium.ai/installation/) section below.\nNote that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`.\n\n---\n\n[//]: # (## Installation)\n\n[//]: # (To use your own version of PR-Agent, you first need to acquire two tokens:)\n\n[//]: # ()\n[//]: # (1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.)\n\n[//]: # (2. A GitHub personal access token (classic) with the repo scope.)\n\n[//]: # ()\n[//]: # (There are several ways to use PR-Agent:)\n\n[//]: # ()\n[//]: # (**Locally**)\n\n[//]: # (- [Using pip package](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package))\n\n[//]: # (- [Using Docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image))\n\n[//]: # (- [Run from source](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source))\n\n[//]: # ()\n[//]: # (**GitHub specific methods**)\n\n[//]: # (- [Run as a GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action))\n\n[//]: # (- [Run as a GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app))\n\n[//]: # ()\n[//]: # (**GitLab specific methods**)\n\n[//]: # (- [Run a GitLab webhook server](https://pr-agent-docs.codium.ai/installation/gitlab/))\n\n[//]: # ()\n[//]: # (**BitBucket specific methods**)\n\n[//]: # (- [Run as a Bitbucket Pipeline](https://pr-agent-docs.codium.ai/installation/bitbucket/))\n\n## PR-Agent Pro \ud83d\udc8e\n[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:\n1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\\GitLab\\BitBucket repo.\n2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.\n3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.\n4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. \nSee [here](https://pr-agent-docs.codium.ai/#pr-agent-pro) for a list of features available in PR-Agent Pro.\n\n\n\n## How it works\n\nThe following diagram illustrates PR-Agent tools and their flow:\n\n\n\nCheck out the [PR Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt\n\n## Why use PR-Agent?\n\nA reasonable question that can be asked is: `\"Why use PR-Agent? What makes it stand out from existing tools?\"`\n\nHere are some advantages of PR-Agent:\n\n- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.\n- Our [PR Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs.\n- Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.\n- We support **multiple git providers** (GitHub, Gitlab, Bitbucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).\n\n\n## Data privacy\n\n### Self-hosted PR-Agent\n\n- If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:\nhttps://openai.com/enterprise-privacy\n\n### CodiumAI-hosted PR-Agent Pro \ud83d\udc8e\n\n- When using PR-Agent Pro \ud83d\udc8e, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention.\n\n- For certain clients, CodiumAI-hosted PR-Agent Pro will use CodiumAI\u2019s proprietary models \u2014 if this is the case, you will be notified.\n\n- No passive collection of Code and Pull Requests\u2019 data \u2014 PR-Agent will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request.\n\n### PR-Agent Chrome extension\n\n- The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of PR-Agent.\n\n## Links\n\n[](https://discord.gg/kG35uSHDBc)\n\n- Discord community: https://discord.gg/kG35uSHDBc\n- CodiumAI site: https://codium.ai\n- Blog: https://www.codium.ai/blog/\n- Troubleshooting: https://www.codium.ai/blog/technical-faq-and-troubleshooting/\n- Support: support@codium.ai\n",
"bugtrack_url": null,
"license": " Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright [2023] [Codium ltd] Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
"summary": "CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions.",
"version": "0.2.2",
"project_urls": {
"Documentation": "https://pr-agent-docs.codium.ai/",
"Homepage": "https://github.com/Codium-ai/pr-agent"
},
"split_keywords": [
"ai",
" agents",
" pull request",
" automation",
" code review"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88888c1e6e12fc89d8c562be24c6669451cc5bb2797db7580e30c47504687037",
"md5": "fbf166a7ed124b3ff1e065134d3b1024",
"sha256": "14a56d370e335ee12b2341364ba0945a8caef4b5d0af6d89df29939d38ccb7fc"
},
"downloads": -1,
"filename": "pr_agent-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fbf166a7ed124b3ff1e065134d3b1024",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 177247,
"upload_time": "2024-05-20T06:30:25",
"upload_time_iso_8601": "2024-05-20T06:30:25.850627Z",
"url": "https://files.pythonhosted.org/packages/88/88/8c1e6e12fc89d8c562be24c6669451cc5bb2797db7580e30c47504687037/pr_agent-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d2c4236049e66f5ba5e1076a57b7cd023b846b8d6776501ed5bcb5abe4d6e92",
"md5": "1f0f04751b3ebe8fcec3f1ba48a5a43b",
"sha256": "29bbd4ced10e0960e8b21f1e589ba70f4b5759621bf9eef46cf417b1ff5bb866"
},
"downloads": -1,
"filename": "pr_agent-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "1f0f04751b3ebe8fcec3f1ba48a5a43b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 139967,
"upload_time": "2024-05-20T06:30:27",
"upload_time_iso_8601": "2024-05-20T06:30:27.647753Z",
"url": "https://files.pythonhosted.org/packages/0d/2c/4236049e66f5ba5e1076a57b7cd023b846b8d6776501ed5bcb5abe4d6e92/pr_agent-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-20 06:30:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Codium-ai",
"github_project": "pr-agent",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
"==",
"3.9.1"
]
]
},
{
"name": "atlassian-python-api",
"specs": [
[
"==",
"3.41.4"
]
]
},
{
"name": "azure-devops",
"specs": [
[
"==",
"7.1.0b3"
]
]
},
{
"name": "azure-identity",
"specs": [
[
"==",
"1.15.0"
]
]
},
{
"name": "boto3",
"specs": [
[
"==",
"1.33.6"
]
]
},
{
"name": "dynaconf",
"specs": [
[
"==",
"3.2.4"
]
]
},
{
"name": "fastapi",
"specs": [
[
"==",
"0.99.0"
]
]
},
{
"name": "GitPython",
"specs": [
[
"==",
"3.1.32"
]
]
},
{
"name": "google-cloud-aiplatform",
"specs": [
[
"==",
"1.35.0"
]
]
},
{
"name": "google-cloud-storage",
"specs": [
[
"==",
"2.10.0"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"==",
"3.1.2"
]
]
},
{
"name": "litellm",
"specs": [
[
"==",
"1.31.10"
]
]
},
{
"name": "loguru",
"specs": [
[
"==",
"0.7.2"
]
]
},
{
"name": "msrest",
"specs": [
[
"==",
"0.7.1"
]
]
},
{
"name": "openai",
"specs": [
[
"==",
"1.13.3"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"7.4.0"
]
]
},
{
"name": "PyGithub",
"specs": [
[
"==",
"1.59.*"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "python-gitlab",
"specs": [
[
"==",
"3.15.0"
]
]
},
{
"name": "retry",
"specs": [
[
"==",
"0.9.2"
]
]
},
{
"name": "starlette-context",
"specs": [
[
"==",
"0.3.6"
]
]
},
{
"name": "tiktoken",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "ujson",
"specs": [
[
"==",
"5.8.0"
]
]
},
{
"name": "uvicorn",
"specs": [
[
"==",
"0.22.0"
]
]
},
{
"name": "tenacity",
"specs": [
[
"==",
"8.2.3"
]
]
}
],
"lcname": "pr-agent"
}
