A small utility to read keys from TOML files.
Project description
read-toml-py
A small utility to read keys from TOML files.
Usage
Installation
poetry add outcome-read-toml
Usage
The utility reads the value specified by the key from the provided TOML file, and prints it to stdout.
The path parameter should be a '.' separated sequences of keys that correspond to a path in the TOML structure.
Example TOML file:
title = "My TOML file"
[info]
version = "1.0.1"
[tools.poetry]
version = "1.1.2"
files = ['a.py', 'b.py']
Read standard keys:
read-toml --path my_file.toml --key title
# "My TOML file"
read-toml --path my_file.toml --key info.version
# "1.0.1"
Read arrays:
read-toml --path my_file.toml --key tools.poetry.files
# "a.py b.py"
read-toml --path my_file.toml[0] --key tools.poetry.files
# "a.py"
You can't read non-leaf keys:
read_toml.py --path my_file.toml --key tools
# KeyError
You can check if a key exists:
read-toml --path my_file.toml --key title --check-only
# 1
read-toml --path my_file.toml --key unknown_key --check-only
# 0
If you are using this lib inside Github Actions, you can format the output accordingly:
read-toml --path my_file.toml --key title --github-actions
# ::set-output name=title::"My TOML file"
Development
Remember to run ./pre-commit.sh
when you clone the repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for outcome_read_toml-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 720c1cc38ec3198950f83d696da784683c36344c675ffb35a940ea5600ddb54b |
|
MD5 | 148c15570bd4a32dd6303916ee54ad13 |
|
BLAKE2b-256 | a1f597180839eb379e121a7e8ebd7a84f0925ff2dca914a34b439d090bf5b018 |