Metadata-Version: 2.1
Name: uyaml
Version: 0.0.6
Summary: Provides user-friendly interface for YAML data stream serialization with OOP support.
Home-page: https://github.com/vyahello/uyaml
Author: Volodymyr Yahello
Author-email: vyahello@gmail.com
License: UNKNOWN
Description: [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
        [![Build Status](https://travis-ci.org/upymake/uyaml.svg?branch=master)](https://travis-ci.org/upymake/uyaml)
        [![Coverage Status](https://coveralls.io/repos/github/upymake/uyaml/badge.svg?branch=master)](https://coveralls.io/github/upymake/uyaml?branch=master)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![Checked with pylint](https://img.shields.io/badge/pylint-checked-blue)](https://www.pylint.org)
        [![Checked with flake8](https://img.shields.io/badge/flake8-checked-blue)](http://flake8.pycqa.org/)
        [![Checked with pydocstyle](https://img.shields.io/badge/pydocstyle-checked-yellowgreen)](http://www.pydocstyle.org/)
        [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
        [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.md)
        [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
        [![PyPI version shields.io](https://img.shields.io/pypi/v/uyaml.svg)](https://pypi.python.org/pypi/uyaml/)
        [![PyPI pyversions](https://img.shields.io/pypi/pyversions/uyaml.svg)](https://pypi.python.org/pypi/uyaml/)
        [![Downloads](https://pepy.tech/badge/uyaml)](https://pepy.tech/project/uyaml)
        [![CodeFactor](https://www.codefactor.io/repository/github/upymake/uyaml/badge)](https://www.codefactor.io/repository/github/upymake/uyaml)
        
        # 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](https://github.com/yaml/pyyaml) library
        - code analysis
          - [pytest](https://pypi.org/project/pytest/)
          - [black](https://black.readthedocs.io/en/stable/)
          - [mypy](http://mypy.readthedocs.io/en/latest)
          - [pylint](https://www.pylint.org/)
          - [flake8](http://flake8.pycqa.org/en/latest/)
          - [travis](https://travis-ci.org/) CI
        
        ## Usage
        
        ### Installation
        
        Please run following script to obtain latest package from PYPI:
        ```bash
        pip install uyaml
        ✨ 🍰 ✨
        ```
        ### Quick start
        
        ```python
        >>> 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
        
        ```bash
        git clone git@github.com:vyahello/uyaml.git
        pip install -e .
        ```
        
        Or using direct source:
        ```bash
        pip install git+https://github.com/vyahello/uyaml@0.0.1
        ```
        **[⬆ back to top](#uyaml)**
        
        ## Development notes
        
        ### CI
        
        Project has Travis CI integration using [.travis.yml](.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:
        ```bash
        ./analyse-source-code.sh
        ```
        ### Release notes
        
        Please check [changelog](CHANGELOG.md) file to get more details about actual versions and it's release notes.
        
        ### Meta
        
        Author – _Volodymyr Yahello_. Please refer to [AUTHORS](AUTHORS.md) file to get all contributors.
        
        Distributed under the `MIT` license. See [LICENSE](LICENSE.md) for more information.
        
        You can reach out me at:
        * [vyahello@gmail.com](vyahello@gmail.com)
        * [https://github.com/vyahello](https://github.com/vyahello)
        * [https://www.linkedin.com/in/volodymyr-yahello-821746127](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](#uyaml)**
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
