Skip to main content

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

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.

Synopsis

yq’s mode of operation is simple: it transcodes YAML on standard input to JSON (using the key-order-preserving equivalent of yaml.safe_load_all to avoid dangerous vulnerabilities in YAML/PyYAML design) and pipes it to jq:

cat input.yml | yq .foo.bar

Or specify the filename directly:

yq .foo.bar input.yml

By default, no transcoding of jq output is done. Use the --yaml-output/-y argument to transcode it back into YAML (using the key-order-preserving equivalent of yaml.safe_dump_all):

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

Use the --width/-w argument to pass the line wrap width for string literals. YAML tags are ignored (any nested data is treated as untagged).

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.

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.

Authors

  • Andrey Kislyuk

License

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

https://img.shields.io/travis/kislyuk/yq.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 https://readthedocs.org/projects/yq/badge/?version=latest

Project details


Download files

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

Source Distribution

yq-2.6.0.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

yq-2.6.0-py2.py3-none-any.whl (12.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: yq-2.6.0.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for yq-2.6.0.tar.gz
Algorithm Hash digest
SHA256 c64f763e8409ed55eb055793c26fc347b5a6666b303d49e9d2f8d7cea979df73
MD5 929f92a1b9000b572d77cfbfd2826e04
BLAKE2b-256 565fd60ffaba376257b60304a8ee9fafdc0be4852a4bcdeece48d931e6b36487

See more details on using hashes here.

Provenance

File details

Details for the file yq-2.6.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for yq-2.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 27ef0fe4389089645861208e9bb75b31a4c0524460974e57a1b13a3aab26e6a7
MD5 df28f0c14aa886b89f7dadb99d7f7074
BLAKE2b-256 82a1ac7458a0be0d1308feb1010b5f8721098ab7fc3c0084f8ac91e9d8d831a5

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