Skip to main content

ymlref: load Yaml documents with possibility to resolve references.

Project description

License: MIT

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

Usage example

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ymlref, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size ymlref-0.1.1.tar.gz (10.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page