https://github.com/uasal/utils_config
Python package contain miscellaneous generic tools to be used in UASAL related configuration/tool repositories.
https://github.com/uasal/utils_config
python-package toml-parser utility
Last synced: 4 months ago
JSON representation
Python package contain miscellaneous generic tools to be used in UASAL related configuration/tool repositories.
- Host: GitHub
- URL: https://github.com/uasal/utils_config
- Owner: uasal
- License: gpl-3.0
- Created: 2025-02-05T22:06:01.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-10-01T23:14:06.000Z (8 months ago)
- Last Synced: 2025-10-12T02:56:00.289Z (8 months ago)
- Topics: python-package, toml-parser, utility
- Language: Python
- Homepage:
- Size: 56.6 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```sh
pip install "git+https://github.com/uasal/utils_config.git@develop"
```
### Install via cloning the repo
```sh
git clone git@github.com:uasal/utils_config.git
cd utils_config
pip install .
```
## Usage and Verifying the Installation
To verify the installed version matches the latest release:
```sh
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
```sh
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
```python
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
```