| Name | github-issue-prompter JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | |
| Summary | Use AI to find GitHub issue's that you can work on (even if the issue's appear active)! |
| upload_time | 2024-02-08 19:46:18 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Luke Twist Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
github
issue
prompter
openai
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# *github-issue-prompter*
Use AI to find GitHub issue's that you can work on (even if the issue's appear active)!
<div>
<!-- badges from : https://shields.io/ -->
<!-- logos available : https://simpleicons.org/ -->
<a href="https://opensource.org/licenses/MIT">
<img alt="MIT License" src="https://img.shields.io/badge/Licence-MIT-C10606?style=for-the-badge&logo=docs&logoColor=white" />
</a>
<a href="https://www.python.org/">
<img alt="Python 3.10+" src="https://img.shields.io/badge/Python_3.10+-37709F?style=for-the-badge&logo=python&logoColor=white" />
</a>
<a href="https://openai.com/blog/openai-api">
<img alt="OpenAI API" src="https://img.shields.io/badge/OpenAI_API-412991?style=for-the-badge&logo=openai&logoColor=white" />
</a>
<a href="https://docs.github.com/en/graphql">
<img alt="GitHub GraphQL API" src="https://img.shields.io/badge/GitHub_GraphQL_API-181717?style=for-the-badge&logo=github&logoColor=white" />
</a>
</div>
## *about*
It can be hard to sift through open GitHub issues, especially when they seem to look busy or appear in limbo.
This python utility uses AI to analyse GitHub issues, finding those that are free to work on (even if they
look busy/taken at a first glance), and suggests comments to prompt the issue if it seems stale, or to offer
your hand at solving it. Taking the stress out of sifting through issues yourself!
## *installation*
Install directly from PyPI using pip:
```shell
pip install github-issue-prompter
```
## *tokens*
You need a GitHub personal access token and an OpenAI API token (to use the AI functionality).
You can store them in `PROMPTER_GITHUB_TOKEN` and `PROMPTER_OPENAI_TOKEN` environment variables,
or pass them in as arguments.
Instructions for how to get a GitHub personal access token from your GitHub account available
[here](https://docs.github.com/en/enterprise-server@3.6/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
Instructions for how to get an OpenAI API token available
[here](https://platform.openai.com/docs/quickstart/step-2-setup-your-api-key).
## *usage*
You can search for issue's across an organisation, or in a single repository.
Results will be displayed along with suggested comments to get started, or you can use the `post_comments`
argument to have comments posted automatically!
Once installed, you can either use the command line and the `prompt` command, with your desired arguments:
```shell
prompt -h
prompt pytorch -r pytorch
```
Or you can import and call the script via python:
```python
from github_issue_prompter import prompt_issues
prompt_issues(
organisation="pytorch",
repository="pytorch",
)
```
If you don't have access to the OpenAI API, or just want more basic functionality, you can use the `-s`/`--simple`
command line argument, or the `mode="simple"` keyword argument.
## *development*
Fork and clone the repository code:
```shell
git clone https://github.com/itsluketwist/github-issue-prompter.git
```
Once cloned, install the package locally in a virtual environment:
```shell
python -m venv venv
. venv/bin/activate
pip install -e ".[dev]"
```
Install and use pre-commit to ensure code is in a good state:
```shell
pre-commit install
pre-commit autoupdate
pre-commit run --all-files
```
## *testing*
(todo...) Run the test suite using:
```shell
pytest .
```
## *inspiration*
When getting into open source, I found that plenty of issues where in uncertain states. Either assigned but seemingly
inactive, or unassigned but with comments implying someone might be working on it. This made it hard to find suitable
issue's to get started on, and I figured it would be convenient to have an automatic tool to scan for these issue's
and prompt the assignees/maintainers to clear up the status.
## *todo*
- implement some tests
- expand use-cases and instructions above
- all api prompt config/options
Raw data
{
"_id": null,
"home_page": "",
"name": "github-issue-prompter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "github,issue,prompter,openai",
"author": "",
"author_email": "Lukas Twist <itsluketwist@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/39/8d/62560e3126a15c37aab5462fef955f24d65a114bbefebd14d8d2044fd7fa/github_issue_prompter-0.0.5.tar.gz",
"platform": null,
"description": "# *github-issue-prompter*\n\nUse AI to find GitHub issue's that you can work on (even if the issue's appear active)!\n\n\n\n\n<div>\n <!-- badges from : https://shields.io/ -->\n <!-- logos available : https://simpleicons.org/ -->\n <a href=\"https://opensource.org/licenses/MIT\">\n <img alt=\"MIT License\" src=\"https://img.shields.io/badge/Licence-MIT-C10606?style=for-the-badge&logo=docs&logoColor=white\" />\n </a>\n <a href=\"https://www.python.org/\">\n <img alt=\"Python 3.10+\" src=\"https://img.shields.io/badge/Python_3.10+-37709F?style=for-the-badge&logo=python&logoColor=white\" />\n </a>\n <a href=\"https://openai.com/blog/openai-api\">\n <img alt=\"OpenAI API\" src=\"https://img.shields.io/badge/OpenAI_API-412991?style=for-the-badge&logo=openai&logoColor=white\" />\n </a>\n <a href=\"https://docs.github.com/en/graphql\">\n <img alt=\"GitHub GraphQL API\" src=\"https://img.shields.io/badge/GitHub_GraphQL_API-181717?style=for-the-badge&logo=github&logoColor=white\" />\n </a>\n</div>\n\n## *about*\n\nIt can be hard to sift through open GitHub issues, especially when they seem to look busy or appear in limbo. \nThis python utility uses AI to analyse GitHub issues, finding those that are free to work on (even if they \nlook busy/taken at a first glance), and suggests comments to prompt the issue if it seems stale, or to offer \nyour hand at solving it. Taking the stress out of sifting through issues yourself!\n\n## *installation*\n\nInstall directly from PyPI using pip:\n\n```shell\npip install github-issue-prompter\n```\n\n## *tokens*\n\nYou need a GitHub personal access token and an OpenAI API token (to use the AI functionality).\nYou can store them in `PROMPTER_GITHUB_TOKEN` and `PROMPTER_OPENAI_TOKEN` environment variables,\nor pass them in as arguments.\n\nInstructions for how to get a GitHub personal access token from your GitHub account available \n[here](https://docs.github.com/en/enterprise-server@3.6/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).\n\nInstructions for how to get an OpenAI API token available \n[here](https://platform.openai.com/docs/quickstart/step-2-setup-your-api-key).\n\n\n## *usage*\n\nYou can search for issue's across an organisation, or in a single repository. \nResults will be displayed along with suggested comments to get started, or you can use the `post_comments` \nargument to have comments posted automatically!\n\nOnce installed, you can either use the command line and the `prompt` command, with your desired arguments:\n\n```shell\nprompt -h\n\nprompt pytorch -r pytorch\n```\n\nOr you can import and call the script via python:\n\n```python\nfrom github_issue_prompter import prompt_issues\n\nprompt_issues(\n organisation=\"pytorch\",\n repository=\"pytorch\",\n)\n```\n\nIf you don't have access to the OpenAI API, or just want more basic functionality, you can use the `-s`/`--simple`\ncommand line argument, or the `mode=\"simple\"` keyword argument.\n\n## *development*\n\nFork and clone the repository code:\n\n```shell\ngit clone https://github.com/itsluketwist/github-issue-prompter.git\n```\n\nOnce cloned, install the package locally in a virtual environment:\n\n```shell\npython -m venv venv\n\n. venv/bin/activate\n\npip install -e \".[dev]\"\n```\n\nInstall and use pre-commit to ensure code is in a good state:\n\n```shell\npre-commit install\n\npre-commit autoupdate\n\npre-commit run --all-files\n```\n\n\n## *testing*\n\n(todo...) Run the test suite using:\n\n```shell\npytest .\n```\n\n\n## *inspiration*\n\nWhen getting into open source, I found that plenty of issues where in uncertain states. Either assigned but seemingly \ninactive, or unassigned but with comments implying someone might be working on it. This made it hard to find suitable \nissue's to get started on, and I figured it would be convenient to have an automatic tool to scan for these issue's \nand prompt the assignees/maintainers to clear up the status.\n\n## *todo*\n\n- implement some tests\n- expand use-cases and instructions above\n- all api prompt config/options\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Luke Twist Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Use AI to find GitHub issue's that you can work on (even if the issue's appear active)!",
"version": "0.0.5",
"project_urls": {
"Code": "https://github.com/itsluketwist/github-issue-prompter",
"Download": "https://github.com/itsluketwist/github-issue-prompter/tags",
"Homepage": "https://github.com/itsluketwist/github-issue-prompter"
},
"split_keywords": [
"github",
"issue",
"prompter",
"openai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5cc1678820620a7f720a46b58dd4414d904631505d4268f466563a1f25107caa",
"md5": "5fb783c1f3ae934d82860b2891c6a502",
"sha256": "dced165d300eb4807276adf4e72be421bd7fec417cd8ff5c34d54d14031eb349"
},
"downloads": -1,
"filename": "github_issue_prompter-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fb783c1f3ae934d82860b2891c6a502",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 14378,
"upload_time": "2024-02-08T19:46:16",
"upload_time_iso_8601": "2024-02-08T19:46:16.604725Z",
"url": "https://files.pythonhosted.org/packages/5c/c1/678820620a7f720a46b58dd4414d904631505d4268f466563a1f25107caa/github_issue_prompter-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "398d62560e3126a15c37aab5462fef955f24d65a114bbefebd14d8d2044fd7fa",
"md5": "b6f7d55c9199955dfb69fe404931a90f",
"sha256": "e8b4ea2cc01fad8395258d28435ec19e75a92bd53d506f81f3bbc9a59458f823"
},
"downloads": -1,
"filename": "github_issue_prompter-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "b6f7d55c9199955dfb69fe404931a90f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 13289,
"upload_time": "2024-02-08T19:46:18",
"upload_time_iso_8601": "2024-02-08T19:46:18.241234Z",
"url": "https://files.pythonhosted.org/packages/39/8d/62560e3126a15c37aab5462fef955f24d65a114bbefebd14d8d2044fd7fa/github_issue_prompter-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 19:46:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "itsluketwist",
"github_project": "github-issue-prompter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "github-issue-prompter"
}
