Installation

The recommended method of installing/upgrading releng-tool is using pipx:

pipx install releng-tool
 (or)
python -m pipx install releng-tool

If pipx is not available, users may use pip instead:

pip install -U releng-tool
 (or)
python -m pip install -U releng-tool

To verify the package has been installed, the following command can be used:

releng-tool --version
 (or)
python -m releng-tool --version

Quick-start

The following provides a series of steps to assist in preparing a new environment to use this package.

Linux

While the use of Python/pip is almost consistent between Linux distributions, below is a series of helpful steps to install this package under specific distributions of Linux. From a terminal, invoke the following commands:

Arch

Using pipx:

$ sudo pacman -Syu
$ sudo pacman -S python-pipx
$ pipx ensurepath
$ pipx install releng-tool
$ releng-tool --version
releng-tool <version>

Using pip:

$ sudo pacman -Sy
$ sudo pacman -S python-pip
$ sudo pip install -U releng-tool
$ releng-tool --version
releng-tool <version>

This package is also available on AUR.

CentOS

$ sudo yum install epel-release
$ sudo yum install python-pip
$ sudo pip install -U releng-tool
$ releng-tool --version
releng-tool <version>

Fedora

Using pipx:

$ sudo dnf install pipx
$ pipx ensurepath
$ pipx install releng-tool
$ releng-tool --version
releng-tool <version>

Using pip:

$ sudo dnf install python-pip
$ sudo pip install -U releng-tool
$ releng-tool --version
releng-tool <version>

openSUSE

Using pip:

$ pip install -U releng-tool
$ releng-tool --version
releng-tool <version>

Ubuntu

Using pipx (Ubuntu 23.04 or above):

$ sudo apt update
$ sudo apt install pipx
$ pipx ensurepath
$ pipx install releng-tool
$ releng-tool --version
releng-tool <version>

Using pip:

$ sudo apt update
$ sudo apt install python-pip
$ sudo pip install -U releng-tool
$ releng-tool --version
releng-tool <version>

OS X

From a terminal, invoke the following commands if using pipx:

$ brew install pipx
$ pipx ensurepath
$ pipx install releng-tool
$ releng-tool --version
releng-tool <version>

Or, if using pip:

$ sudo easy_install pip
$ sudo pip install -U releng-tool
$ releng-tool --version
releng-tool <version>

Windows

If not already installed, download the most recent version of Python:

Python - Downloads
https://www.python.org/downloads/

When invoking the installer, it is recommended to select the option to «Add Python to PATH». However, users can explicitly invoked Python from an absolute path (the remainder of these steps will assume Python is available in the path).

Open a Windows command prompt and invoke the following:

> python -m pip install -U releng-tool
> python -m releng-tool --version
releng-tool ~version~

Development

To install the most recent development sources, the following pip command can be used:

pip install git+https://github.com/releng-tool/releng-tool.git