GitHub Issue Creator

A Python library for creating GitHub issues programmatically using the GitHub REST API.

Summary

• Installation
• Usage
  • Import the necessary modules
  • Initialize IssueCreator
  • Create an Issue object
  • Create the issue on GitHub
• Exceptions
• Configuration Notes
• Contributors

Installation

First, install the library via pip (if it's not already installed):

pip install github-issue-creator

Usage

Import the necessary modules

from github_issue_creator import IssueCreator, Issue, IssueCreationError

Initialize IssueCreator

You'll need a GitHub Personal Access Token (PAT), the repository owner's username, and the repository name.

token = "your_github_token"
repo_owner = "your_github_username"
repo_name = "your_repository_name"

creator = IssueCreator(token, repo_owner, repo_name)

Create an Issue object

The Issue model should contain the issue details such as title, body, assignees, labels, etc.

issue = Issue(
    title="Sample Issue Title",
    body="This is the description of the issue.",
    assignees=["octocat"],  # Optional: list of GitHub usernames to assign
    labels=["bug", "help wanted"]  # Optional: list of labels
)

Create the issue on GitHub

Call the create method to post the issue.

try:
    creator.create(issue)
except IssueCreationError as e:
    print(f"Failed to create issue: {e}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
        print(f"Response: {e.response_text}")

If successful, it will return an IssueResponse object containing details of the created issue, including the issue URL, repository URL, issue ID, number, title, state, creation date, and the author's username.

For example, it may look like this:

IssueResponse(
    repository_url="https://github.com/fake_owner/fake_repo",
    issue_url="https://github.com/fake_owner/fake_repo/issues/1",
    issue_id=123456,
    issue_number=1,
    issue_title="Test",
    issue_state="open",
    created_at="2024-06-01T00:00:00Z",
    author="test_user"
)

Exceptions

• IssueCreationError: Raised if the issue creation fails due to an HTTP error or a request exception.

Configuration Notes

• Make sure your GitHub token has the correct permissions to create issues in the repository.
• The Issue model should be defined based on the GitHub API's expected fields (check the library's models/issue.py for the schema).

Contributors

Thanks to the following people who have contributed to this project:

• pzzzl - Maintainer
• BrunoSantanaS

Feel free to open a pull request or report any issues you encounter. Your contributions are always welcome!