| Name | fetch-github-issues JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Fetch all GitHub issues for a repository and save them as JSON |
| upload_time | 2024-07-29 17:35:21 |
| maintainer | None |
| docs_url | None |
| author | Simon Willison |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# fetch-github-issues
[](https://pypi.org/project/fetch-github-issues/)
[](https://github.com/simonw/fetch-github-issues/releases)
[](https://github.com/simonw/fetch-github-issues/actions/workflows/test.yml)
[](https://github.com/simonw/fetch-github-issues/blob/master/LICENSE)
Fetch all GitHub issues for a repository and save them as JSON
## Installation
Install this tool using `pip`:
```bash
pip install fetch-github-issues
```
## Usage
To fetch all issues from a GitHub repository:
```bash
fetch-github-issues owner/repo --all
```
Or for just specific issues:
```bash
fetch-github-issues owner/repo 1 2 3
```
Other options:
- `--key xxx`: GitHub API key - will use the `GITHUB_TOKEN` environment variable if this is not set.
- `--output path/to/dir`: Output directory to save JSON. Default is the current directory.
For more help, run:
```bash
fetch-github-issues --help
```
You can also use:
```bash
python -m fetch_github_issues --help
```
## Issue format
Issues will be saved in files called `1.json` and `2.json` and so on, where the filename is the issue number.
Each file will look like this:
```json
{
"issue": {
"GitHub API issue representation": "..."
},
"comments": [
{
"GitHub API comment representation": "..."
}
]
}
```
## Development
To contribute to this tool, first checkout the code. Then create a new virtual environment:
```bash
cd fetch-github-issues
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
pytest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "fetch-github-issues",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Simon Willison",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a3/d0/e826ae580a7c718a5e25ed1e8e5d30cac5f34f35101f643c6d98e29a746b/fetch_github_issues-0.1.1.tar.gz",
"platform": null,
"description": "# fetch-github-issues\n\n[](https://pypi.org/project/fetch-github-issues/)\n[](https://github.com/simonw/fetch-github-issues/releases)\n[](https://github.com/simonw/fetch-github-issues/actions/workflows/test.yml)\n[](https://github.com/simonw/fetch-github-issues/blob/master/LICENSE)\n\nFetch all GitHub issues for a repository and save them as JSON\n\n## Installation\n\nInstall this tool using `pip`:\n\n```bash\npip install fetch-github-issues\n```\n\n## Usage\n\nTo fetch all issues from a GitHub repository:\n\n```bash\nfetch-github-issues owner/repo --all\n```\nOr for just specific issues:\n```bash\nfetch-github-issues owner/repo 1 2 3\n```\n\nOther options:\n\n- `--key xxx`: GitHub API key - will use the `GITHUB_TOKEN` environment variable if this is not set.\n- `--output path/to/dir`: Output directory to save JSON. Default is the current directory.\n\nFor more help, run:\n\n```bash\nfetch-github-issues --help\n```\n\nYou can also use:\n\n```bash\npython -m fetch_github_issues --help\n```\n## Issue format\n\nIssues will be saved in files called `1.json` and `2.json` and so on, where the filename is the issue number.\n\nEach file will look like this:\n\n```json\n{\n \"issue\": {\n \"GitHub API issue representation\": \"...\"\n },\n \"comments\": [\n {\n \"GitHub API comment representation\": \"...\"\n }\n ]\n}\n```\n\n## Development\n\nTo contribute to this tool, first checkout the code. Then create a new virtual environment:\n\n```bash\ncd fetch-github-issues\npython -m venv venv\nsource venv/bin/activate\n```\n\nNow install the dependencies and test dependencies:\n\n```bash\npip install -e '.[test]'\n```\n\nTo run the tests:\n\n```bash\npytest\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Fetch all GitHub issues for a repository and save them as JSON",
"version": "0.1.1",
"project_urls": {
"CI": "https://github.com/simonw/fetch-github-issues/actions",
"Changelog": "https://github.com/simonw/fetch-github-issues/releases",
"Homepage": "https://github.com/simonw/fetch-github-issues",
"Issues": "https://github.com/simonw/fetch-github-issues/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "145a33faf8dc85370e59e11a73324c94566d324c9a416ab55a082ba4f7097bff",
"md5": "d070736ea56172539ddb6cd7e2ba84a4",
"sha256": "723f6273701522dc43138427badebd0776a23cc9eba5401e2f6c1ef4fcd9827f"
},
"downloads": -1,
"filename": "fetch_github_issues-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d070736ea56172539ddb6cd7e2ba84a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8573,
"upload_time": "2024-07-29T17:35:20",
"upload_time_iso_8601": "2024-07-29T17:35:20.823838Z",
"url": "https://files.pythonhosted.org/packages/14/5a/33faf8dc85370e59e11a73324c94566d324c9a416ab55a082ba4f7097bff/fetch_github_issues-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3d0e826ae580a7c718a5e25ed1e8e5d30cac5f34f35101f643c6d98e29a746b",
"md5": "ed9a411f29ce9d99acb25925ba933a60",
"sha256": "300ce7f1eaf2ab531b4eb36ddba2ca79cc03d4acb6020fca394ae0c9389051f3"
},
"downloads": -1,
"filename": "fetch_github_issues-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ed9a411f29ce9d99acb25925ba933a60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7551,
"upload_time": "2024-07-29T17:35:21",
"upload_time_iso_8601": "2024-07-29T17:35:21.951548Z",
"url": "https://files.pythonhosted.org/packages/a3/d0/e826ae580a7c718a5e25ed1e8e5d30cac5f34f35101f643c6d98e29a746b/fetch_github_issues-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 17:35:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "simonw",
"github_project": "fetch-github-issues",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fetch-github-issues"
}
