Metadata-Version: 2.1
Name: bored-config-parser
Version: 0.1.1
Summary: This is a small module you can use to make using config files easy
Home-page: https://github.com/tooboredtocode/config-parser
License: MIT
Keywords: yaml,json,config
Author: tooboredtocode
Author-email: bored-coder@tooboredtocode.dev
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Provides-Extra: yaml
Requires-Dist: PyYAML (>=6.0,<7.0); extra == "yaml"
Project-URL: Repository, https://github.com/tooboredtocode/config-parser
Description-Content-Type: text/markdown

# Bored Config Parser

This is a small module you can use to make using config files easy

### Example

A config like this:
```yaml
general:
  name: "test"
  frequency: 22

targets:
  - name: "t1"
    size: "2G"
  - name: "t2"
    size: "1G"
```

can be easily used with the following code:
```python
from typing import List

from config_parser import load_config


class General:
    name: str
    frequency: int


class Target:
    name: str
    size: str

    
@load_config("path/to/config.yaml")
class Config:
    general: General
    targets: List[Target]


print(Config.general.name)

for target in Config.targets:
    print(target.name)
```

