Provides user-friendly interface for YAML data stream serialization with OOP support.
Project description
uYAML
Provides user-friendly interface for YAML data stream serialization with OOP support.
Basically it is a wrapper over pyyaml python library.
Tools
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 git@github.com:vyahello/uyaml.git
➜ pip install -e .
Or using direct source code tag:
➜ pip install git+https://github.com/vyahello/uyaml@0.0.1
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
Distributed under the MIT
license. See LICENSE for more information.
You can reach out me at:
- vyahello@gmail.com
- https://github.com/vyahello
- https://www.linkedin.com/in/volodymyr-yahello-821746127
Contributing
- clone the repository
- configure Git for the first time after cloning with your
name
andemail
pip install -r requirements.txt
to install all project dependenciespip install -r requirements-dev.txt
to install all development project dependencies
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.