GitHubIssueExtractor
Project description
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
requestslibrary
Installation
Follow either Installation Type 1 or Installation Type 2
Installation Type 1
pip install github-issue-extractor
Installation Type 2
- Clone the repository:
git clone https://github.com/ssinha2103/github-issues_to_excel - 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:
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
milestone_number: The milestone number you want to filter issues by.access_token: Your GitHub personal access token for authentication. Follow these instructions to create a personal access token.repo_name: The name of the repository from which you want to extract issues.owner: The username of the repository owner.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file github_issue_extractor-0.1.4.tar.gz.
File metadata
- Download URL: github_issue_extractor-0.1.4.tar.gz
- Upload date:
- Size: 2.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f00966a2345399256220e32376fdfdf51f3d9ace05be1f811ec9ac0249b97f8b
|
|
| MD5 |
59fa512380713ac73864dc70102790d5
|
|
| BLAKE2b-256 |
ce55cce0a63d182df4a37404044d82df2983a661c22b57c3902dd76edb2a8b52
|
File details
Details for the file github_issue_extractor-0.1.4-py3-none-any.whl.
File metadata
- Download URL: github_issue_extractor-0.1.4-py3-none-any.whl
- Upload date:
- Size: 2.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eb0a8247fe81f6e62ce908b586fa2e0993dbd36839088120cdc107f69db6d52a
|
|
| MD5 |
884d88dd93452f1872bfeb086d7234c9
|
|
| BLAKE2b-256 |
aa391d26a8e153daf7b4345bfaabbc0a10b27a154c51f24d0ce50622acd5c3fe
|