Koji Wrapper

https://img.shields.io/pypi/v/koji_wrapper.svg https://github.com/release-depot/koji_wrapper/actions/workflows/test.yml/badge.svg Documentation Status

Helper library to work with areas of koji that are not well supported in that project’s api.

  • Free software: MIT license

Notes

This library only supports python 3. Some features may still work with python 2.7 but not all of the syntax and features my be compatible.

Development

There are several dependencies needed to build and work on koji_wrapper. These are a result of a dependency upstream from us in the cryptography library, which lists the packages needed if you run into problems pip installing our requirements.

koji_wrapper supports both standard python virtual environment setups and pipenv, which is integrated into our Makefile. To set up a pipenv-based development environment, you can simply run:

make dev

This will install our dev environment for the package via pipenv. It is installed with –user, so it does not affect your site-packages. Pipenv creates a unique virtualenv for us, which you can activate via:

pipenv shell

See the pipenv documentation for more detail.

Documentation

To build the documentation on your checkout, simply run:

make docs

We plan to get this published in the near future, and this README will be updated when that happens.

Contributions

All new code should include tests that excercise the code and prove that it works, or fixes the bug you are trying to fix. Any Pull Request without tests will not be accepted. See CONTRIBUTING.rst for more details.

Building

If you wish to build a local package for testing at any time, you can simply run:

make dist

this will build a package with a .dev extension that you can install for testing and verification.