adjustments to pypi

This commit is contained in:
mrT23
2024-03-23 11:13:20 +02:00
parent 9a46690121
commit cfea8caf1c
3 changed files with 11 additions and 8 deletions

View File

@ -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.

View File

@ -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.
<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
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).

View File

@ -1 +1,3 @@
pytest==7.4.0
poetry
twine