CLI helper to install Github releases on your system.
Project description
Github release installer
gh-release-install
is a CLI helper to install Github releases on your system.
It can be used for pretty much anything, to install a formatter in your CI, deploy
some binary using an orcherstration tool, or on your desktop.
This project was mainly created to...
# ...turn this mess:
wget --quiet --output-document=- "https://github.com/koalaman/shellcheck/releases/download/v0.7.1/shellcheck-v0.7.1.linux.x86_64.tar.xz" \
| tar --extract --xz --directory=/usr/local/bin --strip-components=1 --wildcards 'shellcheck*/shellcheck' \
&& chmod +x /usr/local/bin/shellcheck
wget --quiet --output-document=/usr/local/bin/shfmt "https://github.com/mvdan/sh/releases/download/v3.2.1/shfmt_v3.2.1_linux_amd64" \
&& chmod +x /usr/local/bin/shfmt
# Into this:
pip3 install gh-release-install
gh-release-install \
"koalaman/shellcheck" \
"shellcheck-{tag}.linux.x86_64.tar.xz" --extract "shellcheck-{tag}/shellcheck" \
"/usr/bin/shellcheck"
gh-release-install \
"mvdan/sh" \
"shfmt_{tag}_linux_amd64" \
"/usr/bin/shfmt"
Features:
- Download releases from Github.
- Extract zip or tarball on the fly.
- Pin to a desired version or get the
latest
version. - Keep track of the local tools version using a version file.
Installation
Install the package from pip:
pip install gh-release-install
gh-release-install --help
Or with with pipx:
pipx install gh-release-install
gh-release-install --help
Usage
usage: gh-release-install [-h] [--extract <filename>] [--version <version>]
[--version-file <filename>]
[--checksum <hash>:<digest|asset>] [-v] [-q]
REPOSITORY ASSET DESTINATION
Install GitHub release file on your system.
positional arguments:
REPOSITORY Github REPOSITORY org/repo to get the release from.
ASSET Release ASSET filename. May contain variables such as
'{version}' or '{tag}'.
DESTINATION Path to save the downloaded file. If DESTINATION is a
directory, the asset name will be used as filename in
that directory. May contain variables such as
'{version}' or '{tag}'.
optional arguments:
-h, --help show this help message and exit
--extract <filename> Extract the <filename> from the release asset archive
and install the extracted file instead. May contain
variables such as '{version}' or '{tag}'. (default:
None)
--version <version> Desired release version to install. When using 'latest'
the installer will guess the latest version from the
Github API. (default: latest)
--version-file <filename>
Track the version installed on the system using a file.
May contain variables such as '{destination}'. (default:
None)
--checksum <hash>:<digest|asset>
Asset checksum used to verify the downloaded ASSET.
<hash> can be one of md5, sha1, sha224, sha256, sha384,
sha512. <digest|asset> can either be the expected
checksum, or the filename of an checksum file in the
release assets. (default: None)
-v, --verbose Increase the verbosity. (default: 0)
-q, --quiet Disable logging. (default: None)
template variables:
{tag} Release tag name.
{version} Release tag name without leading 'v'.
{destination} DESTINATION path, including the asset filename if path
is a directory.
examples:
gh-release-install 'mvdan/sh' \
'shfmt_{tag}_linux_amd64' \
'/usr/local/bin/shfmt' \
--version 'v3.3.1'
gh-release-install 'prometheus/prometheus' \
'prometheus-{version}.linux-amd64.tar.gz' \
--extract 'prometheus-{version}.linux-amd64/prometheus' \
'/usr/local/bin/prometheus' \
--version-file '{destination}.version' \
--checksum 'sha256:sha256sums.txt'
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gh_release_install-0.10.0.tar.gz
(19.8 kB
view hashes)
Built Distribution
Close
Hashes for gh_release_install-0.10.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5572fb1ba99ba7e08a9bf61377e42987ccd0c605f7403b0b975846b4be8ffb27 |
|
MD5 | 21c59b1ee73634d69eb0652301969d6c |
|
BLAKE2b-256 | 266a7443431ce4060f67a57472bc4d814642afc31af7f6451fbd599adcb15717 |
Close
Hashes for gh_release_install-0.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b9f49610211753c511e937f976e4e5ade080967871c4001d400506cd61a2c42 |
|
MD5 | 46fe170544a5a6663c77afed22650c32 |
|
BLAKE2b-256 | 34749fb7f6b0d1a574f0c4c9be44c48969e2c9a05df8b1e00148902f1c77bbb1 |