Name | dryjq JSON |
Version |
1.9.1
JSON |
| download |
home_page | |
Summary | Drastically Reduced YAML / JSON Query |
upload_time | 2023-09-19 14:36:22 |
maintainer | |
docs_url | None |
author | |
requires_python | >=3.8 |
license | MIT License Copyright (c) 2021 Rainer Schwarzbach Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
keywords |
json
yaml
query
extract
convert
merge
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Drastically Reduced YAML / JSON Query
Lightweight package providing a subset of
[yq](https://mikefarah.gitbook.io/yq/) or
[jq](https://stedolan.github.io/jq/) functionality:
- get a single value from a YAML or JSON file
- change a single value in a YAML or JSON file
## Requirements
[PyYAML](https://pypi.org/project/PyYAML/) (Version 5.4.1 or newer)
## Installation
```
pip install dryjq
```
Installation in a virtual environment is strongly 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] [-i] [-d | -v | -q] [-o OUTPUT_FORMAT]
[--indent {2,4,8}] [--sort-keys] [--separator SEPARATOR]
[--subscript-indicators SUBSCRIPT_INDICATORS]
[query] [input_file]
Drastically Reduced YAML / JSON Query
positional arguments:
query the query (simplest form of yq/jq syntax, default is
the separator character alone).
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
-i, --inplace 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
-o OUTPUT_FORMAT, --output-format OUTPUT_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)
Query syntax options:
control the query syntax
--separator SEPARATOR
the separator character (default: '.')
--subscript-indicators SUBSCRIPT_INDICATORS
the subscript indicator character(s) (default: '[]')
```
## Issues, feature requests
Please open an issue [here](https://gitlab.com/blackstream-x/python-dryjq/-/issues)
if you found a bug or have a feature suggestion.
Raw data
{
"_id": null,
"home_page": "",
"name": "dryjq",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "json,yaml,query,extract,convert,merge",
"author": "",
"author_email": "Rainer Schwarzbach <undisclosed@example.com>",
"download_url": "https://files.pythonhosted.org/packages/48/54/466a45c85956fc7df2e17bfcf63666afad089f0990af2389b23d2a76cda4/dryjq-1.9.1.tar.gz",
"platform": null,
"description": "# Drastically Reduced YAML / JSON Query\n\nLightweight package providing a subset of\n[yq](https://mikefarah.gitbook.io/yq/) or\n[jq](https://stedolan.github.io/jq/) functionality:\n\n- get a single value from a YAML or JSON file\n- change a single value in a YAML or JSON file\n\n\n## Requirements\n\n[PyYAML](https://pypi.org/project/PyYAML/) (Version 5.4.1 or newer)\n\n## Installation\n\n```\npip install dryjq\n```\n\nInstallation in a virtual environment is strongly recommended.\n\n\n## Usage\n\nPlease see the documentation at <https://blackstream-x.gitlab.io/python-dryjq>\nfor detailed usage information.\n\nThe documentation is generated from the MarkDown files\nin this repository\u2019s `docs/` directory.\n\nOutput of `dryjq --help` (or `python3 -m dryjq --help`):\n\n```\nusage: dryjq [-h] [--version] [-i] [-d | -v | -q] [-o OUTPUT_FORMAT]\n [--indent {2,4,8}] [--sort-keys] [--separator SEPARATOR]\n [--subscript-indicators SUBSCRIPT_INDICATORS]\n [query] [input_file]\n\nDrastically Reduced YAML / JSON Query\n\npositional arguments:\n query the query (simplest form of yq/jq syntax, default is\n the separator character alone).\n input_file the input file name (by default, data will be read\n from standard input)\n\noptions:\n -h, --help show this help message and exit\n --version print version and exit\n -i, --inplace modify the input file in place instead of writing the\n result to standard output\n\nLogging options:\n control log level (default is WARNING)\n\n -d, --debug output all messages (log level DEBUG)\n -v, --verbose be more verbose (log level INFO)\n -q, --quiet be more quiet (log level ERROR)\n\nOutput options:\n control output formatting\n\n -o OUTPUT_FORMAT, --output-format OUTPUT_FORMAT\n output format (choice of 'JSON': set output format to\n JSON, 'YAML': set output fromat to YAML, 'input': keep\n input format, 'toggle': change JSON to YAML or vice\n versa; default: 'input')\n --indent {2,4,8} indentation depth of blocks, in spaces (default: 2)\n --sort-keys sort mapping keys (by default, mapping keys are left\n in input order)\n\nQuery syntax options:\n control the query syntax\n\n --separator SEPARATOR\n the separator character (default: '.')\n --subscript-indicators SUBSCRIPT_INDICATORS\n the subscript indicator character(s) (default: '[]')\n```\n\n## Issues, feature requests\n\nPlease open an issue [here](https://gitlab.com/blackstream-x/python-dryjq/-/issues)\nif you found a bug or have a feature suggestion.\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Rainer Schwarzbach Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Drastically Reduced YAML / JSON Query",
"version": "1.9.1",
"project_urls": {
"Bug Tracker": "https://gitlab.com/blackstream-x/python-dryjq/-/issues",
"CI": "https://gitlab.com/blackstream-x/python-dryjq/-/pipelines",
"Documentation": "https://blackstream-x.gitlab.io/python-dryjq",
"Homepage": "https://gitlab.com/blackstream-x/python-dryjq",
"Source Code": "https://gitlab.com/blackstream-x/python-dryjq.git"
},
"split_keywords": [
"json",
"yaml",
"query",
"extract",
"convert",
"merge"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c5817b397c47b9369da9e1baa0337fe4536e6e1a90d883fabfa5ad357cac3790",
"md5": "0e08ff29f39b5077cb11dcc2645a7319",
"sha256": "a3d87ecf1d08dc57d83ec9431b79393425a7e71f7a23d7c295cab23c698b01b0"
},
"downloads": -1,
"filename": "dryjq-1.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e08ff29f39b5077cb11dcc2645a7319",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20200,
"upload_time": "2023-09-19T14:36:20",
"upload_time_iso_8601": "2023-09-19T14:36:20.310165Z",
"url": "https://files.pythonhosted.org/packages/c5/81/7b397c47b9369da9e1baa0337fe4536e6e1a90d883fabfa5ad357cac3790/dryjq-1.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4854466a45c85956fc7df2e17bfcf63666afad089f0990af2389b23d2a76cda4",
"md5": "0f16ef099bf024702ec085bc9dcbb897",
"sha256": "eff3d8be00d740e2befa57a97724f358cd7c5d95c0972326ad6d7d363fc51cca"
},
"downloads": -1,
"filename": "dryjq-1.9.1.tar.gz",
"has_sig": false,
"md5_digest": "0f16ef099bf024702ec085bc9dcbb897",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 23761,
"upload_time": "2023-09-19T14:36:22",
"upload_time_iso_8601": "2023-09-19T14:36:22.361469Z",
"url": "https://files.pythonhosted.org/packages/48/54/466a45c85956fc7df2e17bfcf63666afad089f0990af2389b23d2a76cda4/dryjq-1.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-19 14:36:22",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "blackstream-x",
"gitlab_project": "python-dryjq",
"lcname": "dryjq"
}