Skip to main content

ymlref: load Yaml documents with possibility to resolve references.

Project description

ymlref: load Yaml documents with possibility to resolve references.
==========================================================================

|License: MIT|

**ymlref** is a library that allows you to load Yaml documents and resolve JSON-pointer references
inside them.

Usage example
-----------

.. code:: python

import ymlref


DOCUMENT = """

authors:
shakespear:
first_name: William
last_name: Shakespear
dostoevsky:
first_name: Fyodor
last_name: Dostoevsky
books:
- title: Makbet
author:
$ref: "#/authors/shakespear"
- title: Crime and punishment
author:
$ref: "#/authors/dostoevsky"
"""

doc = ymlref.loads(DOCUMENT)
print('Books in document: \n')
for book in doc['books']:
print(book['title'])
print('Author: ' + book['author']['first_name'] + ' ' + book['author']['last_name'])
print('---')

Exposed API
----------------
**ymlref** provides two functions: **load** and **loads**. The first one loads document from file-like object, while the second one loads document from `str` object.

.. |License: MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT

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

ymlref-0.1.0.tar.gz (10.6 kB view details)

Uploaded Source

File details

Details for the file ymlref-0.1.0.tar.gz.

File metadata

  • Download URL: ymlref-0.1.0.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ymlref-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3c3993b37bbf3f35b19c6586069f53032b64b00b895e8d2bd4c3bbe281b99fd3
MD5 f5bbde4d14e5d68a5ff87caa97b4887f
BLAKE2b-256 8e00eb9d48bf4894dfd47216aa1a19463eb93117a42b572b266db0eeb530eb97

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page