shyaml_yaml_parsing_and_query_quickstart_example.py

1import shyaml
2import io
3
4# Sample YAML data
5yaml_content = """
6project:
7  name: shyaml
8  tags:
9    - python
10    - cli
11    - yaml
12"""
13
14# Convert string to a file-like object
15yaml_stream = io.StringIO(yaml_content)
16
17# Use shyaml to query the 'project.name' key
18# Note: In a Python script, shyaml is typically used via its 
19# command-line interface, but the library components can be 
20# accessed to walk through YAML structures.
21result = shyaml.tokenize_yaml(yaml_stream)
22
23# To mimic the 'shyaml get-value project.name' behavior:
24# shyaml is primarily designed as a CLI wrapper for ruamel.yaml/PyYAML.
25# The official "Quickstart" for the library itself is the command line:
26# cat file.yaml | shyaml get-value project.name
27
28print("Shyaml is primarily a CLI tool. For Python integration,")
29print("it wraps YAML parsers to provide shell-friendly access.")