utils_config

Overview

utils_config is a Python package that provides a utility for parsing TOML files. Currently there are 3 data formats this package makes available, "raw" which returns a dictionary of strings as whatever format they're stored in, "parsed" which reads .toml files and separates out 'value' and 'unit', and "unitless" which parses the input string and removes any units. See examples below for how to grab each format.

Installation

Pip-based

pip install "git+https://github.com/uasal/utils_config.git@develop"

Install via cloning the repo

git clone [email protected]:uasal/utils_config.git
cd utils_config
pip install .

Usage and Verifying the Installation

To verify the installed version matches the latest release:

pip show utils_config

If you have cloned the repo and your version is out of date, make sure you are on the develop branch and pulled prior to reinstalling via pip. Do the following command in the root of utils_config

pip install --no-cache-dir --force-reinstall .

For pip-only installations simply run the install command again. Once installed, your python code should import ConfigLoader and use the 3 input arguments to the class as shown below. Keep in mind your path will be relative to where you're running the script. Below is an example of using this tool to parse a toml config inside config_stp, and will be used similarly with other config repos.

Raw

from utils_config import ConfigLoader

loader = ConfigLoader("config_stp/configs","raw",recursive=True) #relative path 
config_parsed = loader.load_configs()
print(config_parsed["observatory"]["pointing"]["jitter_rms"])

From the above example, adjusting the second argument should result in the following data formats returned:

• ConfigLoader("config_stp/configs","unitless") -> 0.001
• ConfigLoader("config_stp/configs","parsed") -> {'value': 0.001, 'unit': 'arcsecond'}
• ConfigLoader("config_stp/configs","raw") -> 10e-4arcsecond

For Developers

This package is based off the LINCC framework which utilizes Ruff for linting, pytest for unit tests and coverage, and sphinx for auto doc generation. If planning on making a commit, there are a few packages you need to install first:

pip install mypy sphinx pytest types-toml sphinx-autoapi sphinx-copybutton sphinx-rtd-theme pytest-cov