Easy dict-based script configuration with CLI support
Project description
Write simple configs and update from CLI, kwargs, and/or json.
The scriptconfig provides a simple way to make configurable scripts using a combination of config files, command line arguments, and simple Python keyword arguments. A script config object is defined by creating a subclass of Config with a default dict class attribute. An instance of a custom Config object will behave similar a dictionary, but with a few conveniences.
To get started lets consider some example usage:
>>> import scriptconfig as scfg
>>> # In its simplest incarnation, the config class specifies default values.
>>> # For each configuration parameter.
>>> class ExampleConfig(scfg.Config):
>>> default = {
>>> 'num': 1,
>>> 'mode': 'bar',
>>> 'ignore': ['baz', 'biz'],
>>> }
>>> # Creating an instance, starts using the defaults
>>> config = ExampleConfig()
>>> # Typically you will want to update default from a dict or file. By
>>> # specifying cmdline=True you denote that it is ok for the contents of
>>> # `sys.argv` to override config values. Here we pass a dict to `load`.
>>> kwargs = {'num': 2}
>>> config.load(kwargs, cmdline=False)
>>> assert config['num'] == 2
>>> # The `load` method can also be passed a json/yaml file/path.
>>> config_fpath = '/tmp/foo'
>>> open(config_fpath, 'w').write('{"num": 3}')
>>> config.load(config_fpath, cmdline=False)
>>> assert config['num'] == 3
>>> # It is possbile to load only from CLI by setting cmdline=True
>>> # or by setting it to a custom sys.argv
>>> config.load(cmdline=['--num=4'])
>>> assert config['num'] == 4
>>> # Note that using `config.load(cmdline=True)` will just use the
>>> # contents of sys.argvFeatures
Serializes to json
Dict-like interface. By default a Config object operates independent of config files or the command line.
Can create command line interfaces
Can directly create an independent argparse object
Can use special command line loading using self.load(cmdline=True). This extends the basic argparse interface with:
Can specify options as either --option value or --option=value
Default config options allow for “smartcasting” values like lists and paths
Automatically add --config, --dumps, and --dump CLI options when reading cmdline via load.
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
File details
Details for the file scriptconfig-0.5.3.tar.gz.
File metadata
- Download URL: scriptconfig-0.5.3.tar.gz
- Upload date:
- Size: 14.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9d4ede4fe407bfd4509ad6d7f23644a308c05928c932550d6a4ec227b783885e |
|
| MD5 | 83281dfda2399289e9a202688a5114bf |
|
| BLAKE2b-256 | 56382dd61ec8a91c6cdf473b4f73b8f917f18bfd4de6163bb6c6fa5f1da5da54 |
File details
Details for the file scriptconfig-0.5.3-py2.py3-none-any.whl.
File metadata
- Download URL: scriptconfig-0.5.3-py2.py3-none-any.whl
- Upload date:
- Size: 13.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 481ca1748f3b4bb85c6b8aa96fade5145ef3b8cb698476722b11ff2ff5b4fc5d |
|
| MD5 | 868016952cbf4e4e5f6c0974b2797b35 |
|
| BLAKE2b-256 | e59eeb14de70d266c2e22fae110cfe96b6b8a47be2402fc00e8c32cebddab31c |
