release-gitter

Easily download releases from sites like Github and Gitea

Original repo

Originally hosted at https://git.iamthefij.com/iamthefij/release-gitter.git

GitHub Rate Limits

Unauthenticated requests to the GitHub API are limited to 60 requests per hour. If you exceed this limit, you will receive rate limit errors when trying to fetch releases.

To increase your rate limit to 5,000 requests per hour, set a GITHUB_TOKEN environment variable with a GitHub personal access token:

export GITHUB_TOKEN=ghp_your_token_here

You can create a personal access token at https://github.com/settings/tokens (no special scopes required for public repository access).

Installation

From pypi pip install release-gitter

Alternatively, you can download release_gitter.py and run that file as long as you have requests installed.

Usage

At minimum, release-gitter can be used to download the latest release file for a given repo using something like the following:

release-gitter --git-url https://github.com/coder/super-tool "super-tool-{version}-{system}-{arch}"

Originally created for downloading binary releases for pre-commit hooks, so it also has features to detect the remote repo automatically using git remote get-url origin, as well as detecting the currently checked out version by parsing metadata files (currently only Cargo.toml).

In practice, it means that for a project like StyLua, when run within the repo one would only need to provide:

release-gitter --extract-files "stylua" --exec "chmod +x stylua" \
    --map-system Windows=win64 --map-system Darwin=macos --map-system=linux=Linux \
    "stylua-{version}-{system}.zip"

And release-gitter will get the release version from the Cargo.toml, get the URL from the git remote, call the Github API and look for a release matching the templated file name, extract the stylua file from the archive, and then make it executable. Alternatively, if you're project --version-git-tag can be used to pull the version from the latest tag. This will automatically do a shallow fetch (depth = 1), but this can be supressed with --version-git-no-fetch.

This allows a single command to be run from a checked out repo from pre-commit on any system to fetch the appropriate binary.

Additionally, it can be used to simplify install instructions for users by providing the --git-url option so it can be run from outside the repo.

Full usage is as follows:

usage: release-gitter [-h] [-v] [--hostname HOSTNAME] [--owner OWNER]
                      [--repo REPO] [--git-url GIT_URL] [--version VERSION]
                      [--prerelease] [--version-git-tag]
                      [--version-git-no-fetch] [--map-system MAP_SYSTEM]
                      [--map-arch MAP_ARCH] [--exec EXEC]
                      [--extract-files EXTRACT_FILES] [--extract-all]
                      [--url-only] [--use-temp-dir]
                      format [DEST]

positional arguments:
  format                Format template to match assets. Eg.
                        `foo-{version}-{system}-{arch}.zip`
  DEST                  Destination directory. Defaults to current directory

options:
  -h, --help            show this help message and exit
  -v                    verbose or debug logging
  --hostname HOSTNAME   Git repository hostname
  --owner OWNER         Owner of the repo. If not provided, it will be
                        retrieved from the git url
  --repo REPO           Repo name. If not provided, it will be retrieved from
                        the git url
  --git-url GIT_URL     Git repository URL. Overrides `git remote` detection,
                        but not command line options for hostname, owner, and
                        repo
  --version VERSION     Release version to download. If not provided, it will
                        look for project metadata
  --prerelease          Include pre-release versions in search
  --version-git-tag, -t
                        Get the release version from a git tag
  --version-git-no-fetch
                        Shallow fetch tags prior to checking versions
  --map-system, -s MAP_SYSTEM
                        Map a platform.system() value to a custom value
  --map-arch, -a MAP_ARCH
                        Map a platform.machine() value to a custom value
  --exec, -c EXEC       Shell commands to execute after download or
                        extraction. {} will be expanded to the downloaded
                        asset name.
  --extract-files, -e EXTRACT_FILES
                        A list of file names to extract from the downloaded
                        archive
  --extract-all, -x     Extract all files from the downloaded archive
  --url-only            Only print the URL and do not download
  --use-temp-dir        Use a temporary directory as the destination

Pre-Commit usage

This can be used a way to wrap a binary release from a Github or Gitea by adding a pyproject.toml file to your current project directory and adding a .pre-commit-hooks.yaml file.

Take a look at the ./sample_pseudo_bin directory to see an example.