```eval_rst
.. meta::
   :description: pprintjson: A json pretty printer for Python 🐍.

.. title:: pprintjson
```

# [pprintjson](https://pypi.org/project/pprintjson/)

```eval_rst
Version |version|

.. image:: https://img.shields.io/pypi/v/pprintjson.svg
    :target: https://pypi.org/project/pprintjson/

.. image:: https://img.shields.io/pypi/pyversions/pprintjson.svg
    :target: https://pypi.org/project/pprintjson/

.. image:: https://pepy.tech/badge/pprintjson
    :target: https://pepy.tech/project/pprintjson
    
```

**A json pretty printer for Python 🐍.**

## Installation

Install with the standard [`json`](https://docs.python.org/3/library/json.html) JSON encoder

```bash
$ pip install pprintjson
```

Install with the premier [`simplejson`](https://simplejson.readthedocs.io/en/latest/) JSON encoder
```bash
$ pip install pprintjson[simplejson]
```

## Usage

```text

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.

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

Pretty print JSON from a **stdin** using the `pprintjson` CLI.

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

Pretty print JSON from a **string** using the `pprintjson` CLI.

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

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

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

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

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

### Module

Pretty print JSON from a **dict** using the `pprintjson` module.

```python

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

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

ppjson(obj)
```

![stdout](https://raw.githubusercontent.com/clarketm/pprintjson/master/pprintjson.png)

## License

MIT © [**Travis Clarke**](https://blog.travismclarke.com/)