clarketm/pprintjson

A json pretty printer for Python 🐍

pprintjson

A json pretty printer for Python 🐍.

Check out the pprintjson docs

Installation

Install with the standard json JSON encoder

$ pip install pprintjson

Install with the premier simplejson JSON encoder

$ pip install pprintjson[simplejson]

Usage

usage: pprintjson.py [-h] [-i num] [-o file] [-c cmd] [-v] [file]

A pretty-printing function for json.

positional arguments:
  file                    json <file> to pretty-print

optional arguments:
  -h, --help              show this help message and exit
  -i num, --indent num    indent <num> number of spaces at each level (default: 4)
  -o file, --output file  write output to <file> instead of stdout (default: stdout)
  -c cmd, --command cmd   json <cmd> to pretty-print
  -v, --version           show program's version number and exit

Script

Pretty print JSON from a file using the pprintjson CLI.

$ pprintjson "./path/to/file.json"

Pretty print JSON from a stdin using the pprintjson CLI.

$ echo '{ "a": 1, "b": "string", "c": true }' | pprintjson

Pretty print JSON from a string using the pprintjson CLI.

$ pprintjson -c '{ "a": 1, "b": "string", "c": true }'

Pretty print JSON from a string with an indent of 1.

$ pprintjson -c '{ "a": 1, "b": "string", "c": true }' -i 1

Pretty print JSON from a string and save output to a file output.json.

$ pprintjson -c '{ "a": 1, "b": "string", "c": true }' -o ./output.json

Module

Pretty print JSON from a dict using the pprintjson module.

# 1. import the "pprintjson" function.
from pprintjson import pprintjson as ppjson

# 2. pretty print JSON.
obj = { "a": 1, "b": "string", "c": True }

ppjson(obj)

License

MIT © Travis Clarke

pprintjson's Issues

Feature request: save output as a string have `\n`

Thank you for write this lightweight tool! ♥

Sometimes maybe we don't want it only be printed on terminal, but save it in a string

# 1. import the "pprintjson" function.
from pprintjson import pprintjson as ppjson

# 2. pretty print JSON.
obj = { "a": 1, "b": "string", "c": True }

out=ppjson(obj)

For example, I wish out be the formatted {\n "a": 1,\n "b": "string",\n "c": True\n} and can be reused, without to call ppjson() once more.

Install pprintjson as a CLI tool?

pprintjson should be installed as a console script for use at the command line. It should accept input via string, file, or stdin.

Feature request: Have a more consise format

Thank you for you sweet JSON printer, I am using and enjoying it. 🤩
But, pprintjson often uses unnecessary room and I request an option to get a more concise display.

You may be inspired from file prettyjson.py described in that SO answer.

Example of a concise representation converted to an unnecessary verbose one:

$ pprintjson -c '
{
  "grid": {"port": "COM5"},
  "policy": {
    "movingaverage": 5,
    "hysteresis": 5,
    "fan1": {
      "name": "CPU",
      "signal": "cpu",
      "mode": "auto",
      "speed": 100,
      "curve": [[0, 75], [50, 75], [75, 100]]
    }
  }
}'

{
    "grid": {
        "port": "COM5"
    },
    "policy": {
        "movingaverage": 5,
        "hysteresis": 5,
        "fan1": {
            "name": "CPU",
            "signal": "cpu",
            "mode": "auto",
            "speed": 100,
            "curve": [
                [
                    0,
                    75
                ],
                [
                    50,
                    75
                ],
                [
                    75,
                    100
                ]
            ]
        }
    }
}