lordwelch/settngs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
settngs/README.md

81 lines
2.3 KiB
Markdown
Raw Normal View History

Initial Commit
2022-12-14 19:42:24 -08:00
[![CI](https://github.com/lordwelch/settngs/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/lordwelch/settngs/actions/workflows/build.yaml)
[![GitHub release (latest by date)](https://img.shields.io/github/downloads/lordwelch/settngs/latest/total)](https://github.com/lordwelch/settngs/releases/latest)
[![PyPI](https://img.shields.io/pypi/v/settngs)](https://pypi.org/project/settngs/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/settngs)](https://pypistats.org/packages/settngs)
[![PyPI - License](https://img.shields.io/pypi/l/settngs)](https://opensource.org/licenses/MIT)
# Settngs
This library is an attempt to merge reading flags/options from the commandline (argparse) and settings from a file (json).
It is a modified argparse inspired by how [flake8] loads their settings. Note that this does not attempt to be a drop-in replacement for argparse.
Install with pip
```console
pip install settngs
```
Add support for persistent setting groups Persistent setting groups allow settings that are not declared to survive normalization and other operations that would normally remove any unknown keys in a group. Calling normalize or get_namespace with persistent=False will remove unknown keys even from persistent groups. Currently the only way to retrieve the defaults for a config and preserve unknown keys is to manually get the defaults and update each existing group with the default values.
2023-01-31 19:18:09 -08:00
A trivial example is included at the bottom of settngs.py with the output below (using bash). For a more complete example see [ComicTagger].
Initial Commit
2022-12-14 19:42:24 -08:00
```console
$ python -m settngs
Hello world
$ python -m settngs --hello lordwelch
Hello lordwelch
$ python -m settngs --hello lordwelch -s
Hello lordwelch
Make most functions work off of Config objects and Values/Namespace objects Used Generic for better typing Backported BooleanOptionalAction for tests on Python 3.8 Remove merge support in normalize_config Add test to validate that the example works
2022-12-15 18:53:29 -08:00
Successfully saved settings to settings.json
Initial Commit
2022-12-14 19:42:24 -08:00
$ python -m settngs
Hello lordwelch
$ python -m settngs -v
Hello lordwelch
Make most functions work off of Config objects and Values/Namespace objects Used Generic for better typing Backported BooleanOptionalAction for tests on Python 3.8 Remove merge support in normalize_config Add test to validate that the example works
2022-12-15 18:53:29 -08:00
merged_namespace.values.example_verbose=True
Initial Commit
2022-12-14 19:42:24 -08:00
$ python -m settngs -v -s
Hello lordwelch
Make most functions work off of Config objects and Values/Namespace objects Used Generic for better typing Backported BooleanOptionalAction for tests on Python 3.8 Remove merge support in normalize_config Add test to validate that the example works
2022-12-15 18:53:29 -08:00
Successfully saved settings to settings.json
merged_namespace.values.example_verbose=True
Initial Commit
2022-12-14 19:42:24 -08:00
$ python -m settngs
Hello lordwelch
Make most functions work off of Config objects and Values/Namespace objects Used Generic for better typing Backported BooleanOptionalAction for tests on Python 3.8 Remove merge support in normalize_config Add test to validate that the example works
2022-12-15 18:53:29 -08:00
merged_namespace.values.example_verbose=True
Add support for persistent setting groups Persistent setting groups allow settings that are not declared to survive normalization and other operations that would normally remove any unknown keys in a group. Calling normalize or get_namespace with persistent=False will remove unknown keys even from persistent groups. Currently the only way to retrieve the defaults for a config and preserve unknown keys is to manually get the defaults and update each existing group with the default values.
2023-01-31 19:18:09 -08:00
$ cat >settings.json << EOF
{
"example": {
"hello": "lordwelch",
"verbose": true
},
"persistent": {
"test": false,
"hello": "world"
}
}
EOF
Initial Commit
2022-12-14 19:42:24 -08:00
$ python -m settngs --no-verbose
Hello lordwelch
$ python -m settngs --no-verbose -s
Hello lordwelch
Make most functions work off of Config objects and Values/Namespace objects Used Generic for better typing Backported BooleanOptionalAction for tests on Python 3.8 Remove merge support in normalize_config Add test to validate that the example works
2022-12-15 18:53:29 -08:00
Successfully saved settings to settings.json
Initial Commit
2022-12-14 19:42:24 -08:00
$ python -m settngs --hello world --no-verbose -s
Hello world
Make most functions work off of Config objects and Values/Namespace objects Used Generic for better typing Backported BooleanOptionalAction for tests on Python 3.8 Remove merge support in normalize_config Add test to validate that the example works
2022-12-15 18:53:29 -08:00
Successfully saved settings to settings.json
Initial Commit
2022-12-14 19:42:24 -08:00
$ python -m settngs
Hello world
```
settngs.json at the end:
```json
{
"example": {
"hello": "world",
"verbose": false
Add support for persistent setting groups Persistent setting groups allow settings that are not declared to survive normalization and other operations that would normally remove any unknown keys in a group. Calling normalize or get_namespace with persistent=False will remove unknown keys even from persistent groups. Currently the only way to retrieve the defaults for a config and preserve unknown keys is to manually get the defaults and update each existing group with the default values.
2023-01-31 19:18:09 -08:00
},
"persistent": false,
"hello": "world"
Initial Commit
2022-12-14 19:42:24 -08:00
}
```
## What happened to the 'i'?
PyPi wouldn't let me use 'settings'
[flake8]: https://github.com/PyCQA/flake8
[ComicTagger]: https://github.com/comictagger/comictagger
Reference in New Issue Copy Permalink