uyaml 0.0.6

Provides user-friendly interface for YAML data stream serialization with OOP support.

uYAML

Provides user-friendly interface for YAML data stream serialization with nothing but objects, supporting OOP approach.

Basically it is a wrapper over pyyaml python library.

Tools

• python 3.6 | 3.7 | 3.8
• pyyaml library
• code analysis
  • pytest
  • black
  • mypy
  • pylint
  • flake8
  • travis CI

Usage

Installation

Please run following script to obtain latest package from PYPI:

pip install uyaml
✨ 🍰 ✨

Quick start

>>> from uyaml.loader import Yaml, YamlFromPath
>>>
>>> yaml: Yaml = YamlFromPath("path/to/config.yaml")
>>> yaml.content()
{"top": 
  {
    "foo": {"content": "empty", "priority": 0}, 
    "bar": {"content": "empty", "priority": 1}
  }
}
>>> yaml.section(name="top")
{
  "foo": {"content": "empty", "priority": 0}, 
  "bar": {"content": "empty", "priority": 1}
}

Source code

git clone [e-mail]:vyahello/uyaml.git
pip install -e .

Or using direct source:

pip install git+https://github.com/vyahello/uyaml@0.0.1

⬆ back to top

Development notes

CI

Project has Travis CI integration using .travis.yml file thus code analysis (black, pylint, flake8, mypy, pydocstyle) and unittests (pytest) will be run automatically after every made change to the repository.

To be able to run code analysis, please execute command below:

./analyse-source-code.sh

Release notes

Please check changelog file to get more details about actual versions and it's release notes.

Meta

Author – Volodymyr Yahello. Please refer to AUTHORS file to get all contributors.

Distributed under the MIT license. See LICENSE for more information.

You can reach out me at:

• [e-mail]
• https://github.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

1. clone the repository
2. configure Git for the first time after cloning with your name and email
3. pip install -r requirements.txt to install all project dependencies
4. pip install -r requirements-dev.txt to install all development project dependencies

⬆ back to top