Wildq User Documentation¶

Purpose of this package is to provide a simple wrapper arround jq for different formats. I’m tired of searching a package doing yaml jq, toml jq, ini jq etc. mainly used for scripting.

The latest stable version is available on PyPI.

pip install -U wildq

Getting started: wildq’s getting-started!
User Guide: All detailed guide for wildq.
API Reference: The complete API documentation

Community¶

To get help with using wildq, create an issue on GitHub Issues.

Contributing¶

Yes please! We are always looking for contributions, additions and improvements.

The source is available on GitHub and contributions are always encouraged. Contributions can be as simple as minor tweaks to this documentation, the website or the core.

To contribute, fork the project on GitHub and send a pull request.

Changes¶

See the Changelog for a full list of changes to wildq.

Offline Reading¶

Download the docs in pdf or epub formats for offline reading.

Getting started¶

For backward compatibility in previous version only –[yaml|json|toml|ini|xml|hcl] was possible with default to json output. We still keep Monochrome, raw and json output with thoses options. Output was similar to jq -MCr (no color, no compact and no quote on single value)

But now, by default it’s colorized, not raw and if you specify input using -i or –input output will be the same format.

There is also a shorter command wq comming with the package.

Like jq cli, wildq supports both of stdin and file to the function

See examples to get some example.

User Guide¶

Installing wildq¶

wildq is available on PyPI, so you can use pip:

$ pip install wildq

Alternatively, if you don’t have setuptools installed, download it from PyPi and run

$ python setup.py install

To use the bleeding-edge version of wildq, you can get the source from GitHub and install it as above:

$ git clone git://github.com/ahmet2mir/wildq
$ cd wildq
$ python setup.py install

API Reference¶

FileTypes¶

Changelog¶

v1.1.5 - 20/10/2020¶

Compile using glibc 2.17 to get compatibility with lot of GNU/Linux distros
fix release actions

v1.1.4 - 12/10/2020¶

fix osx binary path

v1.1.3 - 12/10/2020¶

fix package brew
tempfix remove RPM (must be build on centos)
tempfix remove binary (must be build with lower version of glibc)

v1.1.2 - 12/10/2020¶

add packages debian, rpm, brew

v1.1.0 - 12/10/2020¶

use click for CLI
add input and output format (close #GH-1)
colorize output
add tests and doc
move from travis to github actions
build using pyinstaller for linux and macos

v1.0.6 - 26/05/2020¶

First release

Indices and tables¶

Licence¶

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.