Metadata-Version: 2.1
Name: ezkfg
Version: 0.1.1
Summary: Easy Configuration
Home-page: http://github.com/beiyuouo/ezkfg
Author: Bingjie Yan
Author-email: bj.yan.pa@qq.com
License: Apache-2.0 License
Keywords: configuration,config
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML

# ezkfg

Easy Configuration

## Installation

```bash
pip install ezkfg
```

## Usage

### Basic Usage

```python
import ezkfg as ez
from ezkfg import Config

if __name__ == '__main__':
    config = Config({"a": 1, "b": {"c": 2}, "z.y.x": 233})  # or ez.load("xxx")
    assert config.a == 1
    assert config.b.c == 2
    assert config.z.y.x == 233

    config.a = 3
    assert config.a == 3

    config["d.e.f"] = 3
    assert config["d.e.f"] == 3
    assert config.d.e.f == 3

    config["e.f.g.h"] = 4
    assert config.e.f.g.h == 4
    assert config["e.f.g.h"] == 4

    config.e["h.i.j"] = 5
    assert config.e["h.i.j"] == 5
    assert config.e.h.i.j == 5
    assert config["e.h.i.j"] == 5

    config["g.h.i.j"] = 7
    assert config.g.h.i.j == 7
    assert config["g.h.i.j"] == 7

    config.load(["--model=resnet18", "--batch-size=32", "--lr=0.01"])
    assert config.model == "resnet18"
    assert config.batch_size == "32"
    assert config.lr == "0.01"

    config.dump('config.json')  # support json, yaml, py, ini
    config.load('config.json')
```

You can find more examples in [tests](https://github.com/beiyuouo/ezkfg/tree/main/tests).

### Advanced Usage

```python

```

## Acknowledgements

This project is inspired by the [addict](https://github.com/mewwts/addict), [CHANfiG](https://github.com/ZhiyuanChen/CHANfiG) and [mmdetection](https://github.com/open-mmlab/mmdetection).
