bupy 0.1.1

A Python toolkit for Butane and Ignition

Bupy

The Butane Python Toolkit

Bupy was built to help users develop Butane configurations for Fedora CoreOS quickly on their workstations. It allows you to convert Butane YAML to Ignition JSON and render Butane Jinja2 templates to either Butane YAML or Ignition JSON. You can then use your Butane file or template to launch a local QEMU Virtual Machine.

Requirements

• Python 3.8.10^
• butane
• qemu
• If possible, a positive attitude

Roadmap

• Convert Support
• Jinja2 Template Support
• Launch a local QEMU FCOS VM
• Merge Butane YAML (snippets)
• Serve Ignition JSON via HTTP
• Libvirt support

Demo

You can watch a quick demo of Bupy on Youtube.

Development

1. Clone this repo
2. Install dependencies

poetry install

1. Activate a poetry shell

$ poetry shell
Spawning shell within /home/jdoss/src/quickvm/bupy/.venv
. /home/jdoss/src/quickvm/bupy/.venv/bin/activate
$ . /home/jdoss/src/quickvm/bupy/.venv/bin/activate

1. Make changes...
2. See them in action

(.venv) $ python -m bupy --help

 Usage: bupy [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --version             -v        Show the version and exit.                                       │
│ --install-completion            Install completion for the current shell.                        │
│ --show-completion               Show completion for the current shell, to copy it or customize   │
│                                 the installation.                                                │
│ --help                          Show this message and exit.                                      │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ convert      Converts Butane YAML to Ignition JSON                                               │
│ merge        Merge Butane files together                                                         │
│ qemu         Launches a QEMU VM with the specified Ignition JSON or Butane YAML                  │
│ serve        Serve an ignition file via HTTP on a specified port                                 │
│ template     Render Butane Jinja2 templates                                                      │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

License

                             Apache License
                       Version 2.0, January 2004
                    http://www.apache.org/licenses/

                      Copyright 2022 QuickVM, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.