Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.85 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.85 KB
Raw

ubiconfig

A Python library for accessing Universal Base Image configuration

Build Status Coverage Status Maintainability

Installation

Install the ubi-config package from PyPI.

pip install ubi-config

Usage Example

When there is DEFAULT_UBI_REPO set, user can load the config by passing the config file name to get_loader().load()

from ubiconfig import get_loader

config = get_loader().load('enterprise-linux-server-x86_64.yaml')
# config has been validated and is now a Python object with relevant properties
package_whitelist = config.packages.whitelist
print(package_whitelist)

Or, get all config files from the repo:

from ubiconfig import get_loader

configs = get_loader().load_all()
# returns a list of UbiConfig objects

Or, user can also load the config from local file:

from ubiconfig import get_loader

config = get_loader("/my/config/dir").load('enterprise-linux-server-x86_64.yaml')

License

This program 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.