Metadata-Version: 2.4
Name: download-github-releases
Version: 1.0.1
Summary: Download (and keep in sync) the releases from a set of GitHub projects
Author-email: Jason Morley <hello@jbmorley.co.uk>
License-Expression: MIT
Description-Content-Type: text/markdown
Requires-Dist: requests

# download-github-releases

[![build](https://github.com/jbmorley/download-github-releases/actions/workflows/build.yaml/badge.svg)](https://github.com/jbmorley/download-github-releases/actions/workflows/build.yaml)

Script to download all the releases for GitHub projects

## Installation

download-github-releases is available via [PyPI](https://pypi.org/project/download-github-releases/).

Install it using your Python package manager of choice. For example, using [uv](https://docs.astral.sh/uv/):

```bash
uv tool install download-github-releases
```

## Usage

```plaintext
usage: download-github-releases [-h] [--verbose] [--download-source]
                                --output OUTPUT
                                repository [repository ...]

Download (and keep in sync) the releases from a set of GitHub projects.

positional arguments:
  repository            GitHub repository to fetch releases from

options:
  -h, --help            show this help message and exit
  --verbose, -v         show verbose output
  --download-source, -s
                        also download source for each release
  --output OUTPUT       output directory

Set the GITHUB_TOKEN environment variable to use token-based authentication.
This is required for accessing private repositories and can help with API rate
limits.
```

## License

download-github-releases is licensed under the MIT License (see [LICENSE](https://github.com/jbmorley/download-github-releases/blob/main/LICENSE)).
