ctomkow / jsonparse Goto Github PK

The web api needs to be documented properly to create a new release

Think about how to return the values in order.

Provide a group_by parameter for the methods to return the found values as part of a two dimensional list. Each found value part of the same dict will be returned as a list. Multiple lists will be returned within a list.

The new find_keys() function currently returns a 2d list. The default behaviour should be changed to return a simple list, and return a 2d list if the group_by parameter is True. The parameter should have a default of False.

• The idea behind this is to be able to return values based on a partial key match. e.g. find_key(data, 'myk') would match on the key mykey. This was prompted by the future cli mode of operation. This would allow piping a large chunk of json into the the cli app and matching on key guesses, in case you haven't fully manually scanned the large json data for the exact key to match beforehand.

• Include the feature to pipe data into the cli app, like typical *nix tools allow. This would allow for chaining of commands.
  curl my.api.with.highly.nested.json.response | jsonparse --find_key_chain ['my', 'key', 'chain']

• Also, support the ability to provide a file of JSON as a flag.
  jsonparse --file my.json --find_key 'mykey'

Currently find_key_chain() has the * operator to match all. Lets have an option to pass a list as an element to match multiple.

E.g. [ 'my', 'key', ['chain', 'rope'] ]
returns ['A', 5]

• Create a complete tutorial for newer users to python and libraries.
  e.g. requests public api -> json.loads() -> jsonparse

It would return the parent set (like find_key_value) that contains the specified value.

Not sure why one would search based only on the value, but might be handy.

Does not affect the key() method, only the key_chain() method.

If the result is a single list, have a --single flag to return just the JSON type (e.g. a list), not a value in a list. Currently, all JSON types are added to a list, even if it's just one list for consistency. Avoids a [0] or a pop() for nested lists situations. Just avoids dealing with a list result of one item when you know for sure only one value is found. I think this would be a bit cleaner.

When pip installing --user, I noticed that the docs and tests folder gets dumped in the parent directory (python3.10) that holds jsonparse library.