Skip to main content
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

Metadata

Release files for ymlref 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ymlref 0.1.0
File Size Uploaded
ymlref-0.1.0.tar.gz 10.6 kB Details

Release files / ymlref-0.1.0.tar.gz

Download URL ymlref-0.1.0.tar.gz
Size 10.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3c3993b37bbf3f35b19c6586069f53032b64b00b895e8d2bd4c3bbe281b99fd3
BLAKE2b-256 checksum
How to use checksums
8e00eb9d48bf4894dfd47216aa1a19463eb93117a42b572b266db0eeb530eb97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.1.1

1 release file

This release

0.1.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page