Metadata-Version: 2.1
Name: gh_issues
Version: 0.0.3.dev16
License: MIT
Keywords: github,issues,markdown
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: publish
License-File: LICENSE

# 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>
