Skip to content

Commit

Permalink
documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
stringertheory committed Jun 7, 2023
1 parent 7199990 commit 91da525
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -38,7 +38,7 @@ For more details, see the [full
documentation](https://stringertheory.github.io/json-explorer/>).


### Other tools to help with
### Other tools to help with JSON data

This tool is intended for quick and dirty exploration of JSONs. If
that's not what you need, there are a *lot* of great resources for
Expand Down
40 changes: 34 additions & 6 deletions docs/index.md
@@ -1,8 +1,36 @@
# json-explorer

[![Release](https://img.shields.io/github/v/release/stringertheory/json-explorer)](https://img.shields.io/github/v/release/stringertheory/json-explorer)
[![Build status](https://img.shields.io/github/actions/workflow/status/stringertheory/json-explorer/main.yml?branch=main)](https://github.com/stringertheory/json-explorer/actions/workflows/main.yml?query=branch%3Amain)
[![Commit activity](https://img.shields.io/github/commit-activity/m/stringertheory/json-explorer)](https://img.shields.io/github/commit-activity/m/stringertheory/json-explorer)
[![License](https://img.shields.io/github/license/stringertheory/json-explorer)](https://img.shields.io/github/license/stringertheory/json-explorer)
[![codecov](https://codecov.io/gh/stringertheory/json-explorer/branch/main/graph/badge.svg)](https://codecov.io/gh/stringertheory/json-explorer)

# JSON Explorer

Explore the structure and contents of a group of JSONs, like responses
from an API.

### Installation

```
pip install json-explorer
```

JSON Explorer is a small tool with no dependencies and is tested in
Python 3.7+.

### Getting started

Get started by writing a few JSONs you want to explore to a file, one
per line. Then run `json-explorer` from the command line:

```
json-explorer data_from_an_undocumented_API.jsonl
```

If you just want to try it out but don't have JSONs in a file, you can
run `json-explorer --example` to see how it works with example data.

This will pop up a web page that helps you explore the properties of
the objects, what data types are in there, what values are unique, and
more.

From there, you might use `jq` or `jmespath` to write something to
more read the data that you're interested in using.

Explore the structure of a bunch of jsons.
4 changes: 3 additions & 1 deletion docs/modules.md
@@ -1 +1,3 @@
::: json_explorer
::: json_explorer

::: json_explorer.explore.TripleCounter

0 comments on commit 91da525

Please sign in to comment.