diff --git a/README.md b/README.md index 3278bd36..42b194d1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ ![Tests](https://github.com/kellyjonbrazil/jc/workflows/Tests/badge.svg?branch=master) ![Pypi](https://img.shields.io/pypi/v/jc.svg) -> `jc` was recently featured in the [Console Open Source Newsletter](https://console.substack.com/p/console-89) - > Check out the `jc` Python [package documentation](https://github.com/kellyjonbrazil/jc/tree/master/docs) for developers > Try the `jc` [web demo](https://jc-web-demo.herokuapp.com/) @@ -13,7 +11,7 @@ Ansible filter plugin in the `community.general` collection. See this for an example. # JC -JSON CLI output utility +JSON Convert `jc` JSONifies the output of many CLI tools and file-types for easier parsing in scripts. See the [**Parsers**](#parsers) section for supported commands and diff --git a/docgen.sh b/docgen.sh index 38495775..8b2b272d 100755 --- a/docgen.sh +++ b/docgen.sh @@ -18,7 +18,7 @@ readme_config=$(cat <<'EOF' "Class": 3, "Method": 3, "Function": 3, - "Data": 3 + "Variable": 3 } } } @@ -43,7 +43,7 @@ toc_config=$(cat <<'EOF' "Class": 3, "Method": 3, "Function": 3, - "Data": 3 + "Variable": 3 } } } @@ -68,7 +68,7 @@ parser_config=$(cat <<'EOF' "Class": 3, "Method": 3, "Function": 3, - "Data": 3 + "Variable": 3 } } } diff --git a/docs/lib.md b/docs/lib.md index b659b66d..67e5ea34 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -14,15 +14,20 @@ # jc.lib -jc - JSON CLI output utility +jc - JSON Convert JC lib module -### parse +#### parse ```python -def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: bool = False, raw: bool = False, ignore_exceptions: bool = None, **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]] +def parse(parser_mod_name: str, + data: Union[str, Iterable[str]], + quiet: bool = False, + raw: bool = False, + ignore_exceptions: bool = None, + **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]] ``` Parse the string data using the supplied parser module. @@ -81,7 +86,7 @@ Returns: -### parser\_mod\_list +#### parser\_mod\_list ```python def parser_mod_list() -> List[str] @@ -91,7 +96,7 @@ Returns a list of all available parser module names. -### plugin\_parser\_mod\_list +#### plugin\_parser\_mod\_list ```python def plugin_parser_mod_list() -> List[str] @@ -102,7 +107,7 @@ subset of `parser_mod_list()`. -### standard\_parser\_mod\_list +#### standard\_parser\_mod\_list ```python def standard_parser_mod_list() -> List[str] @@ -114,7 +119,7 @@ parsers. -### streaming\_parser\_mod\_list +#### streaming\_parser\_mod\_list ```python def streaming_parser_mod_list() -> List[str] @@ -125,7 +130,7 @@ subset of `parser_mod_list()`. -### parser\_info +#### parser\_info ```python def parser_info(parser_mod_name: str) -> Dict @@ -138,7 +143,7 @@ This function will accept **module_name**, **cli-name**, and -### all\_parser\_info +#### all\_parser\_info ```python def all_parser_info() -> List[Dict] @@ -148,7 +153,7 @@ Returns a list of dictionaries that includes metadata for all modules. -### get\_help +#### get\_help ```python def get_help(parser_mod_name: str) -> None diff --git a/docs/parsers/acpi.md b/docs/parsers/acpi.md index d6adf5a8..e486954f 100644 --- a/docs/parsers/acpi.md +++ b/docs/parsers/acpi.md @@ -3,7 +3,7 @@ # jc.parsers.acpi -jc - JSON CLI output utility `acpi` command output parser +jc - JSON Convert `acpi` command output parser Usage (cli): @@ -234,7 +234,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/airport.md b/docs/parsers/airport.md index 24abb893..e9fa5490 100644 --- a/docs/parsers/airport.md +++ b/docs/parsers/airport.md @@ -3,7 +3,7 @@ # jc.parsers.airport -jc - JSON CLI output utility `airport -I` command output parser +jc - JSON Convert `airport -I` command output parser The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`. @@ -87,7 +87,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/airport_s.md b/docs/parsers/airport_s.md index ae9afae4..84b8e4a0 100644 --- a/docs/parsers/airport_s.md +++ b/docs/parsers/airport_s.md @@ -3,7 +3,7 @@ # jc.parsers.airport\_s -jc - JSON CLI output utility `airport -s` command output parser +jc - JSON Convert `airport -s` command output parser The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`. @@ -115,7 +115,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index 09ca6d08..136476b6 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -3,7 +3,7 @@ # jc.parsers.arp -jc - JSON CLI output utility `arp` command output parser +jc - JSON Convert `arp` command output parser Supports `arp` and `arp -a` output. @@ -124,7 +124,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/blkid.md b/docs/parsers/blkid.md index b94411f2..11f81041 100644 --- a/docs/parsers/blkid.md +++ b/docs/parsers/blkid.md @@ -3,7 +3,7 @@ # jc.parsers.blkid -jc - JSON CLI output utility `blkid` command output parser +jc - JSON Convert `blkid` command output parser Usage (cli): @@ -127,7 +127,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/cksum.md b/docs/parsers/cksum.md index 0ba7468e..aee5efc4 100644 --- a/docs/parsers/cksum.md +++ b/docs/parsers/cksum.md @@ -3,7 +3,7 @@ # jc.parsers.cksum -jc - JSON CLI output utility `cksum` command output parser +jc - JSON Convert `cksum` command output parser This parser works with the following checksum calculation utilities: - `sum` @@ -61,7 +61,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/crontab.md b/docs/parsers/crontab.md index d4f518b6..ae9c4c31 100644 --- a/docs/parsers/crontab.md +++ b/docs/parsers/crontab.md @@ -3,7 +3,7 @@ # jc.parsers.crontab -jc - JSON CLI output utility `crontab -l` command output and crontab +jc - JSON Convert `crontab -l` command output and crontab file parser Supports `crontab -l` command output and crontab files. @@ -180,7 +180,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/crontab_u.md b/docs/parsers/crontab_u.md index 718cb49a..bfcd45a6 100644 --- a/docs/parsers/crontab_u.md +++ b/docs/parsers/crontab_u.md @@ -3,7 +3,7 @@ # jc.parsers.crontab\_u -jc - JSON CLI output utility `crontab -l` command output and crontab +jc - JSON Convert `crontab -l` command output and crontab file parser This version of the `crontab -l` parser supports output that contains user @@ -177,7 +177,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/csv.md b/docs/parsers/csv.md index 95656d8e..d98a4945 100644 --- a/docs/parsers/csv.md +++ b/docs/parsers/csv.md @@ -3,7 +3,7 @@ # jc.parsers.csv -jc - JSON CLI output utility `csv` file parser +jc - JSON Convert `csv` file parser The `csv` parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default to comma. @@ -84,7 +84,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index 6362a7a1..902d117b 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -3,7 +3,7 @@ # jc.parsers.csv\_s -jc - JSON CLI output utility `csv` file streaming parser +jc - JSON Convert `csv` file streaming parser > This streaming parser outputs JSON Lines @@ -70,7 +70,7 @@ Examples: -### parse +#### parse ```python @add_jc_meta diff --git a/docs/parsers/date.md b/docs/parsers/date.md index e4966ba9..d348d089 100644 --- a/docs/parsers/date.md +++ b/docs/parsers/date.md @@ -3,7 +3,7 @@ # jc.parsers.date -jc - JSON CLI output utility `date` command output parser +jc - JSON Convert `date` command output parser The `epoch` calculated timestamp field is naive. (i.e. based on the local time of the system the parser is run on) @@ -84,7 +84,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/df.md b/docs/parsers/df.md index 4e787857..25ee0773 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -3,7 +3,7 @@ # jc.parsers.df -jc - JSON CLI output utility `df` command output parser +jc - JSON Convert `df` command output parser Usage (cli): @@ -104,7 +104,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index d1459682..70bd67ea 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -3,7 +3,7 @@ # jc.parsers.dig -jc - JSON CLI output utility `dig` command output parser +jc - JSON Convert `dig` command output parser Options supported: - `+noall +answer` options are supported in cases where only the answer @@ -329,7 +329,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dir.md b/docs/parsers/dir.md index 02e08ac5..84a76476 100644 --- a/docs/parsers/dir.md +++ b/docs/parsers/dir.md @@ -3,7 +3,7 @@ # jc.parsers.dir -jc - JSON CLI output utility `dir` command output parser +jc - JSON Convert `dir` command output parser Options supported: - `/T timefield` @@ -127,7 +127,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dmidecode.md b/docs/parsers/dmidecode.md index 8591a534..a7664b6d 100644 --- a/docs/parsers/dmidecode.md +++ b/docs/parsers/dmidecode.md @@ -3,7 +3,7 @@ # jc.parsers.dmidecode -jc - JSON CLI output utility `dmidecode` command output parser +jc - JSON Convert `dmidecode` command output parser Usage (cli): @@ -132,7 +132,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dpkg_l.md b/docs/parsers/dpkg_l.md index 0daa5f96..6b24634c 100644 --- a/docs/parsers/dpkg_l.md +++ b/docs/parsers/dpkg_l.md @@ -3,7 +3,7 @@ # jc.parsers.dpkg\_l -jc - JSON CLI output utility `dpkg -l` command output parser +jc - JSON Convert `dpkg -l` command output parser Set the `COLUMNS` environment variable to a large value to avoid field truncation. For example: @@ -138,7 +138,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/du.md b/docs/parsers/du.md index 6168bfda..12ec1ca4 100644 --- a/docs/parsers/du.md +++ b/docs/parsers/du.md @@ -3,7 +3,7 @@ # jc.parsers.du -jc - JSON CLI output utility `du` command output parser +jc - JSON Convert `du` command output parser Usage (cli): @@ -94,7 +94,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/env.md b/docs/parsers/env.md index 428f02d1..dd625602 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -3,7 +3,7 @@ # jc.parsers.env -jc - JSON CLI output utility `env` and `printenv` command output parser +jc - JSON Convert `env` and `printenv` command output parser This parser will output a list of dictionaries each containing `name` and `value` keys. If you would like a simple dictionary output, then use the @@ -79,7 +79,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/file.md b/docs/parsers/file.md index aefb2165..b95f0d29 100644 --- a/docs/parsers/file.md +++ b/docs/parsers/file.md @@ -3,7 +3,7 @@ # jc.parsers.file -jc - JSON CLI output utility `file` command output parser +jc - JSON Convert `file` command output parser Usage (cli): @@ -69,7 +69,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/finger.md b/docs/parsers/finger.md index a48edaa9..56daa2bc 100644 --- a/docs/parsers/finger.md +++ b/docs/parsers/finger.md @@ -3,7 +3,7 @@ # jc.parsers.finger -jc - JSON CLI output utility `finger` command output parser +jc - JSON Convert `finger` command output parser Supports `-s` output option. Does not support the `-l` detail option. @@ -97,7 +97,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/free.md b/docs/parsers/free.md index 4e3fa757..1b8fd722 100644 --- a/docs/parsers/free.md +++ b/docs/parsers/free.md @@ -3,7 +3,7 @@ # jc.parsers.free -jc - JSON CLI output utility `free` command output parser +jc - JSON Convert `free` command output parser Usage (cli): @@ -79,7 +79,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/fstab.md b/docs/parsers/fstab.md index 4d4707ec..5f4a2773 100644 --- a/docs/parsers/fstab.md +++ b/docs/parsers/fstab.md @@ -3,7 +3,7 @@ # jc.parsers.fstab -jc - JSON CLI output utility `fstab` file parser +jc - JSON Convert `fstab` file parser Usage (cli): @@ -92,7 +92,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/group.md b/docs/parsers/group.md index 14037ccc..0e3fb442 100644 --- a/docs/parsers/group.md +++ b/docs/parsers/group.md @@ -3,7 +3,7 @@ # jc.parsers.group -jc - JSON CLI output utility `/etc/group` file parser +jc - JSON Convert `/etc/group` file parser Usage (cli): @@ -116,7 +116,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/gshadow.md b/docs/parsers/gshadow.md index d70b01ca..1a1b7a70 100644 --- a/docs/parsers/gshadow.md +++ b/docs/parsers/gshadow.md @@ -3,7 +3,7 @@ # jc.parsers.gshadow -jc - JSON CLI output utility `/etc/gshadow` file parser +jc - JSON Convert `/etc/gshadow` file parser Usage (cli): @@ -84,7 +84,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hash.md b/docs/parsers/hash.md index 319591d2..ca6109e0 100644 --- a/docs/parsers/hash.md +++ b/docs/parsers/hash.md @@ -3,7 +3,7 @@ # jc.parsers.hash -jc - JSON CLI output utility `hash` command output parser +jc - JSON Convert `hash` command output parser Usage (cli): @@ -44,7 +44,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hashsum.md b/docs/parsers/hashsum.md index a2ca926c..984babe3 100644 --- a/docs/parsers/hashsum.md +++ b/docs/parsers/hashsum.md @@ -3,7 +3,7 @@ # jc.parsers.hashsum -jc - JSON CLI output utility `hash sum` command output parser +jc - JSON Convert `hash sum` command output parser This parser works with the following hash calculation utilities: - `md5` @@ -75,7 +75,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hciconfig.md b/docs/parsers/hciconfig.md index 7a486eb6..9fe21dcb 100644 --- a/docs/parsers/hciconfig.md +++ b/docs/parsers/hciconfig.md @@ -3,7 +3,7 @@ # jc.parsers.hciconfig -jc - JSON CLI output utility `hciconfig` command output parser +jc - JSON Convert `hciconfig` command output parser Usage (cli): @@ -324,7 +324,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/history.md b/docs/parsers/history.md index 54ce0dea..19b5be41 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -3,7 +3,7 @@ # jc.parsers.history -jc - JSON CLI output utility `history` command output parser +jc - JSON Convert `history` command output parser This parser will output a list of dictionaries each containing `line` and `command` keys. If you would like a simple dictionary output, then use the @@ -70,7 +70,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hosts.md b/docs/parsers/hosts.md index 9b9d165b..2aecaac7 100644 --- a/docs/parsers/hosts.md +++ b/docs/parsers/hosts.md @@ -3,7 +3,7 @@ # jc.parsers.hosts -jc - JSON CLI output utility `/etc/hosts` file parser +jc - JSON Convert `/etc/hosts` file parser Usage (cli): @@ -81,7 +81,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/id.md b/docs/parsers/id.md index f231d485..ac8efbc0 100644 --- a/docs/parsers/id.md +++ b/docs/parsers/id.md @@ -3,7 +3,7 @@ # jc.parsers.id -jc - JSON CLI output utility `id` command output parser +jc - JSON Convert `id` command output parser Usage (cli): @@ -112,7 +112,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index b742d594..686426d7 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -3,7 +3,7 @@ # jc.parsers.ifconfig -jc - JSON CLI output utility `ifconfig` command output parser +jc - JSON Convert `ifconfig` command output parser Note: No `ifconfig` options are supported. @@ -193,7 +193,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index f5d7892d..eac8190d 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -3,7 +3,7 @@ # jc.parsers.ini -jc - JSON CLI output utility `INI` file parser +jc - JSON Convert `INI` file parser Parses standard `INI` files and files containing simple key/value pairs. Delimiter can be `=` or `:`. Missing values are supported. Comment prefix @@ -73,7 +73,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/iostat.md b/docs/parsers/iostat.md index e0843778..fdf63c60 100644 --- a/docs/parsers/iostat.md +++ b/docs/parsers/iostat.md @@ -3,7 +3,7 @@ # jc.parsers.iostat -jc - JSON CLI output utility `iostat` command output parser +jc - JSON Convert `iostat` command output parser Note: `iostat` version 11 and higher include a JSON output option @@ -166,7 +166,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/iostat_s.md b/docs/parsers/iostat_s.md index 1fc68dac..162fd3a9 100644 --- a/docs/parsers/iostat_s.md +++ b/docs/parsers/iostat_s.md @@ -3,7 +3,7 @@ # jc.parsers.iostat\_s -jc - JSON CLI output utility `iostat` command output streaming parser +jc - JSON Convert `iostat` command output streaming parser > This streaming parser outputs JSON Lines @@ -107,7 +107,7 @@ Examples: -### parse +#### parse ```python @add_jc_meta diff --git a/docs/parsers/iptables.md b/docs/parsers/iptables.md index 3066c881..9a98a899 100644 --- a/docs/parsers/iptables.md +++ b/docs/parsers/iptables.md @@ -3,7 +3,7 @@ # jc.parsers.iptables -jc - JSON CLI output utility `iptables` command output parser +jc - JSON Convert `iptables` command output parser Supports `-vLn` and `--line-numbers` for all tables. @@ -170,7 +170,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/iw_scan.md b/docs/parsers/iw_scan.md index df0ed6df..5dd0bd85 100644 --- a/docs/parsers/iw_scan.md +++ b/docs/parsers/iw_scan.md @@ -3,7 +3,7 @@ # jc.parsers.iw\_scan -jc - JSON CLI output utility `iw dev scan` command output parser +jc - JSON Convert `iw dev scan` command output parser This parser is considered beta quality. Not all fields are parsed and there are not enough samples to test. @@ -128,7 +128,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/jar_manifest.md b/docs/parsers/jar_manifest.md index 7e2b44d2..2b14cebc 100644 --- a/docs/parsers/jar_manifest.md +++ b/docs/parsers/jar_manifest.md @@ -3,7 +3,7 @@ # jc.parsers.jar\_manifest -jc - JSON CLI output utility `MANIFEST.MF` file parser +jc - JSON Convert `MANIFEST.MF` file parser Usage (cli): @@ -84,7 +84,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/jobs.md b/docs/parsers/jobs.md index d24d7e2b..69209734 100644 --- a/docs/parsers/jobs.md +++ b/docs/parsers/jobs.md @@ -3,7 +3,7 @@ # jc.parsers.jobs -jc - JSON CLI output utility `jobs` command output parser +jc - JSON Convert `jobs` command output parser Also supports the `-l` option. @@ -100,7 +100,7 @@ Example: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/kv.md b/docs/parsers/kv.md index 024e1a88..4b71f64d 100644 --- a/docs/parsers/kv.md +++ b/docs/parsers/kv.md @@ -3,7 +3,7 @@ # jc.parsers.kv -jc - JSON CLI output utility `Key/Value` file parser +jc - JSON Convert `Key/Value` file parser Supports files containing simple key/value pairs. Delimiter can be `=` or `:`. Missing values are supported. Comment prefix can be `#` or `;`. @@ -60,7 +60,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/last.md b/docs/parsers/last.md index aa9de406..b2dfb32c 100644 --- a/docs/parsers/last.md +++ b/docs/parsers/last.md @@ -3,7 +3,7 @@ # jc.parsers.last -jc - JSON CLI output utility `last` and `lastb` command output parser +jc - JSON Convert `last` and `lastb` command output parser Supports `-w` and `-F` options. @@ -111,7 +111,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index 2ae42823..d3b0ea8b 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -3,7 +3,7 @@ # jc.parsers.ls -jc - JSON CLI output utility `ls` and `vdir` command output parser +jc - JSON Convert `ls` and `vdir` command output parser Options supported: - `lbaR1` @@ -123,7 +123,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index bd0e5979..82ce4f6a 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -3,7 +3,7 @@ # jc.parsers.ls\_s -jc - JSON CLI output utility `ls` and `vdir` command output streaming +jc - JSON Convert `ls` and `vdir` command output streaming parser > This streaming parser outputs JSON Lines @@ -84,7 +84,7 @@ Examples: -### parse +#### parse ```python @add_jc_meta diff --git a/docs/parsers/lsblk.md b/docs/parsers/lsblk.md index 137bb66b..24c8d6e8 100644 --- a/docs/parsers/lsblk.md +++ b/docs/parsers/lsblk.md @@ -3,7 +3,7 @@ # jc.parsers.lsblk -jc - JSON CLI output utility `lsblk` command output parser +jc - JSON Convert `lsblk` command output parser Usage (cli): @@ -281,7 +281,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsmod.md b/docs/parsers/lsmod.md index 918196c2..dda48fb4 100644 --- a/docs/parsers/lsmod.md +++ b/docs/parsers/lsmod.md @@ -3,7 +3,7 @@ # jc.parsers.lsmod -jc - JSON CLI output utility `lsmod` command output parser +jc - JSON Convert `lsmod` command output parser Usage (cli): @@ -132,7 +132,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsof.md b/docs/parsers/lsof.md index 91d8b439..90945628 100644 --- a/docs/parsers/lsof.md +++ b/docs/parsers/lsof.md @@ -3,7 +3,7 @@ # jc.parsers.lsof -jc - JSON CLI output utility `lsof` command output parser +jc - JSON Convert `lsof` command output parser Usage (cli): @@ -126,7 +126,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsusb.md b/docs/parsers/lsusb.md index 4243593c..9be5c776 100644 --- a/docs/parsers/lsusb.md +++ b/docs/parsers/lsusb.md @@ -3,7 +3,7 @@ # jc.parsers.lsusb -jc - JSON CLI output utility `lsusb` command output parser +jc - JSON Convert `lsusb` command output parser Supports the `-v` option or no options. @@ -268,7 +268,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/mount.md b/docs/parsers/mount.md index 4eb3ba20..cee2b027 100644 --- a/docs/parsers/mount.md +++ b/docs/parsers/mount.md @@ -3,7 +3,7 @@ # jc.parsers.mount -jc - JSON CLI output utility `mount` command output parser +jc - JSON Convert `mount` command output parser Usage (cli): @@ -82,7 +82,7 @@ Example: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/netstat.md b/docs/parsers/netstat.md index c48fbcfc..260237ef 100644 --- a/docs/parsers/netstat.md +++ b/docs/parsers/netstat.md @@ -3,7 +3,7 @@ # jc.parsers.netstat -jc - JSON CLI output utility `netstat` command output parser +jc - JSON Convert `netstat` command output parser Caveats: - Use of multiple `l` options is not supported on OSX (e.g. `netstat -rlll`) @@ -362,7 +362,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/nmcli.md b/docs/parsers/nmcli.md index 518f24bf..b0971100 100644 --- a/docs/parsers/nmcli.md +++ b/docs/parsers/nmcli.md @@ -3,7 +3,7 @@ # jc.parsers.nmcli -jc - JSON CLI output utility `nmcli` command output parser +jc - JSON Convert `nmcli` command output parser Supports the following `nmcli` subcommands: - `nmcli general` @@ -152,7 +152,7 @@ Examples: -### parse +#### parse ```python def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict] diff --git a/docs/parsers/ntpq.md b/docs/parsers/ntpq.md index 15ca65db..73e30589 100644 --- a/docs/parsers/ntpq.md +++ b/docs/parsers/ntpq.md @@ -3,7 +3,7 @@ # jc.parsers.ntpq -jc - JSON CLI output utility `ntpq -p` command output parser +jc - JSON Convert `ntpq -p` command output parser Usage (cli): @@ -213,7 +213,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/passwd.md b/docs/parsers/passwd.md index e0682d55..f30b1f39 100644 --- a/docs/parsers/passwd.md +++ b/docs/parsers/passwd.md @@ -3,7 +3,7 @@ # jc.parsers.passwd -jc - JSON CLI output utility `/etc/passwd` file Parser +jc - JSON Convert `/etc/passwd` file Parser Usage (cli): @@ -101,7 +101,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ping.md b/docs/parsers/ping.md index 3ffce210..eaea4e9c 100644 --- a/docs/parsers/ping.md +++ b/docs/parsers/ping.md @@ -3,7 +3,7 @@ # jc.parsers.ping -jc - JSON CLI output utility `ping` command output parser +jc - JSON Convert `ping` command output parser Supports `ping` and `ping6` output. @@ -169,7 +169,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index b904e2b7..7fc3c204 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -3,7 +3,7 @@ # jc.parsers.ping\_s -jc - JSON CLI output utility `ping` command output streaming parser +jc - JSON Convert `ping` command output streaming parser > This streaming parser outputs JSON Lines @@ -90,7 +90,7 @@ Examples: -### parse +#### parse ```python @add_jc_meta diff --git a/docs/parsers/pip_list.md b/docs/parsers/pip_list.md index de814615..c05f99cb 100644 --- a/docs/parsers/pip_list.md +++ b/docs/parsers/pip_list.md @@ -3,7 +3,7 @@ # jc.parsers.pip\_list -jc - JSON CLI output utility `pip-list` command output parser +jc - JSON Convert `pip-list` command output parser Usage (cli): @@ -54,7 +54,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/pip_show.md b/docs/parsers/pip_show.md index 9de9de46..b378f604 100644 --- a/docs/parsers/pip_show.md +++ b/docs/parsers/pip_show.md @@ -3,7 +3,7 @@ # jc.parsers.pip\_show -jc - JSON CLI output utility `pip-show` command output parser +jc - JSON Convert `pip-show` command output parser Usage (cli): @@ -72,7 +72,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ps.md b/docs/parsers/ps.md index b2e21c5c..51aece3a 100644 --- a/docs/parsers/ps.md +++ b/docs/parsers/ps.md @@ -3,7 +3,7 @@ # jc.parsers.ps -jc - JSON CLI output utility `ps` command output parser +jc - JSON Convert `ps` command output parser `ps` options supported: - `ef` @@ -213,7 +213,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/route.md b/docs/parsers/route.md index c44d9a2a..961f21d8 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -3,7 +3,7 @@ # jc.parsers.route -jc - JSON CLI output utility `route` command output parser +jc - JSON Convert `route` command output parser Usage (cli): @@ -115,7 +115,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/rpm_qi.md b/docs/parsers/rpm_qi.md index 3d316d03..7e1c5782 100644 --- a/docs/parsers/rpm_qi.md +++ b/docs/parsers/rpm_qi.md @@ -3,7 +3,7 @@ # jc.parsers.rpm\_qi -jc - JSON CLI output utility `rpm -qi` command output parser +jc - JSON Convert `rpm -qi` command output parser Works with `rpm -qi [package]` or `rpm -qia`. @@ -168,7 +168,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/rsync.md b/docs/parsers/rsync.md index 04f8c664..1271c1e7 100644 --- a/docs/parsers/rsync.md +++ b/docs/parsers/rsync.md @@ -3,7 +3,7 @@ # jc.parsers.rsync -jc - JSON CLI output utility `rsync` command output parser +jc - JSON Convert `rsync` command output parser Supports the `-i` or `--itemize-changes` options with all levels of verbosity. This parser will process the STDOUT output or a log file @@ -141,7 +141,7 @@ Examples: -### parse +#### parse ```python def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict] diff --git a/docs/parsers/rsync_s.md b/docs/parsers/rsync_s.md index 27b2c9a7..f42fc855 100644 --- a/docs/parsers/rsync_s.md +++ b/docs/parsers/rsync_s.md @@ -3,7 +3,7 @@ # jc.parsers.rsync\_s -jc - JSON CLI output utility `rsync` command output streaming parser +jc - JSON Convert `rsync` command output streaming parser > This streaming parser outputs JSON Lines @@ -95,11 +95,14 @@ Examples: -### parse +#### parse ```python @add_jc_meta -def parse(data: Iterable[str], raw: bool = False, quiet: bool = False, ignore_exceptions: bool = False) -> Union[Iterable[Dict], tuple] +def parse(data: Iterable[str], + raw: bool = False, + quiet: bool = False, + ignore_exceptions: bool = False) -> Union[Iterable[Dict], tuple] ``` Main text parsing generator function. Returns an iterator object. diff --git a/docs/parsers/sfdisk.md b/docs/parsers/sfdisk.md index eb0d8cde..91ee9862 100644 --- a/docs/parsers/sfdisk.md +++ b/docs/parsers/sfdisk.md @@ -3,7 +3,7 @@ # jc.parsers.sfdisk -jc - JSON CLI output utility `sfdisk` command output parser +jc - JSON Convert `sfdisk` command output parser Supports the following `sfdisk` options: - `-l` @@ -209,7 +209,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/shadow.md b/docs/parsers/shadow.md index b184b650..fae577e2 100644 --- a/docs/parsers/shadow.md +++ b/docs/parsers/shadow.md @@ -3,7 +3,7 @@ # jc.parsers.shadow -jc - JSON CLI output utility `/etc/shadow` file parser +jc - JSON Convert `/etc/shadow` file parser Usage (cli): @@ -108,7 +108,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ss.md b/docs/parsers/ss.md index 17031b5e..bbe984f8 100644 --- a/docs/parsers/ss.md +++ b/docs/parsers/ss.md @@ -3,7 +3,7 @@ # jc.parsers.ss -jc - JSON CLI output utility `ss` command output parser +jc - JSON Convert `ss` command output parser Extended information options like -e and -p are not supported and may cause parsing irregularities. @@ -287,7 +287,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/stat.md b/docs/parsers/stat.md index b5db81dd..c950a568 100644 --- a/docs/parsers/stat.md +++ b/docs/parsers/stat.md @@ -3,7 +3,7 @@ # jc.parsers.stat -jc - JSON CLI output utility `stat` command output parser +jc - JSON Convert `stat` command output parser The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the local time of the system the parser is run on) @@ -177,7 +177,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/stat_s.md b/docs/parsers/stat_s.md index 4a59f84d..1b438ab2 100644 --- a/docs/parsers/stat_s.md +++ b/docs/parsers/stat_s.md @@ -3,7 +3,7 @@ # jc.parsers.stat\_s -jc - JSON CLI output utility `stat` command output streaming parser +jc - JSON Convert `stat` command output streaming parser > This streaming parser outputs JSON Lines @@ -88,7 +88,7 @@ Examples: -### parse +#### parse ```python @add_jc_meta diff --git a/docs/parsers/sysctl.md b/docs/parsers/sysctl.md index 1b77027a..c19ca743 100644 --- a/docs/parsers/sysctl.md +++ b/docs/parsers/sysctl.md @@ -3,7 +3,7 @@ # jc.parsers.sysctl -jc - JSON CLI output utility `sysctl -a` command output parser +jc - JSON Convert `sysctl -a` command output parser Note: Since `sysctl` output is not easily parsable only a very simple key/value object will be output. An attempt is made to convert obvious @@ -64,7 +64,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl.md b/docs/parsers/systemctl.md index 2359a0f4..085ad486 100644 --- a/docs/parsers/systemctl.md +++ b/docs/parsers/systemctl.md @@ -3,7 +3,7 @@ # jc.parsers.systemctl -jc - JSON CLI output utility `systemctl` command output parser +jc - JSON Convert `systemctl` command output parser Usage (cli): @@ -65,7 +65,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_lj.md b/docs/parsers/systemctl_lj.md index 324375d0..007e8261 100644 --- a/docs/parsers/systemctl_lj.md +++ b/docs/parsers/systemctl_lj.md @@ -3,7 +3,7 @@ # jc.parsers.systemctl\_lj -jc - JSON CLI output utility `systemctl list-jobs` command output parser +jc - JSON Convert `systemctl list-jobs` command output parser Usage (cli): @@ -82,7 +82,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_ls.md b/docs/parsers/systemctl_ls.md index caca4b71..f5783a95 100644 --- a/docs/parsers/systemctl_ls.md +++ b/docs/parsers/systemctl_ls.md @@ -3,7 +3,7 @@ # jc.parsers.systemctl\_ls -jc - JSON CLI output utility `systemctl list-sockets` command output +jc - JSON Convert `systemctl list-sockets` command output parser Usage (cli): @@ -58,7 +58,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_luf.md b/docs/parsers/systemctl_luf.md index 9624439e..79a858a2 100644 --- a/docs/parsers/systemctl_luf.md +++ b/docs/parsers/systemctl_luf.md @@ -3,7 +3,7 @@ # jc.parsers.systemctl\_luf -jc - JSON CLI output utility `systemctl list-unit-files` command output +jc - JSON Convert `systemctl list-unit-files` command output parser Usage (cli): @@ -54,7 +54,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systeminfo.md b/docs/parsers/systeminfo.md index bd85b45f..616e23dd 100644 --- a/docs/parsers/systeminfo.md +++ b/docs/parsers/systeminfo.md @@ -3,7 +3,7 @@ # jc.parsers.systeminfo -jc - JSON CLI output utility `systeminfo` command output parser +jc - JSON Convert `systeminfo` command output parser Blank or missing elements are set to `null`. @@ -218,7 +218,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/time.md b/docs/parsers/time.md index 6ade177f..ed79b975 100644 --- a/docs/parsers/time.md +++ b/docs/parsers/time.md @@ -3,7 +3,7 @@ # jc.parsers.time -jc - JSON CLI output utility `/usr/bin/time` command output parser +jc - JSON Convert `/usr/bin/time` command output parser Output from `/usr/bin/time` is sent to `STDERR`, so the `-o` option can be used to redirect the output to a file that can be read by `jc`. @@ -139,7 +139,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/timedatectl.md b/docs/parsers/timedatectl.md index 0e40adbe..94d50ed1 100644 --- a/docs/parsers/timedatectl.md +++ b/docs/parsers/timedatectl.md @@ -3,7 +3,7 @@ # jc.parsers.timedatectl -jc - JSON CLI output utility `timedatectl` command output parser +jc - JSON Convert `timedatectl` command output parser The `epoch_utc` calculated timestamp field is timezone-aware and is only available if the `universal_time` field is available. @@ -71,7 +71,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/tracepath.md b/docs/parsers/tracepath.md index 19636189..73d4f6ef 100644 --- a/docs/parsers/tracepath.md +++ b/docs/parsers/tracepath.md @@ -3,7 +3,7 @@ # jc.parsers.tracepath -jc - JSON CLI output utility `tracepath` command output parser +jc - JSON Convert `tracepath` command output parser Supports `tracepath` and `tracepath6` output. @@ -138,7 +138,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/traceroute.md b/docs/parsers/traceroute.md index 1ab094fb..2a0ff614 100644 --- a/docs/parsers/traceroute.md +++ b/docs/parsers/traceroute.md @@ -3,7 +3,7 @@ # jc.parsers.traceroute -jc - JSON CLI output utility `traceroute` command output parser +jc - JSON Convert `traceroute` command output parser Supports `traceroute` and `traceroute6` output. @@ -127,7 +127,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ufw.md b/docs/parsers/ufw.md index ddc29105..fa26ae84 100644 --- a/docs/parsers/ufw.md +++ b/docs/parsers/ufw.md @@ -3,7 +3,7 @@ # jc.parsers.ufw -jc - JSON CLI output utility `ufw status` command output parser +jc - JSON Convert `ufw status` command output parser Usage (cli): @@ -207,7 +207,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ufw_appinfo.md b/docs/parsers/ufw_appinfo.md index 0ad1eecc..54711331 100644 --- a/docs/parsers/ufw_appinfo.md +++ b/docs/parsers/ufw_appinfo.md @@ -3,7 +3,7 @@ # jc.parsers.ufw\_appinfo -jc - JSON CLI output utility `ufw app info [application]` command +jc - JSON Convert `ufw app info [application]` command output parser Supports individual apps via `ufw app info [application]` and all apps list @@ -145,7 +145,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index 71e67ddc..b4a9329e 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -3,7 +3,7 @@ # jc.parsers.uname -jc - JSON CLI output utility `uname -a` command output parser +jc - JSON Convert `uname -a` command output parser Note: Must use `uname -a` @@ -54,7 +54,7 @@ Example: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/universal.md b/docs/parsers/universal.md index 00dca1d3..ae227a9d 100644 --- a/docs/parsers/universal.md +++ b/docs/parsers/universal.md @@ -8,11 +8,11 @@ # jc.parsers.universal -jc - JSON CLI output utility universal Parsers +jc - JSON Convert universal Parsers -### simple\_table\_parse +#### simple\_table\_parse ```python def simple_table_parse(data: List[str]) -> List[Dict] @@ -37,7 +37,7 @@ Returns: -### sparse\_table\_parse +#### sparse\_table\_parse ```python def sparse_table_parse(data: List[str], delim: str = '\u2063') -> List[Dict] diff --git a/docs/parsers/upower.md b/docs/parsers/upower.md index be0384ad..55a9a4c6 100644 --- a/docs/parsers/upower.md +++ b/docs/parsers/upower.md @@ -3,7 +3,7 @@ # jc.parsers.upower -jc - JSON CLI output utility `upower` command output parser +jc - JSON Convert `upower` command output parser The `updated_epoch` calculated timestamp field is naive. (i.e. based on the local time of the system the parser is run on) @@ -205,7 +205,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/uptime.md b/docs/parsers/uptime.md index 9d5375bd..f63a3d42 100644 --- a/docs/parsers/uptime.md +++ b/docs/parsers/uptime.md @@ -3,7 +3,7 @@ # jc.parsers.uptime -jc - JSON CLI output utility `uptime` command output parser +jc - JSON Convert `uptime` command output parser Usage (cli): @@ -72,7 +72,7 @@ Example: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/vmstat.md b/docs/parsers/vmstat.md index c6e76a38..1690b11e 100644 --- a/docs/parsers/vmstat.md +++ b/docs/parsers/vmstat.md @@ -3,7 +3,7 @@ # jc.parsers.vmstat -jc - JSON CLI output utility `vmstat` command output parser +jc - JSON Convert `vmstat` command output parser Options supported: `-a`, `-w`, `-d`, `-t` @@ -133,7 +133,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index 2445f1b6..8d39e959 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -3,7 +3,7 @@ # jc.parsers.vmstat\_s -jc - JSON CLI output utility `vmstat` command output streaming parser +jc - JSON Convert `vmstat` command output streaming parser > This streaming parser outputs JSON Lines @@ -107,7 +107,7 @@ Examples: -### parse +#### parse ```python @add_jc_meta diff --git a/docs/parsers/w.md b/docs/parsers/w.md index 378fa467..e754b7c8 100644 --- a/docs/parsers/w.md +++ b/docs/parsers/w.md @@ -3,7 +3,7 @@ # jc.parsers.w -jc - JSON CLI output utility `w` command output parser +jc - JSON Convert `w` command output parser Usage (cli): @@ -110,7 +110,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/wc.md b/docs/parsers/wc.md index 49f2f82b..f58d1058 100644 --- a/docs/parsers/wc.md +++ b/docs/parsers/wc.md @@ -3,7 +3,7 @@ # jc.parsers.wc -jc - JSON CLI output utility `wc` command output parser +jc - JSON Convert `wc` command output parser Usage (cli): @@ -61,7 +61,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/who.md b/docs/parsers/who.md index 94953475..7dfdd25e 100644 --- a/docs/parsers/who.md +++ b/docs/parsers/who.md @@ -3,7 +3,7 @@ # jc.parsers.who -jc - JSON CLI output utility `who` command output parser +jc - JSON Convert `who` command output parser Accepts any of the following who options (or no options): `-aTH` @@ -142,7 +142,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/xml.md b/docs/parsers/xml.md index 1dab4203..fa866d76 100644 --- a/docs/parsers/xml.md +++ b/docs/parsers/xml.md @@ -3,7 +3,7 @@ # jc.parsers.xml -jc - JSON CLI output utility `XML` file parser +jc - JSON Convert `XML` file parser Usage (cli): @@ -77,7 +77,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/xrandr.md b/docs/parsers/xrandr.md index eb095eec..d5c05e8f 100644 --- a/docs/parsers/xrandr.md +++ b/docs/parsers/xrandr.md @@ -3,7 +3,7 @@ # jc.parsers.xrandr -jc - JSON CLI output utility `xrandr` command output parser +jc - JSON Convert `xrandr` command output parser Usage (cli): @@ -144,7 +144,7 @@ Examples: -### parse +#### parse ```python def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict diff --git a/docs/parsers/yaml.md b/docs/parsers/yaml.md index 6e4d8cd2..18234a8c 100644 --- a/docs/parsers/yaml.md +++ b/docs/parsers/yaml.md @@ -3,7 +3,7 @@ # jc.parsers.yaml -jc - JSON CLI output utility `YAML` file parser +jc - JSON Convert `YAML` file parser Usage (cli): @@ -91,7 +91,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/zipinfo.md b/docs/parsers/zipinfo.md index eef68a9b..e56ad2f0 100644 --- a/docs/parsers/zipinfo.md +++ b/docs/parsers/zipinfo.md @@ -3,7 +3,7 @@ # jc.parsers.zipinfo -jc - JSON CLI output utility `zipinfo` command output parser +jc - JSON Convert `zipinfo` command output parser Options supported: - none @@ -86,7 +86,7 @@ Examples: -### parse +#### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/readme.md b/docs/readme.md index e5c3d8ec..0f1c71aa 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -2,7 +2,7 @@ # jc -JC - JSON CLI output utility +JC - JSON Convert * kellyjonbrazil@gmail.com diff --git a/docs/streaming.md b/docs/streaming.md index b8971010..f97f9d9f 100644 --- a/docs/streaming.md +++ b/docs/streaming.md @@ -12,11 +12,11 @@ # jc.streaming -jc - JSON CLI output utility streaming utils +jc - JSON Convert streaming utils -### streaming\_input\_type\_check +#### streaming\_input\_type\_check ```python def streaming_input_type_check(data: Iterable) -> None @@ -27,7 +27,7 @@ Ensure input data is an iterable, but not a string or bytes. Raises -### streaming\_line\_input\_type\_check +#### streaming\_line\_input\_type\_check ```python def streaming_line_input_type_check(line: str) -> None @@ -37,7 +37,7 @@ Ensure each line is a string. Raises `TypeError` if not. -### stream\_success +#### stream\_success ```python def stream_success(output_line: Dict, ignore_exceptions: bool) -> Dict @@ -47,7 +47,7 @@ Add `_jc_meta` object to output line if `ignore_exceptions=True` -### stream\_error +#### stream\_error ```python def stream_error(e: BaseException, line: str) -> Dict @@ -57,7 +57,7 @@ Return an error `_jc_meta` field. -### add\_jc\_meta +#### add\_jc\_meta ```python def add_jc_meta(func) @@ -102,10 +102,11 @@ In all cases above: -### raise\_or\_yield +#### raise\_or\_yield ```python -def raise_or_yield(ignore_exceptions: bool, e: BaseException, line: str) -> tuple +def raise_or_yield(ignore_exceptions: bool, e: BaseException, + line: str) -> tuple ``` Return the exception object and line string if ignore_exceptions is diff --git a/docs/utils.md b/docs/utils.md index c8c24180..de72f4f7 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -16,11 +16,11 @@ # jc.utils -jc - JSON CLI output utility utils +jc - JSON Convert utils -### warning\_message +#### warning\_message ```python def warning_message(message_lines: List[str]) -> None @@ -40,7 +40,7 @@ Returns: -### error\_message +#### error\_message ```python def error_message(message_lines: List[str]) -> None @@ -60,10 +60,12 @@ Returns: -### compatibility +#### compatibility ```python -def compatibility(mod_name: str, compatible: List, quiet: bool = False) -> None +def compatibility(mod_name: str, + compatible: List, + quiet: bool = False) -> None ``` Checks for the parser's compatibility with the running OS @@ -85,7 +87,7 @@ Returns: -### has\_data +#### has\_data ```python def has_data(data: str) -> bool @@ -105,7 +107,7 @@ Returns: -### convert\_to\_int +#### convert\_to\_int ```python def convert_to_int(value: Union[str, float]) -> Optional[int] @@ -124,7 +126,7 @@ Returns: -### convert\_to\_float +#### convert\_to\_float ```python def convert_to_float(value: Union[str, int]) -> Optional[float] @@ -143,7 +145,7 @@ Returns: -### convert\_to\_bool +#### convert\_to\_bool ```python def convert_to_bool(value: Union[str, int, float]) -> bool @@ -163,7 +165,7 @@ Returns: -### input\_type\_check +#### input\_type\_check ```python def input_type_check(data: str) -> None @@ -173,7 +175,7 @@ Ensure input data is a string. Raises `TypeError` if not. -### timestamp Objects +## timestamp Objects ```python class timestamp() @@ -181,10 +183,11 @@ class timestamp() -### \_\_init\_\_ +#### \_\_init\_\_ ```python -def __init__(datetime_string: str, format_hint: Union[List, Tuple, None] = None) -> None +def __init__(datetime_string: str, + format_hint: Union[List, Tuple, None] = None) -> None ``` Input a datetime text string of several formats and convert to a diff --git a/jc/__init__.py b/jc/__init__.py index 4d9f44ca..ea5ccc20 100644 --- a/jc/__init__.py +++ b/jc/__init__.py @@ -1,4 +1,4 @@ -"""JC - JSON CLI output utility +"""JC - JSON Convert * kellyjonbrazil@gmail.com diff --git a/jc/cli.py b/jc/cli.py index 6dd1a147..149f5c6b 100644 --- a/jc/cli.py +++ b/jc/cli.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility +"""jc - JSON Convert JC cli module """ @@ -34,7 +34,7 @@ JC_ERROR_EXIT = 100 class info(): version = __version__ - description = 'JSON CLI output utility' + description = 'JSON Convert' author = 'Kelly Brazil' author_email = 'kellyjonbrazil@gmail.com' website = 'https://github.com/kellyjonbrazil/jc' diff --git a/jc/exceptions.py b/jc/exceptions.py index 32218db6..932e728e 100644 --- a/jc/exceptions.py +++ b/jc/exceptions.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility exceptions""" +"""jc - JSON Convert exceptions""" class ParseError(Exception): diff --git a/jc/lib.py b/jc/lib.py index 4252b864..f5d382d1 100644 --- a/jc/lib.py +++ b/jc/lib.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility +"""jc - JSON Convert JC lib module """ diff --git a/jc/parsers/acpi.py b/jc/parsers/acpi.py index 4e9e41fe..46182eed 100644 --- a/jc/parsers/acpi.py +++ b/jc/parsers/acpi.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `acpi` command output parser +"""jc - JSON Convert `acpi` command output parser Usage (cli): diff --git a/jc/parsers/airport.py b/jc/parsers/airport.py index 715510f2..ae1d4291 100644 --- a/jc/parsers/airport.py +++ b/jc/parsers/airport.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `airport -I` command output parser +"""jc - JSON Convert `airport -I` command output parser The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`. diff --git a/jc/parsers/airport_s.py b/jc/parsers/airport_s.py index 5648195c..bf478efa 100644 --- a/jc/parsers/airport_s.py +++ b/jc/parsers/airport_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `airport -s` command output parser +"""jc - JSON Convert `airport -s` command output parser The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`. diff --git a/jc/parsers/arp.py b/jc/parsers/arp.py index 2f4e8a58..53f0c981 100644 --- a/jc/parsers/arp.py +++ b/jc/parsers/arp.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `arp` command output parser +"""jc - JSON Convert `arp` command output parser Supports `arp` and `arp -a` output. diff --git a/jc/parsers/blkid.py b/jc/parsers/blkid.py index ce5df6be..2e94b63f 100644 --- a/jc/parsers/blkid.py +++ b/jc/parsers/blkid.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `blkid` command output parser +"""jc - JSON Convert `blkid` command output parser Usage (cli): diff --git a/jc/parsers/cksum.py b/jc/parsers/cksum.py index 02b812f6..ea50103c 100644 --- a/jc/parsers/cksum.py +++ b/jc/parsers/cksum.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `cksum` command output parser +"""jc - JSON Convert `cksum` command output parser This parser works with the following checksum calculation utilities: - `sum` diff --git a/jc/parsers/crontab.py b/jc/parsers/crontab.py index 1736671e..59c0fe81 100644 --- a/jc/parsers/crontab.py +++ b/jc/parsers/crontab.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `crontab -l` command output and crontab +"""jc - JSON Convert `crontab -l` command output and crontab file parser Supports `crontab -l` command output and crontab files. diff --git a/jc/parsers/crontab_u.py b/jc/parsers/crontab_u.py index 0cd10f88..8ec1f13f 100644 --- a/jc/parsers/crontab_u.py +++ b/jc/parsers/crontab_u.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `crontab -l` command output and crontab +"""jc - JSON Convert `crontab -l` command output and crontab file parser This version of the `crontab -l` parser supports output that contains user diff --git a/jc/parsers/csv.py b/jc/parsers/csv.py index 2910c832..0df902ec 100644 --- a/jc/parsers/csv.py +++ b/jc/parsers/csv.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `csv` file parser +"""jc - JSON Convert `csv` file parser The `csv` parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default to comma. diff --git a/jc/parsers/csv_s.py b/jc/parsers/csv_s.py index e4c573c4..86108659 100644 --- a/jc/parsers/csv_s.py +++ b/jc/parsers/csv_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `csv` file streaming parser +"""jc - JSON Convert `csv` file streaming parser > This streaming parser outputs JSON Lines diff --git a/jc/parsers/date.py b/jc/parsers/date.py index df710f69..313ec444 100644 --- a/jc/parsers/date.py +++ b/jc/parsers/date.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `date` command output parser +"""jc - JSON Convert `date` command output parser The `epoch` calculated timestamp field is naive. (i.e. based on the local time of the system the parser is run on) diff --git a/jc/parsers/df.py b/jc/parsers/df.py index 9b2e857b..cb1edb3e 100644 --- a/jc/parsers/df.py +++ b/jc/parsers/df.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `df` command output parser +"""jc - JSON Convert `df` command output parser Usage (cli): diff --git a/jc/parsers/dig.py b/jc/parsers/dig.py index 0af225b1..d5757b09 100644 --- a/jc/parsers/dig.py +++ b/jc/parsers/dig.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `dig` command output parser +"""jc - JSON Convert `dig` command output parser Options supported: - `+noall +answer` options are supported in cases where only the answer diff --git a/jc/parsers/dir.py b/jc/parsers/dir.py index f9f168b1..a7665628 100644 --- a/jc/parsers/dir.py +++ b/jc/parsers/dir.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `dir` command output parser +"""jc - JSON Convert `dir` command output parser Options supported: - `/T timefield` diff --git a/jc/parsers/dmidecode.py b/jc/parsers/dmidecode.py index f87e06bf..0ec59c03 100644 --- a/jc/parsers/dmidecode.py +++ b/jc/parsers/dmidecode.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `dmidecode` command output parser +"""jc - JSON Convert `dmidecode` command output parser Usage (cli): diff --git a/jc/parsers/dpkg_l.py b/jc/parsers/dpkg_l.py index 260f1433..46f192d0 100644 --- a/jc/parsers/dpkg_l.py +++ b/jc/parsers/dpkg_l.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `dpkg -l` command output parser +"""jc - JSON Convert `dpkg -l` command output parser Set the `COLUMNS` environment variable to a large value to avoid field truncation. For example: diff --git a/jc/parsers/du.py b/jc/parsers/du.py index e91aaee0..c2fa2f0d 100644 --- a/jc/parsers/du.py +++ b/jc/parsers/du.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `du` command output parser +"""jc - JSON Convert `du` command output parser Usage (cli): diff --git a/jc/parsers/env.py b/jc/parsers/env.py index d6155df3..50cfaed4 100644 --- a/jc/parsers/env.py +++ b/jc/parsers/env.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `env` and `printenv` command output parser +"""jc - JSON Convert `env` and `printenv` command output parser This parser will output a list of dictionaries each containing `name` and `value` keys. If you would like a simple dictionary output, then use the diff --git a/jc/parsers/file.py b/jc/parsers/file.py index d0cefe9f..1fbb3c67 100644 --- a/jc/parsers/file.py +++ b/jc/parsers/file.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `file` command output parser +"""jc - JSON Convert `file` command output parser Usage (cli): diff --git a/jc/parsers/finger.py b/jc/parsers/finger.py index d2b45eca..5da95946 100644 --- a/jc/parsers/finger.py +++ b/jc/parsers/finger.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `finger` command output parser +"""jc - JSON Convert `finger` command output parser Supports `-s` output option. Does not support the `-l` detail option. diff --git a/jc/parsers/foo.py b/jc/parsers/foo.py index afd56deb..c3a19357 100644 --- a/jc/parsers/foo.py +++ b/jc/parsers/foo.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `foo` command output parser +"""jc - JSON Convert `foo` command output parser <> diff --git a/jc/parsers/foo_s.py b/jc/parsers/foo_s.py index eadfc202..1113202d 100644 --- a/jc/parsers/foo_s.py +++ b/jc/parsers/foo_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `foo` command output streaming parser +"""jc - JSON Convert `foo` command output streaming parser > This streaming parser outputs JSON Lines diff --git a/jc/parsers/free.py b/jc/parsers/free.py index a7af04d5..21a4dc45 100644 --- a/jc/parsers/free.py +++ b/jc/parsers/free.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `free` command output parser +"""jc - JSON Convert `free` command output parser Usage (cli): diff --git a/jc/parsers/fstab.py b/jc/parsers/fstab.py index 6d2689da..3608253b 100644 --- a/jc/parsers/fstab.py +++ b/jc/parsers/fstab.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `fstab` file parser +"""jc - JSON Convert `fstab` file parser Usage (cli): diff --git a/jc/parsers/group.py b/jc/parsers/group.py index bf9bef87..7818ada2 100644 --- a/jc/parsers/group.py +++ b/jc/parsers/group.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `/etc/group` file parser +"""jc - JSON Convert `/etc/group` file parser Usage (cli): diff --git a/jc/parsers/gshadow.py b/jc/parsers/gshadow.py index d5df2b3b..581c1e26 100644 --- a/jc/parsers/gshadow.py +++ b/jc/parsers/gshadow.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `/etc/gshadow` file parser +"""jc - JSON Convert `/etc/gshadow` file parser Usage (cli): diff --git a/jc/parsers/hash.py b/jc/parsers/hash.py index 1efa91c6..b5f87c4c 100644 --- a/jc/parsers/hash.py +++ b/jc/parsers/hash.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `hash` command output parser +"""jc - JSON Convert `hash` command output parser Usage (cli): diff --git a/jc/parsers/hashsum.py b/jc/parsers/hashsum.py index 3f3356eb..0d963ca7 100644 --- a/jc/parsers/hashsum.py +++ b/jc/parsers/hashsum.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `hash sum` command output parser +"""jc - JSON Convert `hash sum` command output parser This parser works with the following hash calculation utilities: - `md5` diff --git a/jc/parsers/hciconfig.py b/jc/parsers/hciconfig.py index 9aff32f9..5e9551bb 100644 --- a/jc/parsers/hciconfig.py +++ b/jc/parsers/hciconfig.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `hciconfig` command output parser +"""jc - JSON Convert `hciconfig` command output parser Usage (cli): diff --git a/jc/parsers/history.py b/jc/parsers/history.py index 2ed864a6..9ee422ff 100644 --- a/jc/parsers/history.py +++ b/jc/parsers/history.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `history` command output parser +"""jc - JSON Convert `history` command output parser This parser will output a list of dictionaries each containing `line` and `command` keys. If you would like a simple dictionary output, then use the diff --git a/jc/parsers/hosts.py b/jc/parsers/hosts.py index 6f9a5071..e6f8d679 100644 --- a/jc/parsers/hosts.py +++ b/jc/parsers/hosts.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `/etc/hosts` file parser +"""jc - JSON Convert `/etc/hosts` file parser Usage (cli): diff --git a/jc/parsers/id.py b/jc/parsers/id.py index 3e14d467..046a28f9 100644 --- a/jc/parsers/id.py +++ b/jc/parsers/id.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `id` command output parser +"""jc - JSON Convert `id` command output parser Usage (cli): diff --git a/jc/parsers/ifconfig.py b/jc/parsers/ifconfig.py index 8367671f..3c6abc88 100644 --- a/jc/parsers/ifconfig.py +++ b/jc/parsers/ifconfig.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ifconfig` command output parser +"""jc - JSON Convert `ifconfig` command output parser Note: No `ifconfig` options are supported. diff --git a/jc/parsers/ini.py b/jc/parsers/ini.py index 23a9d15a..192e3292 100644 --- a/jc/parsers/ini.py +++ b/jc/parsers/ini.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `INI` file parser +"""jc - JSON Convert `INI` file parser Parses standard `INI` files and files containing simple key/value pairs. Delimiter can be `=` or `:`. Missing values are supported. Comment prefix diff --git a/jc/parsers/iostat.py b/jc/parsers/iostat.py index 6eaf3ca6..59a43a6d 100644 --- a/jc/parsers/iostat.py +++ b/jc/parsers/iostat.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `iostat` command output parser +"""jc - JSON Convert `iostat` command output parser Note: `iostat` version 11 and higher include a JSON output option diff --git a/jc/parsers/iostat_s.py b/jc/parsers/iostat_s.py index d98f58bc..980e7908 100644 --- a/jc/parsers/iostat_s.py +++ b/jc/parsers/iostat_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `iostat` command output streaming parser +"""jc - JSON Convert `iostat` command output streaming parser > This streaming parser outputs JSON Lines diff --git a/jc/parsers/iptables.py b/jc/parsers/iptables.py index a0e755b9..b7de3886 100644 --- a/jc/parsers/iptables.py +++ b/jc/parsers/iptables.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `iptables` command output parser +"""jc - JSON Convert `iptables` command output parser Supports `-vLn` and `--line-numbers` for all tables. diff --git a/jc/parsers/iw_scan.py b/jc/parsers/iw_scan.py index 3c984719..883c3c76 100644 --- a/jc/parsers/iw_scan.py +++ b/jc/parsers/iw_scan.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `iw dev scan` command output parser +"""jc - JSON Convert `iw dev scan` command output parser This parser is considered beta quality. Not all fields are parsed and there are not enough samples to test. diff --git a/jc/parsers/jar_manifest.py b/jc/parsers/jar_manifest.py index e9afa424..3a68b9cc 100644 --- a/jc/parsers/jar_manifest.py +++ b/jc/parsers/jar_manifest.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `MANIFEST.MF` file parser +"""jc - JSON Convert `MANIFEST.MF` file parser Usage (cli): diff --git a/jc/parsers/jobs.py b/jc/parsers/jobs.py index cd7fd10b..b10ae7ae 100644 --- a/jc/parsers/jobs.py +++ b/jc/parsers/jobs.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `jobs` command output parser +"""jc - JSON Convert `jobs` command output parser Also supports the `-l` option. diff --git a/jc/parsers/kv.py b/jc/parsers/kv.py index a179bff4..db2d1544 100644 --- a/jc/parsers/kv.py +++ b/jc/parsers/kv.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `Key/Value` file parser +"""jc - JSON Convert `Key/Value` file parser Supports files containing simple key/value pairs. Delimiter can be `=` or `:`. Missing values are supported. Comment prefix can be `#` or `;`. diff --git a/jc/parsers/last.py b/jc/parsers/last.py index ba6c7d16..2598e37c 100644 --- a/jc/parsers/last.py +++ b/jc/parsers/last.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `last` and `lastb` command output parser +"""jc - JSON Convert `last` and `lastb` command output parser Supports `-w` and `-F` options. diff --git a/jc/parsers/ls.py b/jc/parsers/ls.py index fba2c2a4..226060de 100644 --- a/jc/parsers/ls.py +++ b/jc/parsers/ls.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ls` and `vdir` command output parser +"""jc - JSON Convert `ls` and `vdir` command output parser Options supported: - `lbaR1` diff --git a/jc/parsers/ls_s.py b/jc/parsers/ls_s.py index 0ca3261c..f59c1bd6 100644 --- a/jc/parsers/ls_s.py +++ b/jc/parsers/ls_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ls` and `vdir` command output streaming +"""jc - JSON Convert `ls` and `vdir` command output streaming parser > This streaming parser outputs JSON Lines diff --git a/jc/parsers/lsblk.py b/jc/parsers/lsblk.py index 45ddd844..4ee44d69 100644 --- a/jc/parsers/lsblk.py +++ b/jc/parsers/lsblk.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `lsblk` command output parser +"""jc - JSON Convert `lsblk` command output parser Usage (cli): diff --git a/jc/parsers/lsmod.py b/jc/parsers/lsmod.py index 26720e17..1342d5cd 100644 --- a/jc/parsers/lsmod.py +++ b/jc/parsers/lsmod.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `lsmod` command output parser +"""jc - JSON Convert `lsmod` command output parser Usage (cli): diff --git a/jc/parsers/lsof.py b/jc/parsers/lsof.py index 89c962d5..08804dd0 100644 --- a/jc/parsers/lsof.py +++ b/jc/parsers/lsof.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `lsof` command output parser +"""jc - JSON Convert `lsof` command output parser Usage (cli): diff --git a/jc/parsers/lsusb.py b/jc/parsers/lsusb.py index 87d2cc55..4650d60d 100644 --- a/jc/parsers/lsusb.py +++ b/jc/parsers/lsusb.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `lsusb` command output parser +"""jc - JSON Convert `lsusb` command output parser Supports the `-v` option or no options. diff --git a/jc/parsers/mount.py b/jc/parsers/mount.py index 25c7c48f..6b7fc095 100644 --- a/jc/parsers/mount.py +++ b/jc/parsers/mount.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `mount` command output parser +"""jc - JSON Convert `mount` command output parser Usage (cli): diff --git a/jc/parsers/netstat.py b/jc/parsers/netstat.py index e3e9d3b5..f417c241 100644 --- a/jc/parsers/netstat.py +++ b/jc/parsers/netstat.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `netstat` command output parser +"""jc - JSON Convert `netstat` command output parser Caveats: - Use of multiple `l` options is not supported on OSX (e.g. `netstat -rlll`) diff --git a/jc/parsers/netstat_freebsd_osx.py b/jc/parsers/netstat_freebsd_osx.py index e593ad36..eb610ea8 100644 --- a/jc/parsers/netstat_freebsd_osx.py +++ b/jc/parsers/netstat_freebsd_osx.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility FreeBSD and OSX netstat Parser""" +"""jc - JSON Convert FreeBSD and OSX netstat Parser""" def normalize_headers(header): diff --git a/jc/parsers/netstat_linux.py b/jc/parsers/netstat_linux.py index ccafef9d..c43a61af 100644 --- a/jc/parsers/netstat_linux.py +++ b/jc/parsers/netstat_linux.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility Linux netstat Parser""" +"""jc - JSON Convert Linux netstat Parser""" import string diff --git a/jc/parsers/nmcli.py b/jc/parsers/nmcli.py index d71575a4..e89516cd 100644 --- a/jc/parsers/nmcli.py +++ b/jc/parsers/nmcli.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `nmcli` command output parser +"""jc - JSON Convert `nmcli` command output parser Supports the following `nmcli` subcommands: - `nmcli general` diff --git a/jc/parsers/ntpq.py b/jc/parsers/ntpq.py index f4eb7468..e8e474a6 100644 --- a/jc/parsers/ntpq.py +++ b/jc/parsers/ntpq.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ntpq -p` command output parser +"""jc - JSON Convert `ntpq -p` command output parser Usage (cli): diff --git a/jc/parsers/passwd.py b/jc/parsers/passwd.py index 9be3b867..6281fc5d 100644 --- a/jc/parsers/passwd.py +++ b/jc/parsers/passwd.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `/etc/passwd` file Parser +"""jc - JSON Convert `/etc/passwd` file Parser Usage (cli): diff --git a/jc/parsers/ping.py b/jc/parsers/ping.py index 70e05465..0758045b 100644 --- a/jc/parsers/ping.py +++ b/jc/parsers/ping.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ping` command output parser +"""jc - JSON Convert `ping` command output parser Supports `ping` and `ping6` output. diff --git a/jc/parsers/ping_s.py b/jc/parsers/ping_s.py index ab80d11b..34ce7369 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ping` command output streaming parser +"""jc - JSON Convert `ping` command output streaming parser > This streaming parser outputs JSON Lines diff --git a/jc/parsers/pip_list.py b/jc/parsers/pip_list.py index a429d468..00f5d310 100644 --- a/jc/parsers/pip_list.py +++ b/jc/parsers/pip_list.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `pip-list` command output parser +"""jc - JSON Convert `pip-list` command output parser Usage (cli): diff --git a/jc/parsers/pip_show.py b/jc/parsers/pip_show.py index 38142d6c..f465c26a 100644 --- a/jc/parsers/pip_show.py +++ b/jc/parsers/pip_show.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `pip-show` command output parser +"""jc - JSON Convert `pip-show` command output parser Usage (cli): diff --git a/jc/parsers/ps.py b/jc/parsers/ps.py index 99a68c6d..06e7c7fa 100644 --- a/jc/parsers/ps.py +++ b/jc/parsers/ps.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ps` command output parser +"""jc - JSON Convert `ps` command output parser `ps` options supported: - `ef` diff --git a/jc/parsers/route.py b/jc/parsers/route.py index 3a5178bc..7eb07872 100644 --- a/jc/parsers/route.py +++ b/jc/parsers/route.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `route` command output parser +"""jc - JSON Convert `route` command output parser Usage (cli): diff --git a/jc/parsers/rpm_qi.py b/jc/parsers/rpm_qi.py index 2a6a81dd..52e42d74 100644 --- a/jc/parsers/rpm_qi.py +++ b/jc/parsers/rpm_qi.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `rpm -qi` command output parser +"""jc - JSON Convert `rpm -qi` command output parser Works with `rpm -qi [package]` or `rpm -qia`. diff --git a/jc/parsers/rsync.py b/jc/parsers/rsync.py index 8b56761a..eadfa495 100644 --- a/jc/parsers/rsync.py +++ b/jc/parsers/rsync.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `rsync` command output parser +"""jc - JSON Convert `rsync` command output parser Supports the `-i` or `--itemize-changes` options with all levels of verbosity. This parser will process the STDOUT output or a log file diff --git a/jc/parsers/rsync_s.py b/jc/parsers/rsync_s.py index 6a73c2ba..94b874e3 100644 --- a/jc/parsers/rsync_s.py +++ b/jc/parsers/rsync_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `rsync` command output streaming parser +"""jc - JSON Convert `rsync` command output streaming parser > This streaming parser outputs JSON Lines diff --git a/jc/parsers/sfdisk.py b/jc/parsers/sfdisk.py index d5f4ac88..9900b60b 100644 --- a/jc/parsers/sfdisk.py +++ b/jc/parsers/sfdisk.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `sfdisk` command output parser +"""jc - JSON Convert `sfdisk` command output parser Supports the following `sfdisk` options: - `-l` diff --git a/jc/parsers/shadow.py b/jc/parsers/shadow.py index 00427a37..ad1ae570 100644 --- a/jc/parsers/shadow.py +++ b/jc/parsers/shadow.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `/etc/shadow` file parser +"""jc - JSON Convert `/etc/shadow` file parser Usage (cli): diff --git a/jc/parsers/ss.py b/jc/parsers/ss.py index 0416f097..10bd69dc 100644 --- a/jc/parsers/ss.py +++ b/jc/parsers/ss.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ss` command output parser +"""jc - JSON Convert `ss` command output parser Extended information options like -e and -p are not supported and may cause parsing irregularities. diff --git a/jc/parsers/stat.py b/jc/parsers/stat.py index af6bbd33..ca58789d 100644 --- a/jc/parsers/stat.py +++ b/jc/parsers/stat.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `stat` command output parser +"""jc - JSON Convert `stat` command output parser The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the local time of the system the parser is run on) diff --git a/jc/parsers/stat_s.py b/jc/parsers/stat_s.py index e58759b8..3b302e38 100644 --- a/jc/parsers/stat_s.py +++ b/jc/parsers/stat_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `stat` command output streaming parser +"""jc - JSON Convert `stat` command output streaming parser > This streaming parser outputs JSON Lines diff --git a/jc/parsers/sysctl.py b/jc/parsers/sysctl.py index 388c0fb9..022546b1 100644 --- a/jc/parsers/sysctl.py +++ b/jc/parsers/sysctl.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `sysctl -a` command output parser +"""jc - JSON Convert `sysctl -a` command output parser Note: Since `sysctl` output is not easily parsable only a very simple key/value object will be output. An attempt is made to convert obvious diff --git a/jc/parsers/systemctl.py b/jc/parsers/systemctl.py index 58cbe8d0..47136e15 100644 --- a/jc/parsers/systemctl.py +++ b/jc/parsers/systemctl.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `systemctl` command output parser +"""jc - JSON Convert `systemctl` command output parser Usage (cli): diff --git a/jc/parsers/systemctl_lj.py b/jc/parsers/systemctl_lj.py index f078b20b..a6ccd5fd 100644 --- a/jc/parsers/systemctl_lj.py +++ b/jc/parsers/systemctl_lj.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `systemctl list-jobs` command output parser +"""jc - JSON Convert `systemctl list-jobs` command output parser Usage (cli): diff --git a/jc/parsers/systemctl_ls.py b/jc/parsers/systemctl_ls.py index 0b7302c9..670986d5 100644 --- a/jc/parsers/systemctl_ls.py +++ b/jc/parsers/systemctl_ls.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `systemctl list-sockets` command output +"""jc - JSON Convert `systemctl list-sockets` command output parser Usage (cli): diff --git a/jc/parsers/systemctl_luf.py b/jc/parsers/systemctl_luf.py index 9eb91035..8fd540e8 100644 --- a/jc/parsers/systemctl_luf.py +++ b/jc/parsers/systemctl_luf.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `systemctl list-unit-files` command output +"""jc - JSON Convert `systemctl list-unit-files` command output parser Usage (cli): diff --git a/jc/parsers/systeminfo.py b/jc/parsers/systeminfo.py index dfcd1ba8..85222662 100644 --- a/jc/parsers/systeminfo.py +++ b/jc/parsers/systeminfo.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `systeminfo` command output parser +"""jc - JSON Convert `systeminfo` command output parser Blank or missing elements are set to `null`. diff --git a/jc/parsers/time.py b/jc/parsers/time.py index c09b5c45..74b9ce56 100644 --- a/jc/parsers/time.py +++ b/jc/parsers/time.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `/usr/bin/time` command output parser +"""jc - JSON Convert `/usr/bin/time` command output parser Output from `/usr/bin/time` is sent to `STDERR`, so the `-o` option can be used to redirect the output to a file that can be read by `jc`. diff --git a/jc/parsers/timedatectl.py b/jc/parsers/timedatectl.py index 5a5d670a..e4957c69 100644 --- a/jc/parsers/timedatectl.py +++ b/jc/parsers/timedatectl.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `timedatectl` command output parser +"""jc - JSON Convert `timedatectl` command output parser The `epoch_utc` calculated timestamp field is timezone-aware and is only available if the `universal_time` field is available. diff --git a/jc/parsers/tracepath.py b/jc/parsers/tracepath.py index 5a4458ed..2e0396a0 100644 --- a/jc/parsers/tracepath.py +++ b/jc/parsers/tracepath.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `tracepath` command output parser +"""jc - JSON Convert `tracepath` command output parser Supports `tracepath` and `tracepath6` output. diff --git a/jc/parsers/traceroute.py b/jc/parsers/traceroute.py index 5df5e70a..aa11b5a1 100644 --- a/jc/parsers/traceroute.py +++ b/jc/parsers/traceroute.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `traceroute` command output parser +"""jc - JSON Convert `traceroute` command output parser Supports `traceroute` and `traceroute6` output. diff --git a/jc/parsers/ufw.py b/jc/parsers/ufw.py index 58bedd57..cb0a8f39 100644 --- a/jc/parsers/ufw.py +++ b/jc/parsers/ufw.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ufw status` command output parser +"""jc - JSON Convert `ufw status` command output parser Usage (cli): diff --git a/jc/parsers/ufw_appinfo.py b/jc/parsers/ufw_appinfo.py index ec3e78ef..04524653 100644 --- a/jc/parsers/ufw_appinfo.py +++ b/jc/parsers/ufw_appinfo.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `ufw app info [application]` command +"""jc - JSON Convert `ufw app info [application]` command output parser Supports individual apps via `ufw app info [application]` and all apps list diff --git a/jc/parsers/uname.py b/jc/parsers/uname.py index 3f8538a6..7260803f 100644 --- a/jc/parsers/uname.py +++ b/jc/parsers/uname.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `uname -a` command output parser +"""jc - JSON Convert `uname -a` command output parser Note: Must use `uname -a` diff --git a/jc/parsers/universal.py b/jc/parsers/universal.py index b1de1ca4..289af3b9 100644 --- a/jc/parsers/universal.py +++ b/jc/parsers/universal.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility universal Parsers""" +"""jc - JSON Convert universal Parsers""" import string diff --git a/jc/parsers/upower.py b/jc/parsers/upower.py index b6508231..7dd511a3 100644 --- a/jc/parsers/upower.py +++ b/jc/parsers/upower.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `upower` command output parser +"""jc - JSON Convert `upower` command output parser The `updated_epoch` calculated timestamp field is naive. (i.e. based on the local time of the system the parser is run on) diff --git a/jc/parsers/uptime.py b/jc/parsers/uptime.py index 9b433dcc..486f8799 100644 --- a/jc/parsers/uptime.py +++ b/jc/parsers/uptime.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `uptime` command output parser +"""jc - JSON Convert `uptime` command output parser Usage (cli): diff --git a/jc/parsers/vmstat.py b/jc/parsers/vmstat.py index f39a5b71..8b31acdd 100644 --- a/jc/parsers/vmstat.py +++ b/jc/parsers/vmstat.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `vmstat` command output parser +"""jc - JSON Convert `vmstat` command output parser Options supported: `-a`, `-w`, `-d`, `-t` diff --git a/jc/parsers/vmstat_s.py b/jc/parsers/vmstat_s.py index 3a0d0921..5e2899ea 100644 --- a/jc/parsers/vmstat_s.py +++ b/jc/parsers/vmstat_s.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `vmstat` command output streaming parser +"""jc - JSON Convert `vmstat` command output streaming parser > This streaming parser outputs JSON Lines diff --git a/jc/parsers/w.py b/jc/parsers/w.py index 386bd066..7ce640c8 100644 --- a/jc/parsers/w.py +++ b/jc/parsers/w.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `w` command output parser +"""jc - JSON Convert `w` command output parser Usage (cli): diff --git a/jc/parsers/wc.py b/jc/parsers/wc.py index ce10b46e..eb1def49 100644 --- a/jc/parsers/wc.py +++ b/jc/parsers/wc.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `wc` command output parser +"""jc - JSON Convert `wc` command output parser Usage (cli): diff --git a/jc/parsers/who.py b/jc/parsers/who.py index c66d4003..c3655bfc 100644 --- a/jc/parsers/who.py +++ b/jc/parsers/who.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `who` command output parser +"""jc - JSON Convert `who` command output parser Accepts any of the following who options (or no options): `-aTH` diff --git a/jc/parsers/xml.py b/jc/parsers/xml.py index 3100f586..9eda8d53 100644 --- a/jc/parsers/xml.py +++ b/jc/parsers/xml.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `XML` file parser +"""jc - JSON Convert `XML` file parser Usage (cli): diff --git a/jc/parsers/xrandr.py b/jc/parsers/xrandr.py index 871f2fcc..c2f5ed66 100644 --- a/jc/parsers/xrandr.py +++ b/jc/parsers/xrandr.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `xrandr` command output parser +"""jc - JSON Convert `xrandr` command output parser Usage (cli): diff --git a/jc/parsers/yaml.py b/jc/parsers/yaml.py index f8c085cd..a8e815fd 100644 --- a/jc/parsers/yaml.py +++ b/jc/parsers/yaml.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `YAML` file parser +"""jc - JSON Convert `YAML` file parser Usage (cli): diff --git a/jc/parsers/zipinfo.py b/jc/parsers/zipinfo.py index 8d706dc3..d06ae365 100644 --- a/jc/parsers/zipinfo.py +++ b/jc/parsers/zipinfo.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility `zipinfo` command output parser +"""jc - JSON Convert `zipinfo` command output parser Options supported: - none diff --git a/jc/streaming.py b/jc/streaming.py index 0e6dbc80..208e0687 100644 --- a/jc/streaming.py +++ b/jc/streaming.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility streaming utils""" +"""jc - JSON Convert streaming utils""" from functools import wraps from typing import Dict, Iterable diff --git a/jc/utils.py b/jc/utils.py index e30fe519..678f824a 100644 --- a/jc/utils.py +++ b/jc/utils.py @@ -1,4 +1,4 @@ -"""jc - JSON CLI output utility utils""" +"""jc - JSON Convert utils""" import sys import re import locale diff --git a/man/jc.1 b/man/jc.1 index 2f99e9fb..e299572e 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2022-02-28 1.18.4 "JSON CLI output utility" +.TH jc 1 2022-03-04 1.18.4 "JSON Convert" .SH NAME jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS diff --git a/templates/manpage_template b/templates/manpage_template index 38fc17fb..fe1bc4fc 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -1,4 +1,4 @@ -.TH jc 1 {{ today }} {{ jc.version}} "JSON CLI output utility" +.TH jc 1 {{ today }} {{ jc.version}} "JSON Convert" .SH NAME jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS diff --git a/templates/readme_template b/templates/readme_template index d7873222..c71c3015 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -1,8 +1,6 @@ ![Tests](https://github.com/kellyjonbrazil/jc/workflows/Tests/badge.svg?branch=master) ![Pypi](https://img.shields.io/pypi/v/jc.svg) -> `jc` was recently featured in the [Console Open Source Newsletter](https://console.substack.com/p/console-89) - > Check out the `jc` Python [package documentation](https://github.com/kellyjonbrazil/jc/tree/master/docs) for developers > Try the `jc` [web demo](https://jc-web-demo.herokuapp.com/) @@ -13,7 +11,7 @@ Ansible filter plugin in the `community.general` collection. See this for an example. # JC -JSON CLI output utility +JSON Convert `jc` JSONifies the output of many CLI tools and file-types for easier parsing in scripts. See the [**Parsers**](#parsers) section for supported commands and