yaml2object 1.0.6

A simple solution that allows dot notation for YAML file.

### Status
[](https://pypi.python.org/pypi/yaml2object/)
[](https://pypi.python.org/pypi/yaml2object)
[](https://travis-ci.org/imravishar/yaml2object)
[](https://coveralls.io/github/imravishar/yaml2object)
[](https://github.com/imravishar/yaml2object/commits/master)
[](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))
[](https://pypi.python.org/pypi/yaml2object)
[](https://pypi.python.org/pypi/yaml2object)

yaml2object is a python library that allows dot notation access for YAML file.

Install
-------
```
pip install yaml2object
```

Usage
------
**1. Create your YAML settings**
```
# config.yml
defaults: &defaults
database:
adapter: postgresql
database: development
port: 8000
nested_param:
param1:
sub_param1: 'sub_param1 value'
sub_param2: 'sub_param2 value'

development:
<<: *defaults

test:
<<: *defaults
port: 8001

```
**2. Define your class**

<ol type="a">
<li>Set <b>yaml2object.YAMLObject</b> as meta-class of your config class.</li>
<li>Provide <b>source, namespace</b> as class fields.
<ul>
<li>scource: YAML file path OR python dictionary</li>
<li>namespace: param key in YAML file OR python dictionary</li>
</ul>
</li>
</ol>

###### When source is a YAML file

```python
from yaml2object import YAMLObject

class Config(metaclass=YAMLObject):
source = 'config.yml'

> WarningLog: Missing namespace attribute. Converting 'config.yml' to object.
```
```python
from yaml2object import YAMLObject

class Config(metaclass=YAMLObject):
source = 'config.yml'
namespace = 'invalid'

> WarningLog: Missing 'invalid' param in 'config.yml'. Converting 'config.yml' to object.
```
```python
from yaml2object import YAMLObject

class DevelopmentConfig(metaclass=YAMLObject):
source = 'config.yml'
namespace = 'development'

class TestConfig(metaclass=YAMLObject):
source = 'config.yml'
namespace = 'test'

DefaultConfig = YAMLObject('DefaultConfig', (object,), {'source': 'config.yml', 'namespace': 'defaults'})
```

###### Source can also be a python dictionary
```python
from yaml2object import YAMLObject

config = {'defaults': {'database':
{'adapter': 'postgresql', 'database': 'development'},
'port': 8000,
'nested_param':
{'param1': {'sub_param1': 'sub_param1 value', 'sub_param2': 'sub_param2 value'}}}}

DefaultConfig = YAMLObject('DefaultConfig', (object,), {'source': config, 'namespace': 'defaults'})
```

**3. Access your YAML as python object**
```python
>>> Config.to_dict()
>>> Config.development.to_dict()
>>> Config.development.database.to_dict()
>>> Config.development.database.adapter
>>> Config.development.nested_param.param1.sub_param1

>>> DevelopmentConfig.to_dict()
>>> DevelopmentConfig.database.to_dict()
>>> DevelopmentConfig.database.adapter
>>> DevelopmentConfig.database.database

>>> TestConfig.to_dict()
>>> TestConfig.port
>>> TestConfig.database.to_dict()
>>> TestConfig.database.adapter
>>> TestConfig.database.database

>>> DefaultConfig.to_dict()
>>> DefaultConfig.database.to_dict()
>>> DefaultConfig.database.adapter
>>> DefaultConfig.nested_param.param1.sub_param1
```