* Package name : jiq Version : 0.6.0+git20180621.a79e8b2-1 Upstream Author : Giovanni T. Parra * URL : https://github.com/fiatjaf/jiq * License : MIT Programming Lang: Go Description : jid on jq jiq Mentioned in Awesome jq (https://github.com/fiatjaf/awesome-jq) It's jid (https://github.com/simeji/jid) with jq (https://stedolan.github.io/jq/). . You can drill down interactively by using jq (https://stedolan.github.io/jq/) filtering queries. . jiq uses jq (https://stedolan.github.io/jq/) internally, and it requires you to have jq in your PATH. . If you prefer, there's an experimental, standalone, purely client-side web version of this on https://jq.alhur.es/jiq/. Demo screencast-repo.gif . screencast-packagejson.gif Installation . go get github.com/fiatjaf/jiq/cmd/jiq . . If you don't have jq installed, follow instructions at https://stedolan.github.io/jq/download/ and make sure to put it in your PATH. UsageQuick start• simple example (#simple-example)• advanced usage examples (#advanced-usage-examples)• with curl (#with-curl)simple example Execute the following command: . . echo '{"aa":"2AA2","bb":{"aaa":[123,"cccc",[1,2]],"c":321}}'| jiq . . Then jiq will be running. Now you can dig JSON data incrementally. . When you enter .bb.aaa[2], you will see the following. . . [Filter]> .bb.aaa[2] [ 1, 2 ] . . If you press Enter now it will output . json [ 1, 2 ] . . and exit (if you want all the output in a single line you can either call jiq -c or pipe it into jq as jiq | jq -c .). advanced usage examples If you have ever used jq, you'll be familiar with these: . . echo '{"economists": [{"id": 1, "name": "menger"}, {"id": 2, "name": "mises"}, {"name": "hayek", "id": 3}]}' | jiq . . Now try writing .economists | "\(.[0].name), \(.[1].name) and \(.[2].name) are economists." or [.economists.[].id], or even .economists | map({key: "\(.id)", value: .name}) | from_entries with curl Sample for using RDAP (https://datatracker.ietf.org/wg/weirds/documents/) data. . . curl -s http://rdg.afilias.info/rdap/domain/example.info | jiq . command line arguments -q : print the jq filter instead of the resulting filtered JSON to stdout (if you plan to use this with jq later) . Plus all the arguments jq accepts (https://stedolan.github.io/jq/manual/#Invokingjq) -- they will affect both the JSON output inside jiq and the output that is printed to stdout (beware that some may cause bugs). -------------------------------------------------------------------------------- . traffic analytics for this repo: . [](https://ght.trackingco.de/) jiq is a fork of jid
[...] That whole long description seems to be a readme pasted in. Not very useful. And the short desc is also entirely useless. Please ensure writing up something way more descriptive (wth is jid? nothing here tells) for the actual package, thanks.
* Package name : jiq Version : 0.6.0+git20180621.a79e8b2-1 Upstream Author : Giovanni T. Parra * URL : https://github.com/fiatjaf/jiq * License : MIT Programming Lang: Go Description : json incremental digger (jid) with jq jiq is a fork of jid (https://github.com/simeji/jid) with jq (https://stedolan.github.io/jq/) under the hood. . You can drill down interactively by using jq filtering queries. . jiq calls jq and thus requires that it can be found in the PATH.
[...] But what is jid? What is jq? This whole description is useless. Also, in the updated description, it says "json incremental digger". The only thing that tells me is that it has something to do with JSON. And it's interactive, but is this a command line tool? A GUI? A web thing? The description should be such that someone who doesn't already know the tool will understand what this tool is about, what it can do, and what environment it can be used in. Also please avoid terms like "digging" and "drilling" in the description, those are not commonly used terms and it will confuse people. Rather use "querying", "searching" et cetera.
June 24, 2018 3:03 PM, "Guus Sliepen" <guus@debian.org> wrote: Package: wnpp Severity: wishlist Owner: Zenon Mousmoulas <zmousm@noc.grnet.gr> * Package name : jiq Version : 0.6.0+git20180621.a79e8b2-1 Upstream Author : Giovanni T. Parra * URL : https://github.com/fiatjaf/jiq * License : Expat Programming Lang: Go Description : json incremental digger (jid) with jq jiq is a fork of jid (https://github.com/simeji/jid) using jq (https://stedolan.github.io/jq/) under the hood. . It is a command line tool that can be used to interactively drill down on json input using jq filtering queries. . jiq calls jq and requires that it can be found in PATH.
Even though the name jid stands for json incremental digger, you don't need to include that in the description. I'd certainly not use it in the short description, but mention it in the long description so one can still search for "incremental digger" and find this package. Also, the acronym JSON should be spelled with all caps. I would not mention these facts as the first thing in the description. That's useful information. I'd still try to reword "drill down". this will be taken care of automatically when you install your package. Just like you won't see "foo uses the GNU standard C library and requires that it be found in the standard system library paths or in LD_LIBRARY_PATH". Ok, it's easy to criticize, so let me try to make a description myself, and then you can decide if you want to pick some things from it: Description: interactive JSON query tool using jq expressions jiq is a command line tool that parses a JSON document and allows you to interactively query and filter it using jq expressions. jiq also provides suggestions and tab completion. . jiq is a fork of jid, but fully supports the jq language (see https://stedolan.github.io/jq/).
June 24, 2018 11:34 PM, "Guus Sliepen" <guus@debian.org> wrote: Right. It was just another piece of upstream readme I didn't consider stripping out. Fine, thanks. I will just exclude this last statement about tab completion, because I am afraid it is not true. Package: wnpp Severity: wishlist Owner: Zenon Mousmoulas <zmousm@noc.grnet.gr> * Package name : jiq Version : 0.6.0+git20180621.a79e8b2-1 Upstream Author : Giovanni T. Parra * URL : https://github.com/fiatjaf/jiq * License : Expat Programming Lang: Go Description : interactive JSON query tool using jq expressions jiq is a command line tool that parses a JSON document and allows you to interactively query and filter it using jq expressions. . jiq is a fork of jid, which rather supports the jq language (see https://stedolan.github.io/jq).
retitle 902267 ITP: jiq -- interactive JSON query tool using jq expressions
people who don't know what jid is (or which jid you mean). For the record, jid's short description is: "jid - json incremental digger" And its long description is: "jid a very simple tool. You can drill down JSON interactively by using filtering queries like jq. Suggestion and Auto completion of this tool will provide you a very comfortable JSON drill down." ... This is not a good long description. Please have a look at several other packages in Debian to get the idea of what we use long descriptions for... That said, the very first thing you want in that long description is to explain in very concise way what a json incremental digger is, and what jiq does (I assume it does something more than what jid does), and what it does better/more than jid.
June 25, 2018 5:33 PM, "Henrique de Moraes Holschuh" <hmh@debian.org> wrote: I wonder if you have noticed the updated ITP I posted: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=902267#39 Maybe that should have been a new submission after all?
I didn't. The dang thing drops debian-devel from the CC list after the initial submission, and I forgot it does that. Thus, I didn't read the full report before replying... No, you did what you were supposed to do. Your new short and full descriptions are good enough as far as I am concerned, BTW. Thanks.