Skip to main content

Fetch all GitHub issues for a repository and save them as JSON

Project description

fetch-github-issues

PyPI Changelog Tests License

Fetch all GitHub issues for a repository and save them as JSON

Installation

Install this tool using pip:

pip install fetch-github-issues

Usage

To fetch all issues from a GitHub repository:

fetch-github-issues owner/repo --all

Or for just specific issues:

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:

fetch-github-issues --help

You can also use:

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:

{
    "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:

cd fetch-github-issues
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

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

fetch_github_issues-0.1.2.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

fetch_github_issues-0.1.2-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file fetch_github_issues-0.1.2.tar.gz.

File metadata

  • Download URL: fetch_github_issues-0.1.2.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for fetch_github_issues-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ff61619487ca378f81623bd7431c552b963f12f28608458b5afb082ceffc1666
MD5 fb6500920ceeac7e1ba939e856183dd0
BLAKE2b-256 a37c30d38203ee02fd368ec9dbf7e30ceced743899cc89cf511d96d9aeb228df

See more details on using hashes here.

File details

Details for the file fetch_github_issues-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for fetch_github_issues-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3079355c71e96907c202bdef18f746700a769b8367a35b77d3a60a949957fbef
MD5 39bb49f8a4931c6e9347cbb4bc76b283
BLAKE2b-256 e4ce370baab045fda43c86595dc5f1ecada9cbcdc2f1b362d4806e45e92f944c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page