Overview

Koji Smoky Dingo is a collection of client command-line plugins for the Koji build system, and a set of utility modules for writing your own commands or scripts.

The phrase "smoky-dingo" was provided by coolname and has no particular relevance.

Meta Plugin

This project provides a relatively tiny CLI plugin for koji, named kojismokydingometa. The meta plugin acts as an adapter between koji's existing CLI plugin loading framework and Python entry_points.

The meta plugin can be used to load additional commands beyond those provided as part of this project. Simply register your commands with the "koji_smoky_dingo" entry point key. See the example command as a reference.

Tag Commands

These commands modify tag features, requiring either the tag permission (koji >= 1.18) or the admin permission.

Information Commands

These commands are informational only, and do not require any special permissions in koji.

Install

The kojismokydingo package utilizes setuptools and can be built and installed as a wheel.

Because of how koji loads client plugins, if you want the meta plugin available by default system-wide, then the package needs to be installed into the default site-packages for the python installation.

As an RPM via DNF

If using an RPM-based distribution, this is easily achieved using the included spec to produce an RPM and install that.

make clean rpm
dnf install dist/noarch/python3-kojismokydingo-2.1.1-1.fc38.noarch.rpm

As a System-wide Wheel via Pip

Using traditional setuptools or pip installation methods can also achieve this by specifying the specific root or prefix parameter

python3 setup.py bdist_wheel
pip3 install --prefix /usr -I dist/kojismokydingo-2.1.1-py3-none-any.whl

As a User-only Wheel via Pip

However, if you only want the plugin available for yourself, you can install it anywhere and tell koji to look in that particular site-package/koji_cli_plugins instance

python3 setup.py bdist_wheel
pip3 install --user -I dist/kojismokydingo-2.1.1-py3-none-any.whl

Additionally, you can install straight from PyPI

pip3 install kojismokydingo --user

And the following setting in ~/.koji/config assuming Python version 3.8 -- read the output of the install command above to verify your install path. Note that the section title needs to match your koji profile, and that you need to configure this setting for each profile you'll want to use the meta plugin with.

[koji]
plugin_paths = ~/.local/lib/python3.8/site-packages/koji_cli_plugins/

With koji >= 1.18, the meta plugin can also be symlinked into ~/.koji/plugins

mkdir -p ~/.koji/plugins
ln -s ~/.local/lib/python$(python3 -c 'import sys; print("{}.{}".format(*sys.version_info))')/site-packages/koji_cli_plugins/kojismokydingometa.py ~/.koji/plugins

Contact

Author: Christopher O'Brien obriencj@gmail.com

Original Git Repository: https://github.com/obriencj/koji-smoky-dingo

Documentation: https://obriencj.github.io/koji-smoky-dingo

License

This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this library; if not, see http://www.gnu.org/licenses/.