From 35b54d235d73b2ce658223be3d6095906f142d89 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 19 Jan 2022 21:53:13 -0800 Subject: [PATCH] add python package doc info --- README.md | 3 +++ templates/readme_template | 3 +++ 2 files changed, 6 insertions(+) diff --git a/README.md b/README.md index 63b30071..909e8196 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,9 @@ The `jc` parsers can also be used as python modules. In this case the output wil '2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)', 'when': 'Fri Apr 16 16:13:00 PDT 2021', 'rcvd': 56, 'when_epoch': 1618614780, 'when_epoch_utc': None}] ``` + +> For `jc` Python package documentation, use `help('jc')`, `help('jc.lib')`, or see the [online documentation](https://kellyjonbrazil.github.io/jc/docs/). + Two representations of the data are available. The default representation uses a strict schema per parser and converts known numbers to int/float JSON values. Certain known values of `None` are converted to JSON `null`, known boolean values are converted, and, in some cases, additional semantic context fields are added. To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` function parameter in `parse()`. diff --git a/templates/readme_template b/templates/readme_template index b77e03c7..da14b2e0 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -45,6 +45,9 @@ The `jc` parsers can also be used as python modules. In this case the output wil '2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)', 'when': 'Fri Apr 16 16:13:00 PDT 2021', 'rcvd': 56, 'when_epoch': 1618614780, 'when_epoch_utc': None}] ``` + +> For `jc` Python package documentation, use `help('jc')`, `help('jc.lib')`, or see the [online documentation](https://kellyjonbrazil.github.io/jc/docs/). + Two representations of the data are available. The default representation uses a strict schema per parser and converts known numbers to int/float JSON values. Certain known values of `None` are converted to JSON `null`, known boolean values are converted, and, in some cases, additional semantic context fields are added. To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` function parameter in `parse()`.