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

pip3 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

Use the --width/-w option to pass the line wrap width for string literals. With -y/-Y, files can be edited in place like with sed -i: yq -yi .foo=1 *.yml. 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.

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. Entity expansion and DTD resolution is disabled to avoid XML parsing vulnerabilities.

TOML support

yq supports TOML as well. The yq package installs an executable, tomlq, which uses the toml library to transcode TOML to JSON, then pipes it to jq. Roundtrip transcoding is available with the tomlq --toml-output/tomlq -t option.

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

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

This version

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.1.0.tar.gz (29.6 kB view details)

Uploaded Source

Built Distribution

yq-3.1.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yq-3.1.0.tar.gz
  • Upload date:
  • Size: 29.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.13

File hashes

Hashes for yq-3.1.0.tar.gz
Algorithm Hash digest
SHA256 30a84aa22486c749ba269256bd586c0bcd370b7e2a71e76c3924ead4867e74f2
MD5 18a9608d80be4b78a919b6a82bba9266
BLAKE2b-256 55b20c4409c0e677ea9e6870538b4cdf4959fad92a8aaa73ee41cf03876bddf9

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: yq-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.13

File hashes

Hashes for yq-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1acffd3257a0b8e460f1a7ec1ae5af4646944e810f7d7099084b3104aa05769
MD5 aced60d1807f7a28171a62593f5023d1
BLAKE2b-256 602cab35b5ec3b884b6e33b18ba3f6be6b94d607501fca1e5a8de22988690cdb

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