python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2022-01-21 12:31:03 -08:00
parent e319aea5a4
commit 50ded1dbd9
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/readme.md
View File

@ -7,18 +7,22 @@ JC - JSON CLI output utility
This package serializes the output of many standard unix command line tools This package serializes the output of many standard unix command line tools
to dictionaries and lists of dictionaries. to dictionaries and lists of dictionaries.
Interactive Documentation ## Interactive Documentation
>>> help(jc) >>> help(jc)
>>> help(jc.lib) >>> help(jc.lib)
>>> help(jc.util) >>> help(jc.util)
>>> jc.get_help('parser_module_name') >>> jc.get_help('parser_module_name')
Online Documentation ## Online Documentation
Latest:
https://github.com/kellyjonbrazil/jc/tree/master/docs https://github.com/kellyjonbrazil/jc/tree/master/docs
Example: Specific version (replace <full_version_number> - e.g. `1.17.7`):
https://github.com/kellyjonbrazil/jc/tree/v<full_version_number>/docs
## Example:
>>> import subprocess >>> import subprocess
>>> import jc >>> import jc
@ -41,7 +45,9 @@ modules directly:
>>> data >>> data
[{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}] [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}]
Available Functions (use `help(jc.lib)` for details): ## Available Functions
Use `help(jc.lib)` for details:
parse(parser_module_name: str, data: str | iterable) parse(parser_module_name: str, data: str | iterable)
High-level API to easily access the parser. This API will find both High-level API to easily access the parser. This API will find both