Component Libraries • Project Templates
Docs • Install • Tutorials • Developer Guides • Contribute • Blog • Discord

Xircuits Component Library for GitHub! Seamlessly integrate GitHub operations into your Xircuits workflows.

---

Xircuits Component Library for GitHub

This library provides Xircuits components to interact with GitHub, enabling seamless automation of repository management, issue tracking, and pull request operations.

Table of Contents

• Prerequisites
• Main Xircuits Components
• Installation

Prerequisites

Before you begin, make sure you have the following:

1. Python 3.9+.
2. Xircuits.
3. A GitHub account with a personal access token (PAT) configured.

• A valid GitHub token set as an environment variable or provided directly to the components.

Main Xircuits Components

Authorization Component

• GithubAuthorize Component: Authorizes a GitHub client using a token or environment variables.

  

Issue Management Components

• GithubListIssues Component: Lists issues in a GitHub repository.

  

• GithubGetIssue Component: Retrieves details of a specific issue.

• GithubCreateIssue Component: Creates a new issue in a repository.

Pull Request Components

• GithubListPullRequests Component: Lists pull requests in a GitHub repository.
• GithubCreatePullRequest Component: Creates a new pull request.
• GithubReadPullRequestComments Component: Reads comments from a pull request.
• GithubAddPullRequestComment Component: Adds a comment to a pull request.

Installation

To use this component library, ensure that you have an existing Xircuits setup. You can then install the GitHub library using the component library interface, or through the CLI using:

xircuits install github

You can also install it manually by cloning the repository:

# base Xircuits directory

git clone https://github.com/XpressAI/xai-github xai_components/xai_github
pip install -r xai_components/xai_github/requirements.txt