/ci-bundle-utils

Initial project to provide some nice bundle utility features

Primary LanguagePythonMIT LicenseMIT

CI Bundle Utils Tool

Show me the money

If you don't like reading documentation and just want to try it out in your current setup, see this document.

What is it?

The bundleutils tool is:

  • a python utility
  • packaged in a docker container
  • used for managing CasC bundles

Why create it?

The simple use-cases are:

Where can I run it?

Runtime variants explained here include:

Since it is a container, it can be run virtually anywhere.

Commands

For a summary of commands, see explaining the main commands

Local Development

To run locally:

# create a virtual environment
python -m venv .venv

# install dependencies in edit mode
pip install -e bundleutilspkg

# activate environment
source .venv/bin/activate

# show shell completion options on ZSH
bundleutils completion -s zsh

# show shell completion options on BASH
bundleutils completion -s bash

Alternatively, the provided Makefile contains some targets for running local docker environments.

$ make help


Usage:
  make <target>

Targets:
  compose/start-dev      Start the bundleutils container
  compose/start          Start the bundleutils container
  compose/stop           Stop the bundleutils container
  compose/enter          Enter the bundleutils container
  docker/create-volume   Create the bundleutils-cache volume
  docker/build-dev       Build the bundleutils:dev image
  docker/start-dev       Start the bundleutils:dev container
  docker/start           Start the bundleutils container
  docker/stop            Stop the bundleutils container
  docker/enter           Enter the bundleutils container
  docker/remove          Remove the bundleutils container
  help                   Makefile Help Page