Metadata-Version: 2.1
Name: ubi-config
Version: 3.0.0
Summary: A Python Library for accessing Universal Base Image configuration
Home-page: https://github.com/release-engineering/ubi-config
Author: 
Author-email: 
License: GNU General Public License
Project-URL: Documentation, https://release-engineering.github.io/ubi-config/
Description: 
        
        A Python library for accessing Universal Base Image configuration
        
        [![Build Status](https://github.com/release-engineering/ubi-config/actions/workflows/tox-test.yml/badge.svg)](https://github.com/release-engineering/ubi-config/actions/workflows/tox-test.yml))
        [![codecov](https://codecov.io/gh/release-engineering/ubi-config/branch/master/graph/badge.svg?token=fPG7EINR9O)](https://codecov.io/gh/release-engineering/ubi-config)
        [![Maintainability](https://api.codeclimate.com/v1/badges/c62407f84ad66135fa8d/maintainability)](https://codeclimate.com/github/release-engineering/ubi-config/maintainability)
        
        - [Source](https://github.com/release-engineering/ubi-config)
        - [Documentation](https://release-engineering.github.io/ubi-config/)
        - [PyPI](https://pypi.org/project/ubi-config)
        
        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()`
        
        ```python
        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:
        
        ```python
        
        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:
        
        ```python
        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.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
