Tr/pypi

MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include pr_agent *.toml
+recursive-exclude pr_agent *.secrets.toml

README.md

@@ -6,7 +6,8 @@
 <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 alt="logo">
+ <img src="https://codium.ai/images/pr_agent/logo-light.png" alt="logo" width="330">
+
 </picture>
 <br/>
 Making pull requests less painful with an AI agent
@@ -32,16 +33,19 @@ Making pull requests less painful with an AI agent
 
 ## News and Updates
 
-### Jan 17, 2024
+### March 24, 2024
+PR-Agent is now available for easy installation via [pip](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package).
+
+### March 17, 2024
 - A new feature is now available for the review tool: [`require_can_be_split_review`](https://pr-agent-docs.codium.ai/tools/review/#enabledisable-features). 
 If set to true, the tool will add a section that checks if the PR contains several themes, and can be split into smaller PRs.
 
 <kbd><img src="https://codium.ai/images/pr_agent/multiple_pr_themes.png" width="512"></kbd>
 
-### Jan 10, 2024
+### March 10, 2024
 - A new [knowledge-base website](https://pr-agent-docs.codium.ai/) for PR-Agent is now available. It includes detailed information about the different tools, usage guides and more, in an accessible and organized format.
 
-### Jan 8, 2024
+### March 8, 2024
 
 - A new tool, [Find Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 is now available. 
 <br>This tool retrieves the most similar code components from inside the organization's codebase, or from open-source code:
@@ -59,7 +63,7 @@ If set to true, the tool will add a section that checks if the PR contains sever
 ## Overview
 <div style="text-align:left;">
 
-CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests.
+CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions
 
 - See the [Installation Guide](https://pr-agent-docs.codium.ai/installation/) for instructions on installing and running the tool on different git platforms.
 
@@ -71,38 +75,38 @@ Supported commands per platform:
 
 | | | GitHub | Gitlab | Bitbucket | Azure DevOps |
 |-------|-------------------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:|
-| TOOLS | Review | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | ⮑ Incremental | :white_check_mark: | | | |
-| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | Describe | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | :white_check_mark: | | | |
-| | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | ⮑ Extended | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | Ask | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | :white_check_mark: | :white_check_mark: | | |
-| | [Custom Suggestions](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
-| | Reflect and Review | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | Update CHANGELOG.md | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | Find Similar Issue | :white_check_mark: | | | |
-| | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
-| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
-| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
-| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | :white_check_mark: | | | |
-| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | :white_check_mark: | | | |
+| 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 Suggestions](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) 💎 | ✅ | ✅ | ✅ | ✅ |
+| | [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 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | App / webhook | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | Tagging bot | :white_check_mark: | | | |
-| | Actions | :white_check_mark: | | :white_check_mark: | |
+| USAGE | CLI | ✅ | ✅ | ✅ | ✅ |
+| | App / webhook | ✅ | ✅ | ✅ | ✅ |
+| | Tagging bot | ✅ | | | |
+| | Actions | ✅ | | ✅ | |
 | | | | | | |
-| CORE | PR compression | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | Repo language prioritization | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | Adaptive and token-aware file patch fitting | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | Multiple models support | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎 | :white_check_mark: | | | |
+| 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]&#40;./docs/Full_environments.md&#41;)
@@ -240,7 +244,8 @@ To use your own version of PR-Agent, you first need to acquire two tokens:
 There are several ways to use PR-Agent:
 
 **Locally**
-- [Use Docker image (no installation required)](https://pr-agent-docs.codium.ai/installation/locally/#use-docker-image-no-installation-required)
+- [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**

docs/docs/installation/locally.md

@@ -1,4 +1,45 @@
-## Use Docker image (no installation required)
+## Using pip package
+
+Install the package:
+
+```
+pip install pr-agent
+```
+
+Then run the relevant tool with the script below.
+<br>
+Make sure to fill in the required parameters (`user_token`, `openai_key`, `pr_url`, `command`):
+
+```python
+from pr_agent import cli
+from pr_agent.config_loader import get_settings
+
+def main():
+ # Fill in the following values
+ provider = "github" # GitHub provider
+ user_token = "..." # GitHub user token
+ openai_key = "..." # OpenAI key
+ pr_url = "..." # PR URL, for example 'https://github.com/Codium-ai/pr-agent/pull/809'
+ command = "/review" # Command to run (e.g. '/review', '/describe', '/ask="What is the purpose of this PR?"', ...)
+
+ # Setting the configurations
+ get_settings().set("CONFIG.git_provider", provider)
+ get_settings().set("openai.key", openai_key)
+ get_settings().set("github.user_token", user_token)
+
+ # Preparing the command
+ run_command = f"--pr_url={pr_url} {command.lstrip('/')}"
+ args = cli.set_parser().parse_args(run_command.split())
+
+ # Run the command. Feedback will appear in GitHub PR comments
+ cli.run(args=args)
+
+
+if __name__ == '__main__':
+ main()
+```
+
+## Using Docker image
 
 A list of the relevant tools can be found in the [tools guide](../tools/ask.md).
 

docs/docs/usage-guide/automations_and_usage.md

@@ -1,5 +1,5 @@
 ## Local repo (CLI)
-When running from your local repo (CLI), your local configuration file will be used.
+When running from your locally cloned PR-Agent repo (CLI), your local configuration file will be used.
 Examples of invoking the different tools via the CLI:
 
 - **Review**: `python -m pr_agent.cli --pr_url=<pr_url> review`

pr_agent/cli.py

@@ -9,48 +9,52 @@
 log_level = os.environ.get("LOG_LEVEL", "INFO")
 setup_logger(log_level)
 
-
-
-def run(inargs=None):
+def set_parser():
  parser = argparse.ArgumentParser(description='AI based pull request analyzer', usage=
-"""\
-Usage: cli.py --pr-url=<URL on supported git hosting service> <command> [<args>].
-For example:
-- cli.py --pr_url=... review
-- cli.py --pr_url=... describe
-- cli.py --pr_url=... improve
-- cli.py --pr_url=... ask "write me a poem about this PR"
-- cli.py --pr_url=... reflect
-- cli.py --issue_url=... similar_issue
+ """\
+ Usage: cli.py --pr-url=<URL on supported git hosting service> <command> [<args>].
+ For example:
+ - cli.py --pr_url=... review
+ - cli.py --pr_url=... describe
+ - cli.py --pr_url=... improve
+ - cli.py --pr_url=... ask "write me a poem about this PR"
+ - cli.py --pr_url=... reflect
+ - cli.py --issue_url=... similar_issue
 
-Supported commands:
-- review / review_pr - Add a review that includes a summary of the PR and specific suggestions for improvement.
+ Supported commands:
+ - review / review_pr - Add a review that includes a summary of the PR and specific suggestions for improvement.
 
-- ask / ask_question [question] - Ask a question about the PR.
+ - ask / ask_question [question] - Ask a question about the PR.
 
-- describe / describe_pr - Modify the PR title and description based on the PR's contents.
+ - describe / describe_pr - Modify the PR title and description based on the PR's contents.
 
-- improve / improve_code - Suggest improvements to the code in the PR as pull request comments ready to commit.
-Extended mode ('improve --extended') employs several calls, and provides a more thorough feedback
+ - improve / improve_code - Suggest improvements to the code in the PR as pull request comments ready to commit.
+ Extended mode ('improve --extended') employs several calls, and provides a more thorough feedback
 
-- reflect - Ask the PR author questions about the PR.
+ - reflect - Ask the PR author questions about the PR.
 
-- update_changelog - Update the changelog based on the PR's contents.
+ - update_changelog - Update the changelog based on the PR's contents.
 
-- add_docs
+ - add_docs
 
-- generate_labels
+ - generate_labels
 
 
-Configuration:
-To edit any configuration parameter from 'configuration.toml', just add -config_path=<value>.
-For example: 'python cli.py --pr_url=... review --pr_reviewer.extra_instructions="focus on the file: ..."'
-""")
+ Configuration:
+ To edit any configuration parameter from 'configuration.toml', just add -config_path=<value>.
+ For example: 'python cli.py --pr_url=... review --pr_reviewer.extra_instructions="focus on the file: ..."'
+ """)
  parser.add_argument('--pr_url', type=str, help='The URL of the PR to review', default=None)
  parser.add_argument('--issue_url', type=str, help='The URL of the Issue to review', default=None)
  parser.add_argument('command', type=str, help='The', choices=commands, default='review')
  parser.add_argument('rest', nargs=argparse.REMAINDER, default=[])
- args = parser.parse_args(inargs)
+ return parser
+
+
+def run(inargs=None, args=None):
+ parser = set_parser()
+ if not args:
+ args = parser.parse_args(inargs)
  if not args.pr_url and not args.issue_url:
  parser.print_help()
  return