Camel.toolkits.github toolkit

​

GithubToolkit

class GithubToolkit(BaseToolkit):

• access_token (str, optional): The access token to authenticate with GitHub. If not provided, it will be obtained using the get_github_access_token method.

​

init

def __init__(
    self,
    access_token: Optional[str] = None,
    timeout: Optional[float] = None
):

• repo_name (str): The name of the GitHub repository.
• access_token (str, optional): The access token to authenticate with GitHub. If not provided, it will be obtained using the get_github_access_token method.

​

get_github_access_token

def get_github_access_token(self):

​

github_create_pull_request

def github_create_pull_request(
    self,
    repo_name: str,
    file_path: str,
    new_content: str,
    pr_title: str,
    body: str,
    branch_name: str
):

• repo_name (str): The name of the GitHub repository.
• file_path (str): The path of the file to be updated in the repository.
• new_content (str): The specified new content of the specified file.
• pr_title (str): The title of the issue that is solved by this pull request.
• body (str): The commit message for the pull request.
• branch_name (str): The name of the branch to create and submit the pull request from.

​

github_get_issue_list

def github_get_issue_list(
    self,
    repo_name: str,
    state: Literal['open', 'closed', 'all'] = 'all'
):

• repo_name (str): The name of the GitHub repository.
• state (Literal["open", "closed", "all"]): The state of pull requests to retrieve. (default: :obj:all) Options are: - “open”: Retrieve only open pull requests. - “closed”: Retrieve only closed pull requests. - “all”: Retrieve all pull requests, regardless of state.

​

github_get_issue_content

def github_get_issue_content(self, repo_name: str, issue_number: int):

• repo_name (str): The name of the GitHub repository.
• issue_number (int): The number of the issue to retrieve.

​

github_get_pull_request_list

def github_get_pull_request_list(
    self,
    repo_name: str,
    state: Literal['open', 'closed', 'all'] = 'all'
):

• repo_name (str): The name of the GitHub repository.
• state (Literal["open", "closed", "all"]): The state of pull requests to retrieve. (default: :obj:all) Options are: - “open”: Retrieve only open pull requests. - “closed”: Retrieve only closed pull requests. - “all”: Retrieve all pull requests, regardless of state.

​

github_get_pull_request_code

def github_get_pull_request_code(self, repo_name: str, pr_number: int):

• repo_name (str): The name of the GitHub repository.
• pr_number (int): The number of the pull request to retrieve.

​

github_get_pull_request_comments

def github_get_pull_request_comments(self, repo_name: str, pr_number: int):

• repo_name (str): The name of the GitHub repository.
• pr_number (int): The number of the pull request to retrieve.

​

github_get_all_file_paths

def github_get_all_file_paths(self, repo_name: str, path: str = ''):

• repo_name (str): The name of the GitHub repository.
• path (str): The repository path to start the traversal from. empty string means starts from the root directory. (default: :obj:"")

​

github_retrieve_file_content

def github_retrieve_file_content(self, repo_name: str, file_path: str):

• repo_name (str): The name of the GitHub repository.
• file_path (str): The path of the file to retrieve.

​

get_tools

def get_tools(self):

​

create_pull_request

def create_pull_request(self, *args, **kwargs):

​

get_issue_list

def get_issue_list(self, *args, **kwargs):

​

get_issue_content

def get_issue_content(self, *args, **kwargs):

​

get_pull_request_list

def get_pull_request_list(self, *args, **kwargs):

​

get_pull_request_code

def get_pull_request_code(self, *args, **kwargs):

​

get_pull_request_comments

def get_pull_request_comments(self, *args, **kwargs):

​

get_all_file_paths

def get_all_file_paths(self, *args, **kwargs):

​

retrieve_file_content

def retrieve_file_content(self, *args, **kwargs):