settngs/README.md
2022-12-14 20:57:57 -08:00

2.1 KiB

CI GitHub release (latest by date) PyPI PyPI - Downloads PyPI - License

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

pip install settngs

A trivial example is included at the bottom of settngs.py with the output below. For a more complete example see ComicTagger.

$ python -m settngs
Hello world
$ python -m settngs --hello lordwelch
Hello lordwelch
$ python -m settngs --hello lordwelch -s
Hello lordwelch
Successfully saved settngs to settngs.json
$ python -m settngs
Hello lordwelch
$ python -m settngs -v
Hello lordwelch
merged_namespace.example_verbose=True
$ python -m settngs -v -s
Hello lordwelch
Successfully saved settngs to settngs.json
merged_namespace.example_verbose=True
$ python -m settngs
Hello lordwelch
merged_namespace.example_verbose=True
$ python -m settngs --no-verbose
Hello lordwelch
$ python -m settngs --no-verbose -s
Hello lordwelch
Successfully saved settngs to settngs.json
$ python -m settngs --hello world --no-verbose -s
Hello world
Successfully saved settngs to settngs.json
$ python -m settngs
Hello world

settngs.json at the end:

{
  "example": {
    "hello": "world",
    "verbose": false
  }
}

What happened to the 'i'?

PyPi wouldn't let me use 'settings'