Pull-Request-AI-Agent

🤖 A bot helps developers open pull request with details.

Overview | Python versions support | Quickly Start | Configuration | Documentation

---

Overview

🚧 Clear brief of your lib

Python versions support

🚧 The required Python versions of this library

Quickly Start

🚧 The details of quickly start as simple demonstration for users

Configuration

Pull request AI agent can be configured in multiple ways:

1. Command Line Arguments: Pass options directly when running the bot
2. Environment Variables: Set options using environment variables
3. Configuration File: Use a YAML configuration file

Configuration File

You can configure the bot using a YAML configuration file. By default, the bot will look for a configuration file at .github/pr-creator.yaml or .github/pr-creator.yml in your repository.

You can also specify a custom configuration file path using the --config command line argument:

poetry run python -m pr-ai-agent --config /path/to/your/config.yaml

Example Configuration File

# Git settings
git:
  repo_path: "."
  base_branch: "main"
  # branch_name: "feature/my-feature"  # Uncomment to specify a branch name

# GitHub settings
github:
  # token: "your-github-token"  # It's recommended to use environment variables for tokens
  repo: "owner/repo"

# AI settings
ai:
  client_type: "claude"  # Options: gpt, claude, gemini
  # api_key: "your-api-key"  # It's recommended to use environment variables for API keys

# Project management tool settings
project_management_tool:
  type: "clickup"  # Options: clickup, jira
  # api_key: "your-api-key"  # It's recommended to use environment variables for API keys
  # organization_id: "your-org-id"
  # project_id: "your-project-id"
  # base_url: "https://api.example.com"
  # username: "your-username"

Configuration Priority

The bot uses the following priority order when determining configuration values:

1. Command line arguments (highest priority)
2. Configuration file
3. Environment variables (lowest priority)

This means that command line arguments will override values from the configuration file, which will override environment variables.

Documentation

🚧 The details of documentation ...

Coding style and following rules

follows coding styles black and PyLint to control code quality.

Downloading state

🚧 The download state for your library

License

MIT License