xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-04 12:50:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #590 from EduardDurech/patch-2

Browse Source 
Fixed Run from source instructions for Python
This commit is contained in:
Tal
2024-01-16 22:53:36 -08:00
committed by GitHub
parent 06f0235577 a58c385b0f
commit fae3bf6309
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
INSTALL.md
View File

@ -3,8 +3,8 @@
To get started with PR-Agent quickly, you first need to acquire two tokens: To get started with PR-Agent quickly, you first need to acquire two tokens:
1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4. 1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4.
2. A GitHub\GitLab\BitBucket personal access token (classic) with the repo scope. 2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens)]
There are several ways to use PR-Agent: There are several ways to use PR-Agent:
@ -79,12 +79,14 @@ codiumai/pr-agent@v0.9
git clone https://github.com/Codium-ai/pr-agent.git git clone https://github.com/Codium-ai/pr-agent.git
``` ```
2. Install the requirements in your favorite virtual environment: 2. Navigate to the `/pr-agent` folder and install the requirements in your favorite virtual environment:
``` ```
pip install -r requirements.txt pip install -e .
``` ```
*Note: If you get an error related to Rust in the dependency installation then make sure Rust is installed and in your `PATH`, instructions: https://rustup.rs*
3. Copy the secrets template file and fill in your OpenAI key and your GitHub user token: 3. Copy the secrets template file and fill in your OpenAI key and your GitHub user token:
``` ```
@ -93,10 +95,9 @@ chmod 600 pr_agent/settings/.secrets.toml
# Edit .secrets.toml file # Edit .secrets.toml file
``` ```
4. Add the pr_agent folder to your PYTHONPATH, then run the cli.py script: 4. Run the cli.py script:
``` ```
export PYTHONPATH=[$PYTHONPATH:]<PATH to pr_agent folder>
python3 -m pr_agent.cli --pr_url <pr_url> review python3 -m pr_agent.cli --pr_url <pr_url> review
python3 -m pr_agent.cli --pr_url <pr_url> ask <your question> python3 -m pr_agent.cli --pr_url <pr_url> ask <your question>
python3 -m pr_agent.cli --pr_url <pr_url> describe python3 -m pr_agent.cli --pr_url <pr_url> describe
@ -107,6 +108,11 @@ python3 -m pr_agent.cli --issue_url <issue_url> similar_issue
... ...
``` ```
[Optional] Add the pr_agent folder to your PYTHONPATH
```
export PYTHONPATH=$PYTHONPATH:<PATH to pr_agent folder>
```
--- ---
### Run as a GitHub Action ### Run as a GitHub Action