PythonYamlWrapper 1.0.1

YamlWrapper is a wrapper for yaml files, that creates an abstraction layer in order to handle yaml files in a easy way.

YamlWrapper

Description

YamlWrapper is an abstraction over PyYAML library. Its purpuse is to made easier to interact with .yaml files. This is made possible by create/update/remove operations with two main abstract data types: YamlDictionary and YamlList.

Documentation

You can find the official documentation in Pages section of Github repo or directely at this link

Installation

   pip install PythonYamlWrapper

Importing

   from yaml_wrapper import YamlWrapper
   
   yaml_wrapper: YamlWrapper = YamlWrapper("tmp/file_path.yaml")

Abstract data types and examples

The core functionalities provided by YamlWrapper work with YamlDictionary and YamlList.

• Dictionary

    key_1: "value"
    key_2:
       sub_key_1: "sub_value"
       sub_key_2: 1

I rappresented by:

  data = [
            YamlDictionary("key", "value"),
            YamlDictionary("sub_key", [
                                          YamlDictionary("sub_key_1", "sub_value"),
                                          YamlDictionary("sub_key_2", 1)
                                       ])
  
         ]

• Lists

- "first_value"
- "second_value"
- "third_value"

I rappresented by:

  data = [
            YamlList(["first_value", "second_value", "third_value"])
         ]

• Dictionary with list

   key: 
      - "first_value"
      - "second_value"
      - "third_value"

I rappresented by:

  data = [  
            YamlDictionary("key", YamlList(["first_value", "second_value", "third_value"]))
         ]

Special thanks

PyYaml

Author :bust_in_silhouette:

• Alexandru Paraschiv Dumitru :mailbox: