From cfea8caf1c5d0540ecceca037cb10aa30501d5ff Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sat, 23 Mar 2024 11:13:20 +0200 Subject: [PATCH] adjustments to pypi --- README.md | 3 +++ docs/docs/installation/locally.md | 14 ++++++-------- requirements-dev.txt | 2 ++ 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 831d67de..d5cfb7a2 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,9 @@ Making pull requests less painful with an AI agent ## News and Updates +### Jan 24, 2024 +PR-Agent is now available for easy installation via [pip](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package). + ### Jan 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. diff --git a/docs/docs/installation/locally.md b/docs/docs/installation/locally.md index 13f7d5d4..e493862a 100644 --- a/docs/docs/installation/locally.md +++ b/docs/docs/installation/locally.md @@ -1,20 +1,18 @@ -## Using Pip package +## Using pip package -1. Install the package: +Install the package: ``` pip install pr-agent ``` -2. Run the relevant tool. Make sure to fill in the required parameters (`user_token`, `openai_key`, `pr_url`, `command`): +Then run the relevant tool with the script below. +
+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 -from pr_agent.log import setup_logger - -setup_logger() - def main(): # Fill in the following values @@ -41,7 +39,7 @@ if __name__ == '__main__': main() ``` -## Use Docker image (no installation required) +## Using Docker image A list of the relevant tools can be found in the [tools guide](../tools/ask.md). diff --git a/requirements-dev.txt b/requirements-dev.txt index 70613be0..1af82d00 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1 +1,3 @@ pytest==7.4.0 +poetry +twine \ No newline at end of file