A Flyweight pattern for loading yaml files
Project description
[![Build Status](https://travis-ci.org/simongarisch/yamlsettings.svg?branch=master)](https://travis-ci.org/simongarisch/yamlsettings)
[![Coverage Status](https://coveralls.io/repos/github/simongarisch/yamlsettings/badge.svg?branch=master)](https://coveralls.io/github/simongarisch/yamlsettings?branch=master)
# pyyamlsettings
A Flyweight pattern for loading yaml files in Python.
## Installation
pyyamlsettings is python 2 and 3 compatible.
```bash
pip install pyyamlsettings
```
## Overview
There is a YamlSettings class exposed by the package that allows you to load and query yaml files.
Suppose we have a yaml file with the structure:
```
att1: 42
att2: "This is a string"
level1:
a: 1
b: 2
level2:
a: 3
b: 4
```
We can load this file:
```python
import os
import pyyamlsettings
yaml_file_path = os.path.join("tests", "test_yaml_file.yaml")
settings = pyyamlsettings.YamlSettings(yaml_file_path)
```
And read particular items with:
```python
result = settings.get_data("att1")
print(result) # 42
result = settings.get_data("level1", "level2", "b")
print(result) # 4
```
[![Coverage Status](https://coveralls.io/repos/github/simongarisch/yamlsettings/badge.svg?branch=master)](https://coveralls.io/github/simongarisch/yamlsettings?branch=master)
# pyyamlsettings
A Flyweight pattern for loading yaml files in Python.
## Installation
pyyamlsettings is python 2 and 3 compatible.
```bash
pip install pyyamlsettings
```
## Overview
There is a YamlSettings class exposed by the package that allows you to load and query yaml files.
Suppose we have a yaml file with the structure:
```
att1: 42
att2: "This is a string"
level1:
a: 1
b: 2
level2:
a: 3
b: 4
```
We can load this file:
```python
import os
import pyyamlsettings
yaml_file_path = os.path.join("tests", "test_yaml_file.yaml")
settings = pyyamlsettings.YamlSettings(yaml_file_path)
```
And read particular items with:
```python
result = settings.get_data("att1")
print(result) # 42
result = settings.get_data("level1", "level2", "b")
print(result) # 4
```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyyamlsettings-0.0.1.tar.gz
(3.9 kB
view hashes)
Built Distributions
Close
Hashes for pyyamlsettings-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 382772e0109e99db52e1e64cd6f24844ae2959ab5505b4b95175dbe5248b33e2 |
|
MD5 | c8a2f05cba026291f4c95db974a597a2 |
|
BLAKE2b-256 | f488b7c6c4f698bb3c972dfe28a521ca124435a550d9fd435121e5d860a59e07 |
Close
Hashes for pyyamlsettings-0.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f30104a1eb7a4ae4a6aae133d54770314b09c7f87ed0c5bb9e1f914122243c9b |
|
MD5 | 83c73e839d85dcbfc5ec103b86b4e1f1 |
|
BLAKE2b-256 | 9a8dd60d2c147be05201cb892e57c7792e7fb350104dd5c8baf3c47985d83da4 |