Skip to main content

Drastically Reduced YAML / JSON Query

Project description

Drastically Reduced YAML / JSON Query

Lightweight package providing a subset of yq or jq functionality:

  • get a single value from a YAML or JSON file
  • change a single value in a YAML or JSON file

Requirements

PyYAML (Version 5.4.1 or newer)

Installation

pip install dryjq

Installation in a virtual environment or with the --user option is recommended.

Usage

Please see the documentation at https://blackstream-x.gitlab.io/python-dryjq for detailed usage information.

The documentation is generated from the MarkDown files in this repository’s docs/ directory.

Output of dryjq --help (or python3 -m dryjq --help):

usage: dryjq [-h] [--version] [--modify-in-place] [-d | -v | -q] [-f FORMAT]
             [--indent {2,4,8}] [--sort-keys]
             [query] [input_file]

Drastically Reduced YAML / JSON Query

positional arguments:
  query                 the query (simplest form of yq/jq syntax, default is
                        '.').
  input_file            the input file name (by default, data will be read
                        from standard input)

options:
  -h, --help            show this help message and exit
  --version             print version and exit
  --modify-in-place     modify the input file in place instead of writing the
                        result to standard output

Logging options:
  control log level (default is WARNING)

  -d, --debug           output all messages (log level DEBUG)
  -v, --verbose         be more verbose (log level INFO)
  -q, --quiet           be more quiet (log level ERROR)

Output options:
  control output formatting

  -f FORMAT, --format FORMAT
                        output format (choice of 'JSON': set output format to
                        JSON, 'YAML': set output fromat to YAML, 'input': keep
                        input format, 'toggle': change JSON to YAML or vice
                        versa; default: 'input')
  --indent {2,4,8}      indentation depth of blocks, in spaces (default: 2)
  --sort-keys           sort mapping keys (by default, mapping keys are left
                        in input order)

Issues, feature requests

Please open an issue here if you found a bug or have a feature suggestion.

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

dryjq-0.7.0.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

dryjq-0.7.0-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file dryjq-0.7.0.tar.gz.

File metadata

  • Download URL: dryjq-0.7.0.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for dryjq-0.7.0.tar.gz
Algorithm Hash digest
SHA256 ef99032855337daaa2cacc9eb42627fcffddcc00a4e5c26e35b48800f1b8fd45
MD5 5e6b543890dd22094e000b51d5cfa74b
BLAKE2b-256 aca8d965c70ad5d3460534a927ff32ef2b100517dee84570619c8a6e6dbd6974

See more details on using hashes here.

File details

Details for the file dryjq-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: dryjq-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for dryjq-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b18392a20ebe99a9d1ad38785c905ce3b83acdedaba0fbee5e9bc81298602613
MD5 b718754057bf43e5d915a3ea9a4aa801
BLAKE2b-256 cb976aeebb468c8549485fac54b0f15986adc5c26410a1e4144b92351670acdf

See more details on using hashes here.

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