Metadata-Version: 2.1
Name: github_issue_extractor
Version: 0.1.4
Summary: GitHubIssueExtractor
Home-page: https://github.com/ssinha2103/github-issues_to_excel
Author: Sudarshan Sinha
Author-email: s.sinha2103@outlook.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# GitHub Issue Extractor

The GitHub Issue Extractor allows you to easily filter and extract issues from a GitHub repository based on a specified milestone number. It uses the GitHub API and requires an access token for authentication. This powerful utility writes the extracted information into an Excel file for convenient analysis and reporting.

## Features
- Extract issues from a specific GitHub repository
- Filter issues by milestone number
- Requires a GitHub access token for authentication

## Prerequisites
- Python 3.x
- `requests` library

## Installation 
 Follow either `Installation Type 1` or `Installation Type 2`

### Installation Type 1
1. `pip install github-issue-extractor`

### Installation Type 2
1. Clone the repository:
    `git clone https://github.com/ssinha2103/github-issues_to_excel`
2. Install the required dependencies:
    `pip install -r requirements.txt`

## Usage
To use the GitHub Issue Extractor, simply import the class and create an instance with the required parameters:

```python
from github_issue_extractor import GitHubIssueExtractor

milestone_number = 1
access_token = "your_access_token_here"
repo_name = "repository_name"
owner = "repository_owner"

extractor = GitHubIssueExtractor(milestone_number, access_token, repo_name, owner)
extractor.run()

```
Replace the values of `milestone_number`, `access_token`, `repo_name`, and `owner` with your desired settings.

## Parameters
1. `milestone_number`: The milestone number you want to filter issues by.
2. `access_token`: Your GitHub personal access token for authentication. Follow [these instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create a personal access token.
3. `repo_name`: The name of the repository from which you want to extract issues.
4. `owner`: The username of the repository owner.

## License
This project is licensed under the MIT License. See the LICENSE file for details.
