Command-line YAML/XML processor - jq wrapper for YAML/XML documents

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for abesto from gravatar.com abesto Avatar for kislyuk from gravatar.com kislyuk

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache Software License)
  • Author: Andrey Kislyuk
  • Requires: Python >=3.6
Classifiers

Project description

Installation

pip install yq

Before using yq, you also have to install its dependency, jq. See the jq installation instructions for details and directions specific to your platform.

On macOS, yq is also available on Homebrew: use brew install python-yq.

Synopsis

yq takes YAML input, converts it to JSON, and pipes it to jq:

cat input.yml | yq .foo.bar

Like in jq, you can also specify input filename(s) as arguments:

yq .foo.bar input.yml

By default, no conversion of jq output is done. Use the --yaml-output/-y option to convert it back into YAML:

cat input.yml | yq -y .foo.bar

Mapping key order is preserved. By default, custom YAML tags and styles in the input are ignored. Use the --yaml-roundtrip/-Y option to preserve YAML tags and styles by representing them as extra items in their enclosing mappings and sequences while in JSON:

yq -Y .foo.bar input.yml

yq can be called as a module if needed. With -y/-Y, files can be edited in place like with sed -i:

python -m yq -Y --indentless --in-place '.["current-context"] = "staging-cluster"' ~/.kube/config

Use the --width/-w option to pass the line wrap width for string literals. Use --explicit-start/--explicit-end to emit YAML start/end markers even when processing a single document. All other command line arguments are forwarded to jq. yq forwards the exit code jq produced, unless there was an error in YAML parsing, in which case the exit code is 1. See the jq manual for more details on jq features and options.

Because YAML treats JSON as a dialect of YAML, you can use yq to convert JSON to YAML: yq -y . < in.json > out.yml.

Preserving tags and styles using the -Y (--yaml-roundtrip) option

The -Y option helps preserve custom string styles and tags in your document. For example, consider the following document (an AWS CloudFormation template fragment):

Resources:
  ElasticLoadBalancer:
    Type: 'AWS::ElasticLoadBalancing::LoadBalancer'
    Properties:
      AvailabilityZones: !GetAZs ''
      Instances:
        - !Ref Ec2Instance1
        - !Ref Ec2Instance2
      Description: >-
        Load balancer for Big Important Service.

        Good thing it's managed by this template.

Passing this document through yq -y .Resources.ElasticLoadBalancer will drop custom tags, such as !Ref, and styles, such as the folded style of the Description field:

Type: AWS::ElasticLoadBalancing::LoadBalancer
Properties:
  AvailabilityZones: ''
  Instances:
    - Ec2Instance1
    - Ec2Instance2
  Description: 'Load balancer for Big Important Service.

    Good thing it''s managed by this template.'

By contrast, passing it through yq -Y .Resources.ElasticLoadBalancer will preserve tags and styles:

Type: 'AWS::ElasticLoadBalancing::LoadBalancer'
Properties:
  AvailabilityZones: !GetAZs ''
  Instances:
    - !Ref 'Ec2Instance1'
    - !Ref 'Ec2Instance2'
  Description: >-
    Load balancer for Big Important Service.

    Good thing it's managed by this template.

To accomplish this in -Y mode, yq carries extra metadata (mapping pairs and sequence values) in the JSON representation of your document for any custom tags or styles that it finds. When converting the JSON back into YAML, it parses this metadata, re-applies the tags and styles, and discards the extra pairs and values.

yq does not support passing YAML comments into the JSON representation used by jq, or roundtripping such comments.

XML support

yq also supports XML. The yq package installs an executable, xq, which transcodes XML to JSON using xmltodict and pipes it to jq. Roundtrip transcoding is available with the xq --xml-output/xq -x option. Multiple XML documents can be passed in separate files/streams as xq a.xml b.xml. Use --xml-item-depth to descend into large documents, streaming their contents without loading the full doc into memory (for example, stream a Wikipedia database dump with cat enwiki-*.xml.bz2 | bunzip2 | xq . --xml-item-depth=2). Entity expansion and DTD resolution is disabled to avoid XML parsing vulnerabilities. Use python -m yq.xq if you want to ensure a specific Python runtime.

TOML support

yq supports TOML as well. The yq package installs an executable, tomlq, which uses the tomlkit library to transcode TOML to JSON, then pipes it to jq. Roundtrip transcoding is available with the tomlq --toml-output/tomlq -t option. Use python -m yq.tomlq if you want to ensure a specific Python runtime.

Authors

  • Andrey Kislyuk

License

Licensed under the terms of the Apache License, Version 2.0.

https://github.com/kislyuk/yq/workflows/Python%20package/badge.svg https://codecov.io/github/kislyuk/yq/coverage.svg?branch=master https://img.shields.io/pypi/v/yq.svg https://img.shields.io/pypi/l/yq.svg

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for abesto from gravatar.com abesto Avatar for kislyuk from gravatar.com kislyuk

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache Software License)
  • Author: Andrey Kislyuk
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

3.4.3

This version

3.4.2

3.4.1

3.4.0

3.3.1

3.3.0

3.2.3

3.2.2

3.2.1

3.2.0

3.1.1

3.1.0

3.0.2

3.0.1

2.14.0

2.13.0

2.12.2

2.12.1

2.12.0

2.11.1

2.11.0

2.10.1

2.10.0

2.9.2

2.8.1

2.8.0

2.7.2

2.7.1

2.7.0

2.6.0

2.5.0

2.4.1

2.4.0

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.0

2.1.2

2.1.1

2.0.2

2.0.1

2.0.0

0.0.2

Download files

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

Source Distribution

yq-3.4.2.tar.gz (33.2 kB view details)

Uploaded Source

Built Distribution

yq-3.4.2-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file yq-3.4.2.tar.gz.

File metadata

  • Download URL: yq-3.4.2.tar.gz
  • Upload date:
  • Size: 33.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.14

File hashes

Hashes for yq-3.4.2.tar.gz
Algorithm Hash digest
SHA256 f916408e834e96f390ef82a36bfcbf24a555ae5a2fcdaef94a2ed5d260d161ef
MD5 40855cace87b83d88ddf4454b3d7d5ae
BLAKE2b-256 52c38b463e37c949aeb56208a6db6892b4b14c332681afd57bf6c297ca6b3d0f

See more details on using hashes here.

Provenance

File details

Details for the file yq-3.4.2-py3-none-any.whl.

File metadata

  • Download URL: yq-3.4.2-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.14

File hashes

Hashes for yq-3.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 24f37f200fdf6e8ca7473f6987cb0f3dbb0ad0a1e21bad33ea9992b0debf7df5
MD5 8546530a0d259297bc7c5f59e8bdf734
BLAKE2b-256 7f67eadd55bf1e6d95f639210c9701d8db7b6f920eeb2d54f34bb8c6b912c76a

See more details on using hashes here.

Provenance

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