# GH Issues
GH Issues is a wrapper for the GitHub API Issues Endpoint that makes it easy to work with a Github Issue's body as a Python object.
## Installation
`pip install gh-issues`
## Usage
```python
from gh_issues import Repo, Issue
repo = Repo(
owner="python-community-news", repo="gh-issues"
)
issue = Issue(repo=repo, issue_number=1)
```
If the issue text is
```markdown
# Issue Header
This is some text
```
the issue would be represented as
```python
issue.issue_header
>>> "This is some text"
```
## Nested Issues
Nested issues are supported. If the issue text is
```markdown
# Issue Header
This is some text referencing issue #2
```
You can access the issue referenced by the issue
```python
for issue in Issue.get_content_issues('issue_header'):
print(issue.issue_header)
>>> <Issue - #2: This is the issue #2 Title by @user>
```
# Contributing
Review the [Contributing Guidelines](CONTRIBUTING.md) for information on how to contribute to this project.
# License
This project is licensed under the terms of the [MIT License](LICENSE).
# Code of Conduct
This project is governed by the Contributor Covenant [Code of Conduct](https://github.com/Python-Community-News/.github/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <kjaymiller@gmail.com>
Raw data
{
"_id": null,
"home_page": null,
"name": "gh-issues",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "github, issues, markdown",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9b/3e/9430040c672a6c2b1352911cd96b3cb73463d0f96dc0b4909c98096ed67e/gh_issues-2024.10.2a4.tar.gz",
"platform": null,
"description": "# GH Issues\n\nGH Issues is a wrapper for the GitHub API Issues Endpoint that makes it easy to work with a Github Issue's body as a Python object.\n\n## Installation\n\n`pip install gh-issues`\n\n## Usage\n\n```python\nfrom gh_issues import Repo, Issue\n\nrepo = Repo(\n owner=\"python-community-news\", repo=\"gh-issues\"\n )\nissue = Issue(repo=repo, issue_number=1)\n```\n\nIf the issue text is\n\n```markdown\n# Issue Header\nThis is some text\n```\nthe issue would be represented as\n\n```python\nissue.issue_header\n>>> \"This is some text\"\n```\n\n## Nested Issues\n\nNested issues are supported. If the issue text is\n\n```markdown\n# Issue Header\nThis is some text referencing issue #2\n```\n\nYou can access the issue referenced by the issue\n\n```python\nfor issue in Issue.get_content_issues('issue_header'):\n print(issue.issue_header)\n\n>>> <Issue - #2: This is the issue #2 Title by @user>\n```\n\n# Contributing\n\nReview the [Contributing Guidelines](CONTRIBUTING.md) for information on how to contribute to this project.\n\n# License\n\nThis project is licensed under the terms of the [MIT License](LICENSE).\n\n# Code of Conduct\n\nThis project is governed by the Contributor Covenant [Code of Conduct](https://github.com/Python-Community-News/.github/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <kjaymiller@gmail.com>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "2024.10.2a4",
"project_urls": null,
"split_keywords": [
"github",
" issues",
" markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "970a13bf02315061748bf79e345ecd3e63163ee8509d231f38891d3d6e6f606e",
"md5": "365e25ae8b6a310e1ea5a00348423552",
"sha256": "9a534e60049a52d4a120f92328de1f552f49238af03bbb29151ea718de34f0c4"
},
"downloads": -1,
"filename": "gh_issues-2024.10.2a4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "365e25ae8b6a310e1ea5a00348423552",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5813,
"upload_time": "2024-10-04T01:16:36",
"upload_time_iso_8601": "2024-10-04T01:16:36.117504Z",
"url": "https://files.pythonhosted.org/packages/97/0a/13bf02315061748bf79e345ecd3e63163ee8509d231f38891d3d6e6f606e/gh_issues-2024.10.2a4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b3e9430040c672a6c2b1352911cd96b3cb73463d0f96dc0b4909c98096ed67e",
"md5": "9a4c37307af3ce2dbb96c623c63076e1",
"sha256": "15b21f94bb2a57598929546bf83d6b39c606bc0b14894547b4abe40335f46fc5"
},
"downloads": -1,
"filename": "gh_issues-2024.10.2a4.tar.gz",
"has_sig": false,
"md5_digest": "9a4c37307af3ce2dbb96c623c63076e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14347,
"upload_time": "2024-10-04T01:16:37",
"upload_time_iso_8601": "2024-10-04T01:16:37.578343Z",
"url": "https://files.pythonhosted.org/packages/9b/3e/9430040c672a6c2b1352911cd96b3cb73463d0f96dc0b4909c98096ed67e/gh_issues-2024.10.2a4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 01:16:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gh-issues"
}
JSON