UMBI: The Reference UMB Implementation

UMBI is a reference implementation for the UMB standard written in Python. It is open source, freely licensed under the MIT license, and is available on GitHub.

Installation

UMBI is available on either GitHub or as a pip package on PyPi. In this, we will show installation via pip.

Step 1:

First, ensure that pip is installed via the ensure-pip module. Optionally, then create a virtual environment if you do not want UMBI installed globally or at a user-level. This will create a virtual environment in the current working directory in a hidden directory called .venv.
# Note: on Debian and Ubuntu, the executable name is `python3`
python -m ensure-pip
# The following step is optional
python -m venv .venv source .venv/bin/activate

Step 2:

Finally, we install UMBI.
python3 -m pip install umbi
# If you are using UMBI in a project, we recommend you create a requirements.txt file.
echo 'umbi'  >> requirements.txt

Step 3:

Now you probably want to use UMBI. There are two ways to do this:
  1. Directly via the CLI
  2. By the Python API
To use UMBI directly, we provide a CLI via the umbi executable.
umbi --import-umb /path/to/input.umb
umbi --import-umb /path/to/input.umb --export-umb /path/to/output.umb
umbi --import-umb /path/to/input.umb --export-umb /path/to/output.umb --log-level=DEBUG
We will add documentation for UMBI's Python API later.