Merge pull request #319 from kellyjonbrazil/dev

Dev v1.22.2

.github/workflows/pythonapp.yml

@@ -14,12 +14,18 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        python-version: [3.6, 3.7, 3.8]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
+    - name: "Set up timezone to America/Los_Angeles"
+      uses: szenius/set-timezone@v1.0
+      with:
+        timezoneLinux: "America/Los_Angeles"
+        timezoneMacos: "America/Los_Angeles"
+        timezoneWindows: "Pacific Standard Time"
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.gitignore

@@ -3,5 +3,6 @@ __pycache__
 dist/
 build/
 *.egg-info/
-jc/parsers.old/
 .github/
+.vscode/
+_config.yml

CHANGELOG

@@ -0,0 +1,676 @@
+jc changelog
+
+20221107 v1.22.2
+- add `sshd_conf` parser for `sshd` configuration files and `sshd -T` output
+- add `findmnt` command parser
+- add `git ls-remote` command parser
+- add `os-prober` command parser
+- add SemVer string parser
+- enhance the `ifconfig` parser so it can output multiple IPv4 and IPv6 addresses
+- enhance the `ifconfig` parser so it can output additional fields common on BSD
+- enhance `xml` parser with optional `_` prefix for attributes instead of
+  `@` by using the `--raw` option. This can make it easier to filter the
+  JSON output in some tools.
+- fix the `xml` parser to output a normal Dictionary instead of OrderdDict.
+  This cleans up YAML output. (No `!!omap` comments)
+- fix `csv` and `csv-s` parsers for UTF-8 encoded CSV files with leading BOM bytes
+- fix exit code to be non-zero on interrupt
+- allow parser module objects to be used as arguments to `jc.get_help()` and `jc.parser_info()`
+- catch unexpected exceptions in the CLI
+- add error message on interrupt to STDERR
+- add python 3.11 tests to github actions
+
+20221024 v1.22.1
+- add `udevadm` command parser
+- add `lspci` command parser
+- add `pci.ids` file parser
+- fix `proc-pid-stat` parser for command names with spaces and newlines
+- enhance `ip-address` parser to add `ip_split` field
+- rename `iso-datetime` parser to `datetime-iso`. A deprecation warning will
+  display until `iso-datetime` is removed in a future version.
+- refactor cli module
+- optimize performance of calculated timestamps
+- add more type annotations
+- add support for deprecating parsers
+- move jc-web demo site from heroku to render.com
+
+20220926 v1.22.0
+- Add /proc file parsers for linux. Support for the following files:
+  `/proc/buddyinfo`
+  `/proc/consoles`
+  `/proc/cpuinfo`
+  `/proc/crypto`
+  `/proc/devices`
+  `/proc/diskstats`
+  `/proc/filesystems`
+  `/proc/interrupts`
+  `/proc/iomem`
+  `/proc/ioports`
+  `/proc/loadavg`
+  `/proc/locks`
+  `/proc/meminfo`
+  `/proc/modules`
+  `/proc/mtrr`
+  `/proc/pagetypeinfo`
+  `/proc/partitions`
+  `/proc/slabinfo`
+  `/proc/softirqs`
+  `/proc/stat`
+  `/proc/swaps`
+  `/proc/uptime`
+  `/proc/version`
+  `/proc/vmallocinfo`
+  `/proc/vmstat`
+  `/proc/zoneinfo`
+  `/proc/driver/rtc`
+  `/proc/net/arp`
+  `/proc/net/dev`
+  `/proc/net/dev_mcast`
+  `/proc/net/if_inet6`
+  `/proc/net/igmp`
+  `/proc/net/igmp6`
+  `/proc/net/ipv6_route`
+  `/proc/net/netlink`
+  `/proc/net/netstat`
+  `/proc/net/packet`
+  `/proc/net/protocols`
+  `/proc/net/route`
+  `/proc/net/unix`
+  `/proc/<pid>/fdinfo/<fd>`
+  `/proc/<pid>/io`
+  `/proc/<pid>/maps`
+  `/proc/<pid>/mountinfo`
+  `/proc/<pid>/numa_maps`
+  `/proc/<pid>/smaps`
+  `/proc/<pid>/stat`
+  `/proc/<pid>/statm`
+  `/proc/<pid>/status`
+- Magic syntax support for `/proc` files
+- Enhance bash and zsh autocompletions for `/proc` files
+- Enhance `free` parser to support `-w` option integer conversions
+- Fix `ini` and `kv` parsers so they don't change keynames to lower case
+  NOTE: This can be a breaking change in your scripts
+- Fix `id` command parser to allow usernames and groupnames with spaces
+- Enhance metadata output to output metadata even when results are empty
+- Optimize tests
+- Optimize documentation build script
+
+20220829 v1.21.2
+- Fix IP Address string parser for older python versions that don't cleanly
+  accept decimal input format - IPv6 fix (e.g. python 3.6)
+
+20220828 v1.21.1
+- Fix IP Address string parser for older python versions that don't cleanly
+  accept decimal input format - IPv4 fix (e.g. python 3.6)
+- Fix `arp -a` parser for cases where incomplete hardware addresses are found
+  in the arp table on linux
+
+20220821 v1.21.0
+- Add IP Address string parser
+- Add Syslog standard and streaming string parsers (RFC 3164 and RFC 5424)
+- Add CEF standard and streaming string parser
+- Add PLIST file parser (XML and binary support)
+- Add `-n` support to the `traceroute` parser
+- Add `mdadm` command parser tested on linux
+- Add `--meta-out` or `-M` option to add metadata to the JSON output, including
+  a UTC timestamp, parser name, magic command, and magic command exit code
+- Fix `lsusb` command parser for output containing a `Device Qualifier` and
+  `Binary Object Store Descriptor` sections
+- Change `LANG=C` to `LC_ALL=C` in locale instructions
+- Add `__main__.py` to package allowing `python -m jc` usage
+- Add an enclosing top-level folder inside the windows.zip package
+
+20220723 v1.20.4
+- Fix URL string parser path list for URLs ending in a forward slash
+
+20220723 v1.20.3
+- Add URL string parser
+- Add Email Address string parser
+- Add JWT string parser
+- Add ISO 8601 Datetime string parser
+- Add UNIX Epoch Timestamp string parser
+- Add M3U/M3U8 file parser
+- Add pager functionality to help (parser documentation only)
+- Minor parser performance optimizations
+
+20220705 v1.20.2
+- Add `gpg --with-colons` parser tested on linux
+- Add DER and PEM encoded X.509 Certificate parser
+- Add Bash and Zsh completion scripts to DEB and RPM packages
+
+20220615 v1.20.1
+- Add `postconf -M` parser tested on linux
+- Update `asciitable` and `asciitable-m` parsers to preserve case in key
+  names when using the `-r` or `raw=True` options.
+- Add long options (e.g. `--help`, `--about`, `--pretty`, etc.)
+- Add shell completions for Bash and Zsh
+- Fix `id` parser for cases where the user or group name is not present
+
+20220531 v1.20.0
+- Add YAML output option with `-y`
+- Add `top -b` standard and streaming parsers tested on linux
+- Add `plugin_parser_count`, `standard_parser_count`, and `streaming_parser_count`
+  keys to `jc -a` output
+- Add `is_compatible` function to the `utils` module
+- Fix `pip-show` parser for packages with a multi-line license field
+- Fix ASCII Table parser for cases where centered headers cause mis-aligned fields
+
+20220513 v1.19.0
+- Add `chage --list` command parser tested on linux
+- Add `git log` command streaming parser
+- Fix `git log` standard parser for corner-cases where hash values are in messages
+- Fix `df` command parser for rare instances when a newline is found at the end
+- Allow jc to pip install on unsupported python version 3.6
+- Fix `asciitable-m` parser to skip some rows that contain column separator
+  characters in cell data. A warning message will be printed to STDERR
+  unless `-q` or `quiet=True` is used.
+
+20220427 v1.18.8
+- Fix `update-alternatives --query` parser for cases where `slaves` are not present
+- Fix UnicodeEncodeError on some systems where LANG=C is set and unicode
+  characters are in the output
+- Update `history` parser: do not drop non-ASCII characters if the system
+  is configured for UTF-8 encoding
+- Enhance "magic syntax" to always use UTF-8 encoding
+
+20220425 v1.18.7
+- Add `git log` command parser
+- Add `update-alternatives --query` parser
+- Add `update-alternatives --get-selections` parser
+- Fix key/value and ini parsers to allow duplicate keys
+- Fix yaml file parser for files including timestamp objects
+- Update `xrandr` parser: add a 'rotation' field
+- Fix failing tests by moving template files
+- Add python interpreter version and path to -v and -a output
+
+20220325 v1.18.6
+- Add `pidstat` command parser tested on linux
+- Add `pidstat` command streaming parser tested on linux
+- Add `mpstat` command parser tested on linux
+- Add `mpstat` command streaming parser tested on linux
+- Add single-line ASCII and Unicode table parser
+- Add multi-line ASCII and Unicode table parser
+- Add documentation option to `parser_info()` and `all_parser_info()`
+
+20220305 v1.18.5
+- Fix date parser to ensure AM/PM period string is always uppercase
+
+20220304 v1.18.4
+- Add nmcli command parser tested on linux
+- Enhance parse error messages at the cli
+- Add standard and streaming parser list functions to the public API
+- Enhance python developer documentation formatting
+
+20220214 v1.18.3
+- Add rsync command and log file parser tested on linux and macOS
+- Add rsync command and log file streaming parser tested on linux and macOS
+- Add xrandr command parser tested on linux
+- Enhance timestamp performance with caching and format hints
+- Refactor ignore_exceptions functionality in streaming parsers
+- Fix man page in packages
+
+20220127 v1.18.2
+- Fix for plugin parsers with underscores in the name
+- Add type hints to public API functions
+- Add plugin attribute to plugin parser metadata
+- Add C locale hint to parsing error messages
+- Refactor more cli code into lib
+
+20220121 v1.18.1
+- Minor fix for MacOS binary
+
+20220121 v1.18.0
+- Add high-level parse API for built-in and plugin parsers
+- Add python module developer documentation
+- Enhance magic syntax exception messages
+- Enhance documentation formatting
+
+20220106 v1.17.7
+- Add stat command streaming parser tested on linux and macOS
+
+20220103 v1.17.6
+- Add jar-manifest file parser (for MANIFEST.MF files)
+- Fix CSV parsers for some files that include doublequotes
+
+20211221 v1.17.5
+- Add zipinfo parser tested on linux and macOS
+
+20211207 v1.17.4
+- Add support for the NO_COLOR environment variable to set mono (http://no-color.org/)
+- Add -C option to force color output even when using pipes (overrides -m and NO_COLOR)
+
+20211202 v1.17.3
+- Update parsers to exit with error if non-string input is detected (raise TypeError)
+- Update streaming parsers to exit with error if non-iterable input is detected (raise TypeError)
+- Simplify quiet-checking in parsers
+- Add iostat parser tested on linux
+- Add iostat streaming parser tested on linux
+
+20211117 v1.17.2
+- Fix ping parser to add Alpine linux support
+- Fix netstat parser for older versions of netstat on linux
+- Fix df parser for cases where the filesystem field overflows the column length
+
+20211030 v1.17.1
+- Fix file parser for gzip files
+- Fix uname parser for cases where the 'processor' and/or 'hardware_platform' fields are missing on linux
+- Fix uname parser on FreeBSD
+- Add lsusb parser tested on linux
+- Add CSV file streaming parser
+- Add testing for Python 3.10.0
+
+20210923 v1.17.0
+- Note to Package Maintainers: please see note at 20210720 v1.16.0
+- Add wrapping of warning and error messages
+- Add vmstat parser tested on linux
+- Add support for streaming parsers
+- Add ls command streaming parser tested on linux, macOS, and freeBSD
+- Add ping command streaming parser tested on linux, macOS, and freeBSD
+- Add vmstat command streaming parser tested on linux
+- Add -u option to allow unbuffered output
+
+20210830 v1.16.2
+- Note to Package Maintainers: please see note at 20210720 v1.16.0
+- Update sfdisk parser to support the -F option and newer versions of sfdisk
+
+20210813 v1.16.1
+- Note to Package Maintainers: please see note at 20210720 v1.16.0
+- Fix issue with process substitution with the magic syntax
+- Fix issue with globs not including filenames with spaces with magic syntax
+- Fix stat parser to properly handle filenames with spaces on macOS/BSD
+
+20210720 v1.16.0
+- Note to Package Maintainers:
+    TL;DR: `/man/jc.1.gz` and `/jc/man/jc.1.gz` are deprecated and only `/man/jc.1` should be used.
+
+    The Man page in the PyPi source packages will be moving from `/jc/man/jc.1.gz` to `/man/jc.1`
+    in version 1.17.0. For now the Man pages will be available in both locations, but be aware that
+    the Man page at `/jc/man/jc.1.gz` is now considered deprecated.
+
+    Also, starting in v1.17.0, the Man page will no longer be compressed in the source package,
+    therefore `/man/jc.1.gz` should also be considered deprecated and will no longer be available
+    after v1.17.0. Please use `/man/jc.1` and compress downstream if you would like.
+- Include CHANGELOG in source distribution
+- Fix Man page location in source packages
+- Add sfdisk command parser tested on linux
+- Update unit test files to change the timezone when needed (POSIX only)
+- Binaries and DEB/RPM/MSI packages now include Python 3.9.5 interpreter
+
+20210628 v1.15.6
+- Fix issue to only load local plugin parsers that have filenames that end in .py
+
+20210520 v1.15.5
+- Fix issue where help and about information would not display if a 3rd party parser library was missing. (e.g. xmltodict)
+- Add more error message detail when encountering ParseError and LibraryNotFound exceptions
+
+20210517 v1.15.4
+- Update ping parser to support error responses in OSX and BSD
+- Update ping parser to be more resilient against parsing errors for unknown error types
+- Update dig parser to support `+noall +answer` use case
+- Update dig parser compatibility to all platforms
+- Fix colors in Windows terminals (cmd.exe and PowerShell)
+- Fix epoch calculations when UTC is referenced as "Coordinated Universal Time"
+- Add Windows time format for systeminfo output
+- Add exceptions module to standardize parser exceptions
+- JC no longer swallows exit codes when using the "magic" syntax. See the Exit Codes section of the README and man page for details
+
+20210426 v1.15.3
+- Add ufw status command parser tested on linux
+- Add ufw-appinfo command parser tested on linux
+- Fix deb package name to conform to standard
+- Add Caveats section to readme and manpage
+
+20210418 v1.15.2
+- Add systeminfo parser tested on Windows
+- Update dig parser to fix an issue with IPv6 addresses in the server field
+- Update dig parser to fix an issue when axfr entries contain a semicolon
+- Update dig parser to add support for Additional Section and Opt Pseudosection
+- Update dig parser to add query_size field
+- Use dig parser as the main example in readme, documentation, and man page
+- Standardize int, float, and boolean conversion rules with functions in jc.utils
+
+20210413 v1.15.1
+- New feature to show parser documentation interactively with -h --parser_name
+  for example: $ jc -h --arp
+- Add man page to pypi package for easier packaging in homebrew
+- Update rpm-qi parser to add two calculated timestamp fields: install_date_epoch and install_date_epoch_utc
+- Clean up documentation and autogenerate the Parser Information section from metadata
+
+20210407 v1.15.0
+- Add acpi command parser tested on linux
+- Add upower command parser tested on linux
+- Add /usr/bin/time command parser tested on linux and macOS
+- Add dpkg -l command parser tested on linux
+- Add rpm -qi command parser tested on linux
+- Add finger command parser tested on linux and macOS
+- Add dir command parser tested on Windows 10
+- Update date parser: complete rewrite (v2.0) providing many enhancements:
+    - Make weekday numbering ISO 8601 compliant
+    - Add a calculated naive timestamp field
+    - Add a calculated UTC timestamp field (only if date output is in UTC)
+    - Add several fields, including: hour_24, utc_offset, day_of_year, week_of_year, iso, and timezone_aware
+- Update uptime parser to add uptime_days, uptime_hours, uptime_minutes, uptime_total_seconds, time_hour,
+      time_minute, and time_second fields
+- Update last parser to use new timestamp function
+- Update stat parser to add access_time_epoch, access_time_epoch_utc, modify_time_epoch, modify_time_epoch_utc,
+      change_time_epoch, change_time_epoch_utc, birth_time_epoch, birth_time_epoch_utc fields
+- Update timedatectl parser to add epoch_utc field
+- Update who parser to add epoch field
+- Update dig parser to add when_epoch and when_epoch_utc fields
+- Update ls parser to add epoch and epoch_utc fields
+- Add -h option to display the help text. Piping errors no longer show the help text.
+- Add -v option to display version information.
+- Add contributing information to project root
+- Make all external python library dependencies optional: pygments, ruamel.yaml, xmltodict
+- JSON output now supports unencoded unicode characters
+- JSON output is now more compact unless the -p (pretty) option is used
+- Developer scripts added and enhanced to automate documentation and man page creation
+- Enhanced man page
+
+20210305 v1.14.4
+- Packaging fix only for binaries and RPMs hosted on https://github.com/kellyjonbrazil/jc-packaging.
+  Packages from PyPi and OS repositories are not affected. This fixes an issue that kept the YAML
+  parser from initializing.
+
+20210210 v1.14.3
+- Add hciconfig parser tested on linux
+- Update dig parser to simplify answer data logic
+
+20210205 v1.14.2
+- Update dig parser to fix cases where there are spaces in the answer data (e.g. TXT records)
+
+20210106 v1.14.1
+- Add iw-scan parser tested on linux (beta)
+- Update date parser for Ubuntu 20.04 support
+- Update last parser for last -F support
+- Update last parser to add convenience fields and augment data for easier parsing
+- Update man page
+- Minor documentation updates
+
+20201231 v1.14.0
+- Add hashsum parser tested on linux, macos
+- Add hash parser tested on linux, macos
+- Add cksum parser tested on linux, macos
+- Add wc parser tested on linux, macos
+- Add printenv support under env parser
+- Add vdir support under ls parser
+- Add python 3.9 to github automation tests
+
+20200805 v1.13.4
+- Update crontab and crontab-u parsers to tighten up variable detection
+- Update ping parser to tighten linux/bsd detection
+
+20200804 v1.13.3
+- Update ping parser for Raspberry Pi compatibility
+
+20200803 v1.13.2
+- Add key/value file parser (wrapper for ini parser)
+- Add date command parser
+- Update traceroute parser to more gracefully handle missing header row
+- Update traceroute parser to handle annotations
+- Update traceroute parser to only return successful probes
+
+20200727 v1.13.1
+- Add route -6 tests
+
+20200727 v1.13.0
+- Add ping and ping6 command parser tested on linux, macos, and freebsd
+- Add traceroute and traceroute6 command parser tested on linux, macos, and freebsd
+- Add tracepath command parser tested on linux
+- Update ini parser to support files only containing key/value pairs
+- Update uname parser exception with a hint to use "uname -a"
+- Update route parser to support IPv6 tables
+
+20200711 v1.12.1
+- Fix tests when using older version of pygments library
+
+20200710 v1.12.0
+- Add sysctl command parser tested on linux, macOS, and freebsd
+- Update the cli code to allow older versions of the pygments library (2.3.0) for debian packaging
+- Code cleanup on the cli
+- Add tests for the cli
+- Vendorize cgitb as tracebackplus for verbose debug messages
+
+20200625 v1.11.8
+- Add verbose debug option using -dd argument
+
+20200622 v1.11.7
+- Fix iptables parser issue which would not output the last chain
+
+20200614 v1.11.6
+- Improve and standardize empty data check for all parsers
+
+20200612 v1.11.5
+- Update airport_s parser to fix error on parsing empty data
+- Update arp parser to fix error on parsing empty data
+- Update blkid parser to fix error on parsing empty data
+- Update crontab parser to fix error on parsing empty data
+- Update crontab_u parser to fix error on parsing empty data
+- Update df parser to fix error on parsing empty data
+- Update free parser to fix error on parsing empty data
+- Update lsblk parser to fix error on parsing empty data
+- Update lsmod parser to fix error on parsing empty data
+- Update mount parser to fix error on parsing empty data
+- Update netstat parser to fix error on parsing empty data
+- Update ntpq parser to fix error on parsing empty data
+- Update ps parser to fix error on parsing empty data
+- Update route parser to fix error on parsing empty data
+- Update systemctl parser to fix error on parsing empty data
+- Update systemctl_lj parser to fix error on parsing empty data
+- Update systemctl_ls parser to fix error on parsing empty data
+- Update systemctl_luf parser to fix error on parsing empty data
+- Update uptime parser to fix error on parsing empty data
+- Update w parser to fix error on parsing empty data
+- Update xml parser to fix error on parsing empty data
+- Add tests to all parsers for no data condition
+- Update ss parser to fix integer fields
+
+20200610 v1.11.4
+- Update ls parser to fix error on parsing an empty directory
+
+20200609 v1.11.3
+- Add local parser plugin feature (contributed by Dean Serenevy)
+
+20200530 v1.11.2
+- Update netstat parser to add freebsd support
+- Update netstat parser to add route_flags_pretty field
+- Update netstat parser to change osx_inode field name to unix_inode
+- Update netstat parser to change osx_flags field name to unix_flags
+- Update netstat parser to strip whitespace from state field
+- Update route parser to add flags_pretty field
+- Update arp parser to add permanent field (freebsd and osx)
+- Update arp parser to add expires field (freebsd)
+- Update w parser to strip whitespace from what field
+- Update last parser to fix FreeBSD issues
+- Update stat parser to change osx_flags field name to unix_flags
+- Update stat parser to add unix_device field for freebsd and osx
+- Fix freebsd compatibility message for df, fstab, mount, ntpq, stat, and uname parsers
+- Fix compatibility message for platforms that include the version number at the end (e.g. freebsd12)
+
+20200523 v1.11.1
+- Update stat command parser to change osx_flags field to string
+
+20200522 v1.11.0
+- Add dmidecode command parser
+- Update stat command parser to add OSX support
+- Update netstat command parser to add OSX support
+- Update netstat command parser to add -r (route) functionality for linux and OSX
+- Update netstat command parser to add -i (interface) functionality for linux and OSX
+
+20200511 v1.10.12
+- Remove shebang from jc/cli.py for Fedora packaging
+
+20200511 v1.10.11
+- Change file permissions for Fedora packaging
+
+20200509 v1.10.10
+- Fix ls parser issue where the first file was skipped for ls -R on some platforms
+- Update last parser to handle 'gone - no logout' condition
+- Update netstat parser to handle bluetooth section (ignore gracefully for now)
+
+20200508 v1.10.9
+- Add license info to vendorized ifconfig-parser class
+
+20200508 v1.10.8
+- Add license file to dist for Fedora RPM packaging requirements
+- Remove tests from package to keep from polluting the global site-packages
+
+20200501 v1.10.7
+- Requirements modifications for Fedora RPM packaging requirements
+
+20200420 v1.10.6
+- Remove homebrew shim references from du osx tests
+
+20200414 v1.10.5
+- Minor change of using sys.exit(0) instead of exit()
+
+20200412 v1.10.4
+- Add color customization via JC_COLORS env variable
+
+20200409 v1.10.3
+- Fix break on pipe error
+
+20200409 v1.10.2
+- Change colors to ansi and match jello colors
+
+20200402 v1.10.1
+- Code cleanup
+
+20200402 v1.10.0
+- Add color output by default when not piping data to another program
+- Add -m option for monochrome output
+
+20200326 v1.9.3
+- Add axfr support for dig command parser
+
+20200312 v1.9.2
+- Update arp parser to fix OSX detection for some edge cases
+
+20200312 v1.9.1
+- Update file command parser to make filename splitting more robust
+
+20200311 v1.9.0
+- Add ntpq command parser
+- Add timedatectl status command parser
+- Add airport -I and airport -s command parser
+- Add file command parser
+- Optimized history command parser by https://github.com/philippeitis
+- Magic syntax fix for certain edge cases
+
+20200308 v1.8.1
+- CLI optimizations by https://github.com/philippeitis
+- Refactored magic syntax function and added tests (https://github.com/philippeitis)
+- Github actions for CI testing on multiple platforms by https://github.com/philippeitis
+- Update ls parser to fix parsing error in OSX with -lR when there are empty folders
+
+20200303 v1.8.0
+- Add blkid command parser
+- Add last and lastb command parser
+- Add who command parser
+- Add CSV file parser
+- Add /etc/passwd file parser
+- Add /etc/shadow file parser
+- Add /etc/group file parser
+- Add /etc/gshadow file parser
+
+20200227 v1.7.5
+- Update ls parser to support filenames with newline characters
+
+20200219 v1.7.4
+- Update ls parser to support multiple directories, globbing, and -R (recursive)
+
+20200211 v1.7.3
+- Add alternative 'magic' syntax: e.g. `jc ls -al`
+- Options can now be condensed (e.g. -prq is equivalant to -p -r -q)
+
+20200208 v1.7.2
+- Include test fixtures in wheel and sdist
+
+20200205 v1.7.1
+- Add YAML file parser
+- Add INI file parser
+- Add XML file parser
+- Add id parser (tested on linux and OSX)
+- Add crontab file parser with user support (tested on linux)
+- Add __version__ variable to parser modules
+- Add exit code on error
+- Update history parser to output "line" as an integer
+- Update compatibility list for some parsers
+- Bugfix in crontab file parser: header insertion was clobbering first row
+- Just-in-time loading of parser modules instead of loading all at start
+
+20191217 v1.6.1
+- Add du parser (tested on linux and OSX)
+- Add crontab parser (tested on linux and OSX)
+- Add pip list parser (tested on linux and OSX)
+- Add pip show parser (tested on linux and OSX)
+- Add OSX support for the ifconfig, arp, df, mount, and uname parsers
+- Add tests for ls, dig, ps, w, uptime on OSX
+- Add about option
+- Add universal parsers to refactor repetitive code
+- Update ifconfig parser to output 'state' as an array
+
+20191117 v1.5.1
+- Add ss parser
+- Add stat parser
+- Add /etc/hosts parser
+- Add /etc/fstab parser
+- Add systemctl parser (includes list-jobs, list-sockets, and list-unit-files)
+- Add -r and raw=True options. By default, jc will now convert numbers and boolean, if possible, and add other semantic information, while the raw output will keep all values as text and provide a more literal JSON output
+- Add -q and quiet=True options to suppress warnings to stderr
+- Add -d option to debug parsing issues
+- Add compatibility warnings to stderr
+- Add documentation
+- Update iptables parser to allow --line-numbers option
+- Update lsblk parser to allow parsing of added columns
+- Update mount parser: changed 'access' field name to 'options'
+- Update netstat parser to allow parsing of unix sockets and raw network connections
+- Update w parser to fix unaligned data where blanks are possible
+- Clean up code and reorganize package
+
+20191031 v1.1.1
+- Add arp parser
+- Add dig parser
+- Add unit tests
+- fix netstat parser (remove side effects due to global variable)
+
+20191025 v1.0.1
+- Add w parser
+- Add uptime parser
+- Add history parser
+- Flatten env parser output
+- Remove problematic characters from key names in: df, free, history, lsblk, lsof, and w
+- Where possible, lowercase all keys (except cases like env where the key is the variable name)
+- Remove integer values
+- Handle CTRL-C gracefully
+
+20191023 v0.9.1
+- Add jobs parser
+- Add lsof parser
+- Add lsmod parser
+- No blocking if no piped data
+- Better help text
+- Clean up iptables parser code
+
+20191022 v0.8.1
+- Add env parser
+- Add df parser
+- Add free parser
+- Add lsblk parser
+- Add mount parser
+- Add uname parser
+- Add iptables parser
+
+20191021 v0.6.4
+- Flatten netstat parser output
+- Clean up argument parsing
+- Fix command help
+
+20191018 v0.5.5
+- Fix netstat -p parsing for Ubuntu
+- Add ps parser
+- Add route parser
+- ls parser fixes
+
+20191017 v0.2.0
+- ifconfig, ls, and netstat support

CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to jc
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Proposing a new parser
+
+## We Develop with Github
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
+
+## We Use Github Flow, So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
+
+1. Open an issue to discuss the new feature, bug fix, or parser before opening a pull request. For new parsers, it is important to agree upon a schema before developing the parser.
+2. Fork the repo and create your branch from `dev`, if available, otherwise `master`.
+3. For new parsers: Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parsers as a template to get started. You can even place a new parser python module file in the [parser plugin directory](https://github.com/kellyjonbrazil/jc#custom-parsers) to get started right away with just a standard `jc` installation.
+4. If you've added code that should be tested, add tests. All new parsers should have several sample outputs and tests.
+5. Documentation is auto-generated from docstrings, so ensure they are clear and accurate.
+6. Ensure the test suite passes. (Note: "**America/Los_Angeles**" timezone should be configured on the test system)
+7. Make sure your code lints.
+8. Issue that pull request!
+
+## Parser Schema Guidelines
+- Try to keep the schema as flat as possible - typically a list of flat dictionaries
+- Keys should be lowercase, contain no special characters, and spaces should be converted to underscores
+- Keys should be static, if possible. If they have to be dynamic, then they should not contain lists or dictionaries
+
+This will make it easier to use tools like `jq` without requiring escaping of special characters, encapsulating key names in [""], keeps paths predictable, and makes iterating and searching for values easier.
+
+**Examples**
+
+Bad:
+```json
+{
+  "Interface 1": [
+    "192.168.1.1",
+    "172.16.1.1"
+  ],
+  "Wifi Interface 1": [
+    "10.1.1.1"
+  ]
+}
+```
+Good:
+```json
+[
+  {
+    "interface": "Interface 1",
+    "ip_addresses": [
+      "192.168.1.1",
+      "172.16.1.1"
+    ]
+  },
+  {
+    "interface": "Wifi Interface 1",
+    "ip_addresses": [
+      "10.1.1.1"
+    ]
+  }
+]
+```
+
+## Tests
+It is essential to have good command output sample coverage and tests to keep the `jc` parser quality high.
+
+Many parsers include calculated timestamp fields using the `jc.utils.timestamp` class. Naive timestamps created with this class should be generated on a system configured with the "**America/Los_Angeles**" timezone on linux/macOS/unix and "**Pacific Standard Time**" timezone on Windows for tests to pass on the Github Actions CI tests. This timezone should be configured on your local system before running the tests locally, as well.
+
+## Any contributions you make will be under the MIT Software License
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's Issues
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/kellyjonbrazil/jc/issues); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+## Use a Consistent Coding Style
+* 4 spaces for indentation rather than tabs
+* Use a Python linter that will enforce PEP 8 and other best practices

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Kelly Brazil
+Copyright (c) 2020 Kelly Brazil
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -0,0 +1,3 @@
+include jc/py.typed
+include man/jc.1
+include CHANGELOG

_config.yml

@@ -1 +1,2 @@
-theme: jekyll-theme-cayman
+theme: jekyll-theme-cayman
+markdown: GFM

build-completions.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+# build Bash and Zsh completion scripts and add to the completions folder
+from jc.shell_completions import bash_completion, zsh_completion
+
+with open('completions/jc_bash_completion.sh', 'w') as f:
+    print(bash_completion(), file=f)
+
+with open('completions/jc_zsh_completion.sh', 'w') as f:
+    print(zsh_completion(), file=f)

changelog.txt

@@ -1,165 +0,0 @@
-jc changelog
-
-20200508 v1.10.8
-- Add license file to dist for Fedora RPM packaging requirements
-- Remove tests from package to keep from polluting the global site-packages
-
-20200501 v1.10.7
-- Requirements modifications for Fedora RPM packaging requirements
-
-20200420 v1.10.6
-- Remove homebrew shim references from du osx tests
-
-20200414 v1.10.5
-- Minor change of using sys.exit(0) instead of exit()
-
-20200412 v1.10.4
-- Add color customization via JC_COLORS env variable
-
-20200409 v1.10.3
-- Fix break on pipe error
-
-20200409 v1.10.2
-- Change colors to ansi and match jello colors
-
-20200402 v1.10.1
-- Code cleanup
-
-20200402 v1.10.0
-- Add color output by default when not piping data to another program
-- Add -m option for monochrome output
-
-20200326 v1.9.3
-- Add axfr support for dig command parser
-
-20200312 v1.9.2
-- Updated arp parser to fix OSX detection for some edge cases
-
-20200312 v1.9.1
-- Updated file command parser to make filename splitting more robust
-
-20200311 v1.9.0
-- Added ntpq command parser
-- Added timedatectl status command parser
-- Added airport -I and airport -s command parser
-- Added file command parser
-- Optimized history command parser by https://github.com/philippeitis
-- Magic syntax fix for certain edge cases
-
-20200308 v1.8.1
-- CLI optimizations by https://github.com/philippeitis
-- Refactored magic syntax function and added tests (https://github.com/philippeitis)
-- Github actions for CI testing on multiple platforms by https://github.com/philippeitis
-- Updated ls parser to fix parsing error in OSX with -lR when there are empty folders
-
-20200303 v1.8.0
-- Added blkid command parser
-- Added last and lastb command parser
-- Added who command parser
-- Added CSV file parser
-- Added /etc/passwd file parser
-- Added /etc/shadow file parser
-- Added /etc/group file parser
-- Added /etc/gshadow file parser
-
-20200227 v1.7.5
-- Updated ls parser to support filenames with newline characters
-
-20200219 v1.7.4
-- Updated ls parser to support multiple directories, globbing, and -R (recursive)
-
-20200211 v1.7.3
-- Add alternative 'magic' syntax: e.g. `jc ls -al`
-- Options can now be condensed (e.g. -prq is equivalant to -p -r -q)
-
-20200208 v1.7.2
-- Include test fixtures in wheel and sdist
-
-20200205 v1.7.1
-- Add YAML file parser
-- Add INI file parser
-- Add XML file parser
-- Add id parser (tested on linux and OSX)
-- Add crontab file parser with user support (tested on linux)
-- Add __version__ variable to parser modules
-- Add exit code on error
-- Updated history parser to output "line" as an integer
-- Updated compatibility list for some parsers
-- Bugfix in crontab file parser: header insertion was clobbering first row
-- Just-in-time loading of parser modules instead of loading all at start
-
-20191217 v1.6.1
-- Add du parser (tested on linux and OSX)
-- Add crontab parser (tested on linux and OSX)
-- Add pip list parser (tested on linux and OSX)
-- Add pip show parser (tested on linux and OSX)
-- Add OSX support for the ifconfig, arp, df, mount, and uname parsers
-- Add tests for ls, dig, ps, w, uptime on OSX
-- Add about option
-- Add universal parsers to refactor repetitive code
-- Updated ifconfig parser to output 'state' as an array
-
-20191117 v1.5.1
-- Add ss parser
-- Add stat parser
-- Add /etc/hosts parser
-- Add /etc/fstab parser
-- Add systemctl parser (includes list-jobs, list-sockets, and list-unit-files)
-- Add -r and raw=True options. By default, jc will now convert numbers and boolean, if possible, and add other semantic information, while the raw output will keep all values as text and provide a more literal JSON output
-- Add -q and quiet=True options to suppress warnings to stderr
-- Add -d option to debug parsing issues
-- Add compatibility warnings to stderr
-- Add documentation
-- Updated iptables parser to allow --line-numbers option
-- Updated lsblk parser to allow parsing of added columns
-- Updated mount parser: changed 'access' field name to 'options'
-- Updated netstat parser to allow parsing of unix sockets and raw network connections
-- Updated w parser to fix unaligned data where blanks are possible
-- Clean up code and reorganize package
-
-20191031 v1.1.1
-- Add arp parser
-- Add dig parser
-- Add unit tests
-- fix netstat parser (remove side effects due to global variable)
-
-20191025 v1.0.1
-- Add w parser
-- Add uptime parser
-- Add history parser
-- Flatten env parser output
-- Remove problematic characters from key names in: df, free, history, lsblk, lsof, and w
-- Where possible, lowercase all keys (except cases like env where the key is the variable name)
-- Remove integer values
-- Handle CTRL-C gracefully
-
-20191023 v0.9.1
-- Add jobs parser
-- Add lsof parser
-- Add lsmod parser
-- No blocking if no piped data
-- Better help text
-- Clean up iptables parser code
-
-20191022 v0.8.1
-- Add env parser
-- Add df parser
-- Add free parser
-- Add lsblk parser
-- Add mount parser
-- Add uname parser
-- Add iptables parser
-
-20191021 v0.6.4
-- Flatten netstat parser output
-- Clean up argument parsing
-- Fix command help
-
-20191018 v0.5.5
-- Fix netstat -p parsing for Ubuntu
-- Add ps parser
-- Add route parser
-- ls parser fixes
-
-20191017 v0.2.0
-- ifconfig, ls, and netstat support

completions/jc_bash_completion.sh

@@ -0,0 +1,90 @@
+_jc()
+{
+    local cur prev words cword jc_commands jc_parsers jc_options \
+          jc_about_options jc_about_mod_options jc_help_options jc_special_options
+
+    jc_commands=(acpi airport arp blkid chage cksum crontab date df dig dmidecode dpkg du env file findmnt finger free git gpg hciconfig id ifconfig iostat iptables iw jobs last lastb ls lsblk lsmod lsof lspci lsusb md5 md5sum mdadm mount mpstat netstat nmcli ntpq os-prober pidstat ping ping6 pip pip3 postconf printenv ps route rpm rsync sfdisk sha1sum sha224sum sha256sum sha384sum sha512sum shasum ss sshd stat sum sysctl systemctl systeminfo timedatectl top tracepath tracepath6 traceroute traceroute6 udevadm ufw uname update-alternatives upower uptime vdir vmstat w wc who xrandr zipinfo)
+    jc_parsers=(--acpi --airport --airport-s --arp --asciitable --asciitable-m --blkid --cef --cef-s --chage --cksum --crontab --crontab-u --csv --csv-s --date --datetime-iso --df --dig --dir --dmidecode --dpkg-l --du --email-address --env --file --findmnt --finger --free --fstab --git-log --git-log-s --git-ls-remote --gpg --group --gshadow --hash --hashsum --hciconfig --history --hosts --id --ifconfig --ini --iostat --iostat-s --ip-address --iptables --iw-scan --jar-manifest --jobs --jwt --kv --last --ls --ls-s --lsblk --lsmod --lsof --lspci --lsusb --m3u --mdadm --mount --mpstat --mpstat-s --netstat --nmcli --ntpq --os-prober --passwd --pci-ids --pidstat --pidstat-s --ping --ping-s --pip-list --pip-show --plist --postconf --proc --proc-buddyinfo --proc-consoles --proc-cpuinfo --proc-crypto --proc-devices --proc-diskstats --proc-filesystems --proc-interrupts --proc-iomem --proc-ioports --proc-loadavg --proc-locks --proc-meminfo --proc-modules --proc-mtrr --proc-pagetypeinfo --proc-partitions --proc-slabinfo --proc-softirqs --proc-stat --proc-swaps --proc-uptime --proc-version --proc-vmallocinfo --proc-vmstat --proc-zoneinfo --proc-driver-rtc --proc-net-arp --proc-net-dev --proc-net-dev-mcast --proc-net-if-inet6 --proc-net-igmp --proc-net-igmp6 --proc-net-ipv6-route --proc-net-netlink --proc-net-netstat --proc-net-packet --proc-net-protocols --proc-net-route --proc-net-unix --proc-pid-fdinfo --proc-pid-io --proc-pid-maps --proc-pid-mountinfo --proc-pid-numa-maps --proc-pid-smaps --proc-pid-stat --proc-pid-statm --proc-pid-status --ps --route --rpm-qi --rsync --rsync-s --semver --sfdisk --shadow --ss --sshd-conf --stat --stat-s --sysctl --syslog --syslog-s --syslog-bsd --syslog-bsd-s --systemctl --systemctl-lj --systemctl-ls --systemctl-luf --systeminfo --time --timedatectl --timestamp --top --top-s --tracepath --traceroute --udevadm --ufw --ufw-appinfo --uname --update-alt-gs --update-alt-q --upower --uptime --url --vmstat --vmstat-s --w --wc --who --x509-cert --xml --xrandr --yaml --zipinfo)
+    jc_options=(--force-color -C --debug -d --monochrome -m --meta-out -M --pretty -p --quiet -q --raw -r --unbuffer -u --yaml-out -y)
+    jc_about_options=(--about -a)
+    jc_about_mod_options=(--pretty -p --yaml-out -y --monochrome -m --force-color -C)
+    jc_help_options=(--help -h)
+    jc_special_options=(--version -v --bash-comp -B --zsh-comp -Z)
+
+    COMPREPLY=()
+    _get_comp_words_by_ref cur prev words cword
+
+    # if jc_about_options are found anywhere in the line, then only complete from jc_about_mod_options
+    for i in "${words[@]::${#words[@]}-1}"; do
+        if [[ " ${jc_about_options[*]} " =~ " ${i} " ]]; then
+            COMPREPLY=( $( compgen -W "${jc_about_mod_options[*]}" \
+            -- "${cur}" ) )
+            return 0
+        fi
+    done
+
+    # if jc_help_options and a parser are found anywhere in the line, then no more completions
+    if
+        (
+            for i in "${words[@]::${#words[@]}-1}"; do
+                if [[ " ${jc_help_options[*]} " =~ " ${i} " ]]; then
+                    return 0
+                fi
+            done
+            return 1
+        ) && (
+            for i in "${words[@]::${#words[@]}-1}"; do
+                if [[ " ${jc_parsers[*]} " =~ " ${i} " ]]; then
+                    return 0
+                fi
+            done
+            return 1
+        ); then
+        return 0
+    fi
+
+    # if jc_help_options are found anywhere in the line, then only complete with parsers
+    for i in "${words[@]::${#words[@]}-1}"; do
+        if [[ " ${jc_help_options[*]} " =~ " ${i} " ]]; then
+            COMPREPLY=( $( compgen -W "${jc_parsers[*]}" \
+            -- "${cur}" ) )
+            return 0
+        fi
+    done
+
+    # if special options are found anywhere in the line, then no more completions
+    for i in "${words[@]::${#words[@]}-1}"; do
+        if [[ " ${jc_special_options[*]} " =~ " ${i} " ]]; then
+            return 0
+        fi
+    done
+
+    # if magic command is found anywhere in the line, use called command's autocompletion
+    for i in "${words[@]::${#words[@]}-1}"; do
+        if [[ " ${jc_commands[*]} " =~ " ${i} " ]]; then
+            _command
+            return 0
+        fi
+    done
+
+    # if "/pr[oc]" (magic for Procfile parsers) is in the current word, complete with files/directories in the path
+    if [[ "${cur}" =~ "/pr" ]]; then
+        _filedir
+        return 0
+    fi
+
+    # if a parser arg is found anywhere in the line, only show options and help options
+    for i in "${words[@]::${#words[@]}-1}"; do
+        if [[ " ${jc_parsers[*]} " =~ " ${i} " ]]; then
+            COMPREPLY=( $( compgen -W "${jc_options[*]} ${jc_help_options[*]}" \
+            -- "${cur}" ) )
+            return 0
+        fi
+    done
+
+    # default completion
+    COMPREPLY=( $( compgen -W "${jc_options[*]} ${jc_about_options[*]} ${jc_help_options[*]} ${jc_special_options[*]} ${jc_parsers[*]} ${jc_commands[*]}" \
+        -- "${cur}" ) )
+} &&
+complete -F _jc jc
+

completions/jc_zsh_completion.sh

@@ -0,0 +1,413 @@
+#compdef jc
+
+_jc() {
+    local -a jc_commands jc_commands_describe \
+             jc_parsers jc_parsers_describe \
+             jc_options jc_options_describe \
+             jc_about_options jc_about_options_describe \
+             jc_about_mod_options jc_about_mod_options_describe \
+             jc_help_options jc_help_options_describe \
+             jc_special_options jc_special_options_describe
+
+    jc_commands=(acpi airport arp blkid chage cksum crontab date df dig dmidecode dpkg du env file findmnt finger free git gpg hciconfig id ifconfig iostat iptables iw jobs last lastb ls lsblk lsmod lsof lspci lsusb md5 md5sum mdadm mount mpstat netstat nmcli ntpq os-prober pidstat ping ping6 pip pip3 postconf printenv ps route rpm rsync sfdisk sha1sum sha224sum sha256sum sha384sum sha512sum shasum ss sshd stat sum sysctl systemctl systeminfo timedatectl top tracepath tracepath6 traceroute traceroute6 udevadm ufw uname update-alternatives upower uptime vdir vmstat w wc who xrandr zipinfo)
+    jc_commands_describe=(
+        'acpi:run "acpi" command with magic syntax.'
+        'airport:run "airport" command with magic syntax.'
+        'arp:run "arp" command with magic syntax.'
+        'blkid:run "blkid" command with magic syntax.'
+        'chage:run "chage" command with magic syntax.'
+        'cksum:run "cksum" command with magic syntax.'
+        'crontab:run "crontab" command with magic syntax.'
+        'date:run "date" command with magic syntax.'
+        'df:run "df" command with magic syntax.'
+        'dig:run "dig" command with magic syntax.'
+        'dmidecode:run "dmidecode" command with magic syntax.'
+        'dpkg:run "dpkg" command with magic syntax.'
+        'du:run "du" command with magic syntax.'
+        'env:run "env" command with magic syntax.'
+        'file:run "file" command with magic syntax.'
+        'findmnt:run "findmnt" command with magic syntax.'
+        'finger:run "finger" command with magic syntax.'
+        'free:run "free" command with magic syntax.'
+        'git:run "git" command with magic syntax.'
+        'gpg:run "gpg" command with magic syntax.'
+        'hciconfig:run "hciconfig" command with magic syntax.'
+        'id:run "id" command with magic syntax.'
+        'ifconfig:run "ifconfig" command with magic syntax.'
+        'iostat:run "iostat" command with magic syntax.'
+        'iptables:run "iptables" command with magic syntax.'
+        'iw:run "iw" command with magic syntax.'
+        'jobs:run "jobs" command with magic syntax.'
+        'last:run "last" command with magic syntax.'
+        'lastb:run "lastb" command with magic syntax.'
+        'ls:run "ls" command with magic syntax.'
+        'lsblk:run "lsblk" command with magic syntax.'
+        'lsmod:run "lsmod" command with magic syntax.'
+        'lsof:run "lsof" command with magic syntax.'
+        'lspci:run "lspci" command with magic syntax.'
+        'lsusb:run "lsusb" command with magic syntax.'
+        'md5:run "md5" command with magic syntax.'
+        'md5sum:run "md5sum" command with magic syntax.'
+        'mdadm:run "mdadm" command with magic syntax.'
+        'mount:run "mount" command with magic syntax.'
+        'mpstat:run "mpstat" command with magic syntax.'
+        'netstat:run "netstat" command with magic syntax.'
+        'nmcli:run "nmcli" command with magic syntax.'
+        'ntpq:run "ntpq" command with magic syntax.'
+        'os-prober:run "os-prober" command with magic syntax.'
+        'pidstat:run "pidstat" command with magic syntax.'
+        'ping:run "ping" command with magic syntax.'
+        'ping6:run "ping6" command with magic syntax.'
+        'pip:run "pip" command with magic syntax.'
+        'pip3:run "pip3" command with magic syntax.'
+        'postconf:run "postconf" command with magic syntax.'
+        'printenv:run "printenv" command with magic syntax.'
+        'ps:run "ps" command with magic syntax.'
+        'route:run "route" command with magic syntax.'
+        'rpm:run "rpm" command with magic syntax.'
+        'rsync:run "rsync" command with magic syntax.'
+        'sfdisk:run "sfdisk" command with magic syntax.'
+        'sha1sum:run "sha1sum" command with magic syntax.'
+        'sha224sum:run "sha224sum" command with magic syntax.'
+        'sha256sum:run "sha256sum" command with magic syntax.'
+        'sha384sum:run "sha384sum" command with magic syntax.'
+        'sha512sum:run "sha512sum" command with magic syntax.'
+        'shasum:run "shasum" command with magic syntax.'
+        'ss:run "ss" command with magic syntax.'
+        'sshd:run "sshd" command with magic syntax.'
+        'stat:run "stat" command with magic syntax.'
+        'sum:run "sum" command with magic syntax.'
+        'sysctl:run "sysctl" command with magic syntax.'
+        'systemctl:run "systemctl" command with magic syntax.'
+        'systeminfo:run "systeminfo" command with magic syntax.'
+        'timedatectl:run "timedatectl" command with magic syntax.'
+        'top:run "top" command with magic syntax.'
+        'tracepath:run "tracepath" command with magic syntax.'
+        'tracepath6:run "tracepath6" command with magic syntax.'
+        'traceroute:run "traceroute" command with magic syntax.'
+        'traceroute6:run "traceroute6" command with magic syntax.'
+        'udevadm:run "udevadm" command with magic syntax.'
+        'ufw:run "ufw" command with magic syntax.'
+        'uname:run "uname" command with magic syntax.'
+        'update-alternatives:run "update-alternatives" command with magic syntax.'
+        'upower:run "upower" command with magic syntax.'
+        'uptime:run "uptime" command with magic syntax.'
+        'vdir:run "vdir" command with magic syntax.'
+        'vmstat:run "vmstat" command with magic syntax.'
+        'w:run "w" command with magic syntax.'
+        'wc:run "wc" command with magic syntax.'
+        'who:run "who" command with magic syntax.'
+        'xrandr:run "xrandr" command with magic syntax.'
+        'zipinfo:run "zipinfo" command with magic syntax.'
+    )
+    jc_parsers=(--acpi --airport --airport-s --arp --asciitable --asciitable-m --blkid --cef --cef-s --chage --cksum --crontab --crontab-u --csv --csv-s --date --datetime-iso --df --dig --dir --dmidecode --dpkg-l --du --email-address --env --file --findmnt --finger --free --fstab --git-log --git-log-s --git-ls-remote --gpg --group --gshadow --hash --hashsum --hciconfig --history --hosts --id --ifconfig --ini --iostat --iostat-s --ip-address --iptables --iw-scan --jar-manifest --jobs --jwt --kv --last --ls --ls-s --lsblk --lsmod --lsof --lspci --lsusb --m3u --mdadm --mount --mpstat --mpstat-s --netstat --nmcli --ntpq --os-prober --passwd --pci-ids --pidstat --pidstat-s --ping --ping-s --pip-list --pip-show --plist --postconf --proc --proc-buddyinfo --proc-consoles --proc-cpuinfo --proc-crypto --proc-devices --proc-diskstats --proc-filesystems --proc-interrupts --proc-iomem --proc-ioports --proc-loadavg --proc-locks --proc-meminfo --proc-modules --proc-mtrr --proc-pagetypeinfo --proc-partitions --proc-slabinfo --proc-softirqs --proc-stat --proc-swaps --proc-uptime --proc-version --proc-vmallocinfo --proc-vmstat --proc-zoneinfo --proc-driver-rtc --proc-net-arp --proc-net-dev --proc-net-dev-mcast --proc-net-if-inet6 --proc-net-igmp --proc-net-igmp6 --proc-net-ipv6-route --proc-net-netlink --proc-net-netstat --proc-net-packet --proc-net-protocols --proc-net-route --proc-net-unix --proc-pid-fdinfo --proc-pid-io --proc-pid-maps --proc-pid-mountinfo --proc-pid-numa-maps --proc-pid-smaps --proc-pid-stat --proc-pid-statm --proc-pid-status --ps --route --rpm-qi --rsync --rsync-s --semver --sfdisk --shadow --ss --sshd-conf --stat --stat-s --sysctl --syslog --syslog-s --syslog-bsd --syslog-bsd-s --systemctl --systemctl-lj --systemctl-ls --systemctl-luf --systeminfo --time --timedatectl --timestamp --top --top-s --tracepath --traceroute --udevadm --ufw --ufw-appinfo --uname --update-alt-gs --update-alt-q --upower --uptime --url --vmstat --vmstat-s --w --wc --who --x509-cert --xml --xrandr --yaml --zipinfo)
+    jc_parsers_describe=(
+        '--acpi:`acpi` command parser'
+        '--airport:`airport -I` command parser'
+        '--airport-s:`airport -s` command parser'
+        '--arp:`arp` command parser'
+        '--asciitable:ASCII and Unicode table parser'
+        '--asciitable-m:multi-line ASCII and Unicode table parser'
+        '--blkid:`blkid` command parser'
+        '--cef:CEF string parser'
+        '--cef-s:CEF string streaming parser'
+        '--chage:`chage --list` command parser'
+        '--cksum:`cksum` and `sum` command parser'
+        '--crontab:`crontab` command and file parser'
+        '--crontab-u:`crontab` file parser with user support'
+        '--csv:CSV file parser'
+        '--csv-s:CSV file streaming parser'
+        '--date:`date` command parser'
+        '--datetime-iso:ISO 8601 Datetime string parser'
+        '--df:`df` command parser'
+        '--dig:`dig` command parser'
+        '--dir:`dir` command parser'
+        '--dmidecode:`dmidecode` command parser'
+        '--dpkg-l:`dpkg -l` command parser'
+        '--du:`du` command parser'
+        '--email-address:Email Address string parser'
+        '--env:`env` command parser'
+        '--file:`file` command parser'
+        '--findmnt:`findmnt` command parser'
+        '--finger:`finger` command parser'
+        '--free:`free` command parser'
+        '--fstab:`/etc/fstab` file parser'
+        '--git-log:`git log` command parser'
+        '--git-log-s:`git log` command streaming parser'
+        '--git-ls-remote:`git ls-remote` command parser'
+        '--gpg:`gpg --with-colons` command parser'
+        '--group:`/etc/group` file parser'
+        '--gshadow:`/etc/gshadow` file parser'
+        '--hash:`hash` command parser'
+        '--hashsum:hashsum command parser (`md5sum`, `shasum`, etc.)'
+        '--hciconfig:`hciconfig` command parser'
+        '--history:`history` command parser'
+        '--hosts:`/etc/hosts` file parser'
+        '--id:`id` command parser'
+        '--ifconfig:`ifconfig` command parser'
+        '--ini:INI file parser'
+        '--iostat:`iostat` command parser'
+        '--iostat-s:`iostat` command streaming parser'
+        '--ip-address:IPv4 and IPv6 Address string parser'
+        '--iptables:`iptables` command parser'
+        '--iw-scan:`iw dev [device] scan` command parser'
+        '--jar-manifest:Java MANIFEST.MF file parser'
+        '--jobs:`jobs` command parser'
+        '--jwt:JWT string parser'
+        '--kv:Key/Value file parser'
+        '--last:`last` and `lastb` command parser'
+        '--ls:`ls` command parser'
+        '--ls-s:`ls` command streaming parser'
+        '--lsblk:`lsblk` command parser'
+        '--lsmod:`lsmod` command parser'
+        '--lsof:`lsof` command parser'
+        '--lspci:`lspci -mmv` command parser'
+        '--lsusb:`lsusb` command parser'
+        '--m3u:M3U and M3U8 file parser'
+        '--mdadm:`mdadm` command parser'
+        '--mount:`mount` command parser'
+        '--mpstat:`mpstat` command parser'
+        '--mpstat-s:`mpstat` command streaming parser'
+        '--netstat:`netstat` command parser'
+        '--nmcli:`nmcli` command parser'
+        '--ntpq:`ntpq -p` command parser'
+        '--os-prober:`os-prober` command parser'
+        '--passwd:`/etc/passwd` file parser'
+        '--pci-ids:`pci.ids` file parser'
+        '--pidstat:`pidstat -H` command parser'
+        '--pidstat-s:`pidstat -H` command streaming parser'
+        '--ping:`ping` and `ping6` command parser'
+        '--ping-s:`ping` and `ping6` command streaming parser'
+        '--pip-list:`pip list` command parser'
+        '--pip-show:`pip show` command parser'
+        '--plist:PLIST file parser'
+        '--postconf:`postconf -M` command parser'
+        '--proc:`/proc/` file parser'
+        '--proc-buddyinfo:`/proc/buddyinfo` file parser'
+        '--proc-consoles:`/proc/consoles` file parser'
+        '--proc-cpuinfo:`/proc/cpuinfo` file parser'
+        '--proc-crypto:`/proc/crypto` file parser'
+        '--proc-devices:`/proc/devices` file parser'
+        '--proc-diskstats:`/proc/diskstats` file parser'
+        '--proc-filesystems:`/proc/filesystems` file parser'
+        '--proc-interrupts:`/proc/interrupts` file parser'
+        '--proc-iomem:`/proc/iomem` file parser'
+        '--proc-ioports:`/proc/ioports` file parser'
+        '--proc-loadavg:`/proc/loadavg` file parser'
+        '--proc-locks:`/proc/locks` file parser'
+        '--proc-meminfo:`/proc/meminfo` file parser'
+        '--proc-modules:`/proc/modules` file parser'
+        '--proc-mtrr:`/proc/mtrr` file parser'
+        '--proc-pagetypeinfo:`/proc/pagetypeinfo` file parser'
+        '--proc-partitions:`/proc/partitions` file parser'
+        '--proc-slabinfo:`/proc/slabinfo` file parser'
+        '--proc-softirqs:`/proc/softirqs` file parser'
+        '--proc-stat:`/proc/stat` file parser'
+        '--proc-swaps:`/proc/swaps` file parser'
+        '--proc-uptime:`/proc/uptime` file parser'
+        '--proc-version:`/proc/version` file parser'
+        '--proc-vmallocinfo:`/proc/vmallocinfo` file parser'
+        '--proc-vmstat:`/proc/vmstat` file parser'
+        '--proc-zoneinfo:`/proc/zoneinfo` file parser'
+        '--proc-driver-rtc:`/proc/driver/rtc` file parser'
+        '--proc-net-arp:`/proc/net/arp` file parser'
+        '--proc-net-dev:`/proc/net/dev` file parser'
+        '--proc-net-dev-mcast:`/proc/net/dev_mcast` file parser'
+        '--proc-net-if-inet6:`/proc/net/if_inet6` file parser'
+        '--proc-net-igmp:`/proc/net/igmp` file parser'
+        '--proc-net-igmp6:`/proc/net/igmp6` file parser'
+        '--proc-net-ipv6-route:`/proc/net/ipv6_route` file parser'
+        '--proc-net-netlink:`/proc/net/netlink` file parser'
+        '--proc-net-netstat:`/proc/net/netstat` file parser'
+        '--proc-net-packet:`/proc/net/packet` file parser'
+        '--proc-net-protocols:`/proc/net/protocols` file parser'
+        '--proc-net-route:`/proc/net/route` file parser'
+        '--proc-net-unix:`/proc/net/unix` file parser'
+        '--proc-pid-fdinfo:`/proc/<pid>/fdinfo/<fd>` file parser'
+        '--proc-pid-io:`/proc/<pid>/io` file parser'
+        '--proc-pid-maps:`/proc/<pid>/maps` file parser'
+        '--proc-pid-mountinfo:`/proc/<pid>/mountinfo` file parser'
+        '--proc-pid-numa-maps:`/proc/<pid>/numa_maps` file parser'
+        '--proc-pid-smaps:`/proc/<pid>/smaps` file parser'
+        '--proc-pid-stat:`/proc/<pid>/stat` file parser'
+        '--proc-pid-statm:`/proc/<pid>/statm` file parser'
+        '--proc-pid-status:`/proc/<pid>/status` file parser'
+        '--ps:`ps` command parser'
+        '--route:`route` command parser'
+        '--rpm-qi:`rpm -qi` command parser'
+        '--rsync:`rsync` command parser'
+        '--rsync-s:`rsync` command streaming parser'
+        '--semver:Semantic Version string parser'
+        '--sfdisk:`sfdisk` command parser'
+        '--shadow:`/etc/shadow` file parser'
+        '--ss:`ss` command parser'
+        '--sshd-conf:sshd config file and `sshd -T` command parser'
+        '--stat:`stat` command parser'
+        '--stat-s:`stat` command streaming parser'
+        '--sysctl:`sysctl` command parser'
+        '--syslog:Syslog RFC 5424 string parser'
+        '--syslog-s:Syslog RFC 5424 string streaming parser'
+        '--syslog-bsd:Syslog RFC 3164 string parser'
+        '--syslog-bsd-s:Syslog RFC 3164 string streaming parser'
+        '--systemctl:`systemctl` command parser'
+        '--systemctl-lj:`systemctl list-jobs` command parser'
+        '--systemctl-ls:`systemctl list-sockets` command parser'
+        '--systemctl-luf:`systemctl list-unit-files` command parser'
+        '--systeminfo:`systeminfo` command parser'
+        '--time:`/usr/bin/time` command parser'
+        '--timedatectl:`timedatectl status` command parser'
+        '--timestamp:Unix Epoch Timestamp string parser'
+        '--top:`top -b` command parser'
+        '--top-s:`top -b` command streaming parser'
+        '--tracepath:`tracepath` and `tracepath6` command parser'
+        '--traceroute:`traceroute` and `traceroute6` command parser'
+        '--udevadm:`udevadm info` command parser'
+        '--ufw:`ufw status` command parser'
+        '--ufw-appinfo:`ufw app info [application]` command parser'
+        '--uname:`uname -a` command parser'
+        '--update-alt-gs:`update-alternatives --get-selections` command parser'
+        '--update-alt-q:`update-alternatives --query` command parser'
+        '--upower:`upower` command parser'
+        '--uptime:`uptime` command parser'
+        '--url:URL string parser'
+        '--vmstat:`vmstat` command parser'
+        '--vmstat-s:`vmstat` command streaming parser'
+        '--w:`w` command parser'
+        '--wc:`wc` command parser'
+        '--who:`who` command parser'
+        '--x509-cert:X.509 PEM and DER certificate file parser'
+        '--xml:XML file parser'
+        '--xrandr:`xrandr` command parser'
+        '--yaml:YAML file parser'
+        '--zipinfo:`zipinfo` command parser'
+    )
+    jc_options=(--force-color -C --debug -d --monochrome -m --meta-out -M --pretty -p --quiet -q --raw -r --unbuffer -u --yaml-out -y)
+    jc_options_describe=(
+        '--force-color:force color output even when using pipes (overrides -m)'
+        '-C:force color output even when using pipes (overrides -m)'
+        '--debug:debug (double for verbose debug)'
+        '-d:debug (double for verbose debug)'
+        '--monochrome:monochrome output'
+        '-m:monochrome output'
+        '--meta-out:add metadata to output including timestamp, etc.'
+        '-M:add metadata to output including timestamp, etc.'
+        '--pretty:pretty print output'
+        '-p:pretty print output'
+        '--quiet:suppress warnings (double to ignore streaming errors)'
+        '-q:suppress warnings (double to ignore streaming errors)'
+        '--raw:raw output'
+        '-r:raw output'
+        '--unbuffer:unbuffer output'
+        '-u:unbuffer output'
+        '--yaml-out:YAML output'
+        '-y:YAML output'
+    )
+    jc_about_options=(--about -a)
+    jc_about_options_describe=(
+        '--about:about jc'
+        '-a:about jc'
+    )
+    jc_about_mod_options=(--pretty -p --yaml-out -y --monochrome -m --force-color -C)
+    jc_about_mod_options_describe=(
+        '--pretty:pretty print output'
+        '-p:pretty print output'
+        '--yaml-out:YAML output'
+        '-y:YAML output'
+        '--monochrome:monochrome output'
+        '-m:monochrome output'
+        '--force-color:force color output even when using pipes (overrides -m)'
+        '-C:force color output even when using pipes (overrides -m)'
+    )
+    jc_help_options=(--help -h)
+    jc_help_options_describe=(
+        '--help:help (--help --parser_name for parser documentation)'
+        '-h:help (--help --parser_name for parser documentation)'
+    )
+    jc_special_options=(--version -v --bash-comp -B --zsh-comp -Z)
+    jc_special_options_describe=(
+        '--version:version info'
+        '-v:version info'
+        '--bash-comp:gen Bash completion: jc -B > /etc/bash_completion.d/jc'
+        '-B:gen Bash completion: jc -B > /etc/bash_completion.d/jc'
+        '--zsh-comp:gen Zsh completion: jc -Z > "${fpath[1]}/_jc"'
+        '-Z:gen Zsh completion: jc -Z > "${fpath[1]}/_jc"'
+    )
+
+    # if jc_about_options are found anywhere in the line, then only complete from jc_about_mod_options
+    for i in ${words:0:-1}; do
+        if (( $jc_about_options[(Ie)${i}] )); then
+            _describe 'commands' jc_about_mod_options_describe
+            return 0
+        fi
+    done
+
+    # if jc_help_options and a parser are found anywhere in the line, then no more completions
+     if
+        (
+            for i in ${words:0:-1}; do
+                if (( $jc_help_options[(Ie)${i}] )); then
+                    return 0
+                fi
+            done
+            return 1
+        ) && (
+            for i in ${words:0:-1}; do
+                if (( $jc_parsers[(Ie)${i}] )); then
+                    return 0
+                fi
+            done
+            return 1
+        ); then
+        return 0
+    fi
+
+    # if jc_help_options are found anywhere in the line, then only complete with parsers
+    for i in ${words:0:-1}; do
+        if (( $jc_help_options[(Ie)${i}] )); then
+            _describe 'commands' jc_parsers_describe
+            return 0
+        fi
+    done
+
+    # if special options are found anywhere in the line, then no more completions
+    for i in ${words:0:-1}; do
+        if (( $jc_special_options[(Ie)${i}] )); then
+            return 0
+        fi
+    done
+
+    # if magic command is found anywhere in the line, use called command's autocompletion
+    for i in ${words:0:-1}; do
+        if (( $jc_commands[(Ie)${i}] )); then
+            # hack to remove options between jc and the magic command
+            shift $(( ${#words} - 2 )) words
+            words[1,0]=(jc)
+            CURRENT=${#words}
+
+            # run the magic command's completions
+            _arguments '*::arguments:_normal'
+            return 0
+        fi
+    done
+
+    # if "/pr[oc]" (magic for Procfile parsers) is in the current word, complete with files/directories in the path
+    if [[ "${words[-1]}" =~ "/pr" ]]; then
+        # run files completion
+        _files
+        return 0
+    fi
+
+    # if a parser arg is found anywhere in the line, only show options and help options
+    for i in ${words:0:-1}; do
+        if (( $jc_parsers[(Ie)${i}] )); then
+            _describe 'commands' jc_options_describe -- jc_help_options_describe
+            return 0
+        fi
+    done
+
+    # default completion
+    _describe 'commands' jc_options_describe -- jc_about_options_describe -- jc_help_options_describe -- jc_special_options_describe -- jc_parsers_describe -- jc_commands_describe
+}
+
+_jc
+

docgen.sh

@@ -1,56 +1,139 @@
 #!/bin/bash
 # Generate docs.md
+# requires pydoc-markdown 4.6.1
+
+# use ./docgen all to generate all docs
+
+readme_config=$(cat <<'EOF'
+{
+    "processors": [
+        {
+            "type": "filter"
+        },
+        {
+            "type": "pydocmd"
+        }
+    ],
+    "renderer": {
+        "type": "markdown",
+        "header_level_by_type": {
+            "Module": 1,
+            "Class": 3,
+            "Method": 3,
+            "Function": 3,
+            "Variable": 3
+        }
+    }
+}
+EOF
+)
+
+toc_config=$(cat <<'EOF'
+{
+    "processors": [
+        {
+            "type": "filter"
+        },
+        {
+            "type": "pydocmd"
+        }
+    ],
+    "renderer": {
+        "type": "markdown",
+        "render_toc": true,
+        "header_level_by_type": {
+            "Module": 1,
+            "Class": 3,
+            "Method": 3,
+            "Function": 3,
+            "Variable": 3
+        }
+    }
+}
+EOF
+)
+
+parser_config=$(cat <<'EOF'
+{
+    "processors": [
+        {
+            "type": "filter",
+            "expression": "not name == \"info\" and not name.startswith(\"_\") and default()"
+        },
+        {
+            "type": "pydocmd"
+        }
+    ],
+    "renderer": {
+        "type": "markdown",
+        "header_level_by_type": {
+            "Module": 1,
+            "Class": 3,
+            "Method": 3,
+            "Function": 3,
+            "Variable": 3
+        }
+    }
+}
+EOF
+)
 
 cd jc
-pydocmd simple jc+ > ../docs/readme.md
-pydocmd simple utils+ > ../docs/utils.md
-pydocmd simple jc.parsers.airport+ > ../docs/parsers/airport.md
-pydocmd simple jc.parsers.airport_s+ > ../docs/parsers/airport_s.md
-pydocmd simple jc.parsers.arp+ > ../docs/parsers/arp.md
-pydocmd simple jc.parsers.blkid+ > ../docs/parsers/blkid.md
-pydocmd simple jc.parsers.crontab+ > ../docs/parsers/crontab.md
-pydocmd simple jc.parsers.crontab_u+ > ../docs/parsers/crontab_u.md
-pydocmd simple jc.parsers.csv+ > ../docs/parsers/csv.md
-pydocmd simple jc.parsers.df+ > ../docs/parsers/df.md
-pydocmd simple jc.parsers.dig+ > ../docs/parsers/dig.md
-pydocmd simple jc.parsers.du+ > ../docs/parsers/du.md
-pydocmd simple jc.parsers.env+ > ../docs/parsers/env.md
-pydocmd simple jc.parsers.file+ > ../docs/parsers/file.md
-pydocmd simple jc.parsers.free+ > ../docs/parsers/free.md
-pydocmd simple jc.parsers.fstab+ > ../docs/parsers/fstab.md
-pydocmd simple jc.parsers.group+ > ../docs/parsers/group.md
-pydocmd simple jc.parsers.gshadow+ > ../docs/parsers/gshadow.md
-pydocmd simple jc.parsers.history+ > ../docs/parsers/history.md
-pydocmd simple jc.parsers.hosts+ > ../docs/parsers/hosts.md
-pydocmd simple jc.parsers.id+ > ../docs/parsers/id.md
-pydocmd simple jc.parsers.ifconfig+ > ../docs/parsers/ifconfig.md
-pydocmd simple jc.parsers.ini+ > ../docs/parsers/ini.md
-pydocmd simple jc.parsers.iptables+ > ../docs/parsers/iptables.md
-pydocmd simple jc.parsers.jobs+ > ../docs/parsers/jobs.md
-pydocmd simple jc.parsers.last+ > ../docs/parsers/last.md
-pydocmd simple jc.parsers.ls+ > ../docs/parsers/ls.md
-pydocmd simple jc.parsers.lsblk+ > ../docs/parsers/lsblk.md
-pydocmd simple jc.parsers.lsmod+ > ../docs/parsers/lsmod.md
-pydocmd simple jc.parsers.lsof+ > ../docs/parsers/lsof.md
-pydocmd simple jc.parsers.mount+ > ../docs/parsers/mount.md
-pydocmd simple jc.parsers.netstat+ > ../docs/parsers/netstat.md
-pydocmd simple jc.parsers.ntpq+ > ../docs/parsers/ntpq.md
-pydocmd simple jc.parsers.passwd+ > ../docs/parsers/passwd.md
-pydocmd simple jc.parsers.pip_list+ > ../docs/parsers/pip_list.md
-pydocmd simple jc.parsers.pip_show+ > ../docs/parsers/pip_show.md
-pydocmd simple jc.parsers.ps+ > ../docs/parsers/ps.md
-pydocmd simple jc.parsers.route+ > ../docs/parsers/route.md
-pydocmd simple jc.parsers.shadow+ > ../docs/parsers/shadow.md
-pydocmd simple jc.parsers.ss+ > ../docs/parsers/ss.md
-pydocmd simple jc.parsers.stat+ > ../docs/parsers/stat.md
-pydocmd simple jc.parsers.systemctl+ > ../docs/parsers/systemctl.md
-pydocmd simple jc.parsers.systemctl_lj+ > ../docs/parsers/systemctl_lj.md
-pydocmd simple jc.parsers.systemctl_ls+ > ../docs/parsers/systemctl_ls.md
-pydocmd simple jc.parsers.systemctl_luf+ > ../docs/parsers/systemctl_luf.md
-pydocmd simple jc.parsers.timedatectl+ > ../docs/parsers/timedatectl.md
-pydocmd simple jc.parsers.uname+ > ../docs/parsers/uname.md
-pydocmd simple jc.parsers.uptime+ > ../docs/parsers/uptime.md
-pydocmd simple jc.parsers.w+ > ../docs/parsers/w.md
-pydocmd simple jc.parsers.who+ > ../docs/parsers/who.md
-pydocmd simple jc.parsers.xml+ > ../docs/parsers/xml.md
-pydocmd simple jc.parsers.yaml+ > ../docs/parsers/yaml.md
+(
+    echo Building docs for: package
+    pydoc-markdown -m jc "${readme_config}" > ../docs/readme.md; echo "+++ package docs complete"
+) &
+
+(
+    echo Building docs for: lib
+    pydoc-markdown -m jc.lib "${toc_config}" > ../docs/lib.md; echo "+++ lib docs complete"
+) &
+
+(
+    echo Building docs for: utils
+    pydoc-markdown -m jc.utils "${toc_config}" > ../docs/utils.md; echo "+++ utils docs complete"
+) &
+
+(
+    echo Building docs for: streaming
+    pydoc-markdown -m jc.streaming "${toc_config}" > ../docs/streaming.md; echo "+++ streaming docs complete"
+) &
+
+(
+    echo Building docs for: universal parser
+    pydoc-markdown -m jc.parsers.universal "${toc_config}" > ../docs/parsers/universal.md; echo "+++ universal parser docs complete"
+) &
+
+# a bit of inception here... jc is being used to help
+# automate the generation of its own documentation. :)
+
+# pull jc parser objects into a bash array from jq
+# filter out any plugin parsers
+parsers=()
+while read -r value
+do
+    parsers+=("$value")
+done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)')
+
+for parser in "${parsers[@]}"; do
+    parser_name=$(jq -r '.name' <<< "$parser")
+        {
+            if [[ $1 == "all" ]] || ! git diff --quiet --exit-code HEAD~5 -- "parsers/${parser_name}.py"; then
+                compatible=$(jq -r '.compatible | join(", ")' <<< "$parser")
+                version=$(jq -r '.version' <<< "$parser")
+                author=$(jq -r '.author' <<< "$parser")
+                author_email=$(jq -r '.author_email' <<< "$parser")
+
+                echo "Building docs for: ${parser_name}"
+                echo "[Home](https://kellyjonbrazil.github.io/jc/)" > ../docs/parsers/"${parser_name}".md
+                pydoc-markdown -m jc.parsers."${parser_name}" "${parser_config}" >> ../docs/parsers/"${parser_name}".md
+                echo "### Parser Information" >> ../docs/parsers/"${parser_name}".md
+                echo "Compatibility:  ${compatible}" >> ../docs/parsers/"${parser_name}".md
+                echo >> ../docs/parsers/"${parser_name}".md
+                echo "Version ${version} by ${author} (${author_email})" >> ../docs/parsers/"${parser_name}".md
+                echo "+++ ${parser_name} docs complete"
+            fi
+        } &
+done
+wait
+echo "Document Generation Complete"

docs/lib.md

@@ -0,0 +1,215 @@
+# Table of Contents
+
+* [jc.lib](#jc.lib)
+  * [parse](#jc.lib.parse)
+  * [parser\_mod\_list](#jc.lib.parser_mod_list)
+  * [plugin\_parser\_mod\_list](#jc.lib.plugin_parser_mod_list)
+  * [standard\_parser\_mod\_list](#jc.lib.standard_parser_mod_list)
+  * [streaming\_parser\_mod\_list](#jc.lib.streaming_parser_mod_list)
+  * [parser\_info](#jc.lib.parser_info)
+  * [all\_parser\_info](#jc.lib.all_parser_info)
+  * [get\_help](#jc.lib.get_help)
+
+<a id="jc.lib"></a>
+
+# jc.lib
+
+jc - JSON Convert lib module
+
+<a id="jc.lib.parse"></a>
+
+### parse
+
+```python
+def parse(
+    parser_mod_name: Union[str, ModuleType],
+    data: Union[str, bytes, Iterable[str]],
+    quiet: bool = False,
+    raw: bool = False,
+    ignore_exceptions: bool = None,
+    **kwargs
+) -> Union[JSONDictType, List[JSONDictType], Iterator[JSONDictType]]
+```
+
+Parse the data (string or bytes) using the supplied parser (string or
+module object).
+
+This function provides a high-level API to simplify parser use. This
+function will call built-in parsers and custom plugin parsers.
+
+Example (standard parsers):
+
+    >>> import jc
+    >>> date_obj = jc.parse('date', 'Tue Jan 18 10:23:07 PST 2022')
+    >>> print(f'The year is: {date_obj["year"]}')
+    The year is: 2022
+
+Example (streaming parsers):
+
+    >>> import jc
+    >>> ping_gen = jc.parse('ping_s', ping_output.splitlines())
+    >>> for item in ping_gen:
+    >>>     print(f'Response time: {item["time_ms"]} ms')
+    Response time: 102 ms
+    Response time: 109 ms
+    ...
+
+To get a list of available parser module names, use `parser_mod_list()`.
+
+Alternatively, a parser module object can be supplied:
+
+    >>> import jc
+    >>> import jc.parsers.date as jc_date
+    >>> date_obj = jc.parse(jc_date, 'Tue Jan 18 10:23:07 PST 2022')
+    >>> print(f'The year is: {date_obj["year"]}')
+    The year is: 2022
+
+You can also use the lower-level parser modules directly:
+
+    >>> import jc.parsers.date
+    >>> jc.parsers.date.parse('Tue Jan 18 10:23:07 PST 2022')
+
+Though, accessing plugin parsers directly is a bit more cumbersome, so
+this higher-level API is recommended. Here is how you can access plugin
+parsers without this API:
+
+    >>> import os
+    >>> import sys
+    >>> import jc.appdirs
+    >>> data_dir = jc.appdirs.user_data_dir('jc', 'jc')
+    >>> local_parsers_dir = os.path.join(data_dir, 'jcparsers')
+    >>> sys.path.append(local_parsers_dir)
+    >>> import my_custom_parser
+    >>> my_custom_parser.parse('command_data')
+
+Parameters:
+
+    parser_mod_name:    (string or   name of the parser module. This
+                        Module)      function will accept module_name,
+                                     cli-name, and --argument-name
+                                     variants of the module name.
+
+                                     A Module object can also be passed
+                                     directly or via _get_parser()
+
+    data:               (string or   data to parse (string or bytes for
+                        bytes or     standard parsers, iterable of
+                        iterable)    strings for streaming parsers)
+
+    raw:                (boolean)    output preprocessed JSON if True
+
+    quiet:              (boolean)    suppress warning messages if True
+
+    ignore_exceptions:  (boolean)    ignore parsing exceptions if True
+                                     (streaming parsers only)
+
+Returns:
+
+    Standard Parsers:   Dictionary or List of Dictionaries
+    Streaming Parsers:  Generator Object containing Dictionaries
+
+<a id="jc.lib.parser_mod_list"></a>
+
+### parser\_mod\_list
+
+```python
+def parser_mod_list(show_hidden: bool = False,
+                    show_deprecated: bool = False) -> List[str]
+```
+
+Returns a list of all available parser module names.
+
+<a id="jc.lib.plugin_parser_mod_list"></a>
+
+### plugin\_parser\_mod\_list
+
+```python
+def plugin_parser_mod_list(show_hidden: bool = False,
+                           show_deprecated: bool = False) -> List[str]
+```
+
+Returns a list of plugin parser module names. This function is a
+subset of `parser_mod_list()`.
+
+<a id="jc.lib.standard_parser_mod_list"></a>
+
+### standard\_parser\_mod\_list
+
+```python
+def standard_parser_mod_list(show_hidden: bool = False,
+                             show_deprecated: bool = False) -> List[str]
+```
+
+Returns a list of standard parser module names. This function is a
+subset of `parser_mod_list()` and does not contain any streaming
+parsers.
+
+<a id="jc.lib.streaming_parser_mod_list"></a>
+
+### streaming\_parser\_mod\_list
+
+```python
+def streaming_parser_mod_list(show_hidden: bool = False,
+                              show_deprecated: bool = False) -> List[str]
+```
+
+Returns a list of streaming parser module names. This function is a
+subset of `parser_mod_list()`.
+
+<a id="jc.lib.parser_info"></a>
+
+### parser\_info
+
+```python
+def parser_info(parser_mod_name: Union[str, ModuleType],
+                documentation: bool = False) -> ParserInfoType
+```
+
+Returns a dictionary that includes the parser module metadata.
+
+Parameters:
+
+    parser_mod_name:    (string or   name of the parser module. This
+                        Module)      function will accept module_name,
+                                     cli-name, and --argument-name
+                                     variants of the module name as well
+                                     as a parser module object.
+
+    documentation:      (boolean)    include parser docstring if True
+
+<a id="jc.lib.all_parser_info"></a>
+
+### all\_parser\_info
+
+```python
+def all_parser_info(documentation: bool = False,
+                    show_hidden: bool = False,
+                    show_deprecated: bool = False) -> List[ParserInfoType]
+```
+
+Returns a list of dictionaries that includes metadata for all parser
+modules. By default only non-hidden, non-deprecated parsers are
+returned.
+
+Parameters:
+
+    documentation:      (boolean)    include parser docstrings if True
+    show_hidden:        (boolean)    also show parsers marked as hidden
+                                     in their info metadata.
+    show_deprecated:    (boolean)    also show parsers marked as
+                                     deprecated in their info metadata.
+
+<a id="jc.lib.get_help"></a>
+
+### get\_help
+
+```python
+def get_help(parser_mod_name: Union[str, ModuleType]) -> None
+```
+
+Show help screen for the selected parser.
+
+This function will accept **module_name**, **cli-name**, and
+**--argument-name** variants of the module name string as well as a
+parser module object.
+

docs/parsers/acpi.md

@@ -0,0 +1,253 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.acpi"></a>
+
+# jc.parsers.acpi
+
+jc - JSON Convert `acpi` command output parser
+
+Usage (cli):
+
+    $ acpi -V | jc --acpi
+
+or
+
+    $ jc acpi -V
+
+Usage (module):
+
+    import jc
+    result = jc.parse('acpi', acpi_command_output)
+
+Schema:
+
+    [
+      {
+        "type":                             string,
+        "id":                               integer,
+        "state":                            string,
+        "charge_percent":                   integer,
+        "until_charged":                    string,
+        "until_charged_hours":              integer,
+        "until_charged_minuts":             integer,
+        "until_charged_seconds":            integer,
+        "until_charged_total_seconds":      integer,
+        "charge_remaining":                 string,
+        "charge_remaining_hours":           integer,
+        "charge_remaining_minutes":         integer,
+        "charge_remaining_seconds":         integer,
+        "charge_remaining_total_seconds":   integer,
+        "design_capacity_mah":              integer,
+        "last_full_capacity":               integer,
+        "last_full_capacity_percent":       integer,
+        "on-line":                          boolean,
+        "mode":                             string,
+        "temperature":                      float,
+        "temperature_unit":                 string,
+        "trip_points": [
+          {
+            "id":                           integer,
+            "switches_to_mode":             string,
+            "temperature":                  float,
+            "temperature_unit":             string
+          }
+        ],
+        "messages": [
+                                            string
+        ]
+      }
+    ]
+
+Examples:
+
+    $ acpi -V | jc --acpi -p
+    [
+      {
+        "type": "Battery",
+        "id": 0,
+        "state": "Charging",
+        "charge_percent": 71,
+        "until_charged": "00:29:20",
+        "design_capacity_mah": 2110,
+        "last_full_capacity": 2271,
+        "last_full_capacity_percent": 100,
+        "until_charged_hours": 0,
+        "until_charged_minutes": 29,
+        "until_charged_seconds": 20,
+        "until_charged_total_seconds": 1760
+      },
+      {
+        "type": "Adapter",
+        "id": 0,
+        "on-line": true
+      },
+      {
+        "type": "Thermal",
+        "id": 0,
+        "mode": "ok",
+        "temperature": 46.0,
+        "temperature_unit": "C",
+        "trip_points": [
+          {
+            "id": 0,
+            "switches_to_mode": "critical",
+            "temperature": 127.0,
+            "temperature_unit": "C"
+          },
+          {
+            "id": 1,
+            "switches_to_mode": "hot",
+            "temperature": 127.0,
+            "temperature_unit": "C"
+          }
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": 0,
+        "messages": [
+          "Processor 0 of 10"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": 1,
+        "messages": [
+          "Processor 0 of 10"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": 2,
+        "messages": [
+          "x86_pkg_temp no state information available"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": 3,
+        "messages": [
+          "Processor 0 of 10"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": 4,
+        "messages": [
+          "intel_powerclamp no state information available"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": 5,
+        "messages": [
+          "Processor 0 of 10"
+        ]
+      }
+    ]
+
+    $ acpi -V | jc --acpi -p -r
+    [
+      {
+        "type": "Battery",
+        "id": "0",
+        "state": "Charging",
+        "charge_percent": "71",
+        "until_charged": "00:29:20",
+        "design_capacity_mah": "2110",
+        "last_full_capacity": "2271",
+        "last_full_capacity_percent": "100"
+      },
+      {
+        "type": "Adapter",
+        "id": "0",
+        "on-line": true
+      },
+      {
+        "type": "Thermal",
+        "id": "0",
+        "mode": "ok",
+        "temperature": "46.0",
+        "temperature_unit": "C",
+        "trip_points": [
+          {
+            "id": "0",
+            "switches_to_mode": "critical",
+            "temperature": "127.0",
+            "temperature_unit": "C"
+          },
+          {
+            "id": "1",
+            "switches_to_mode": "hot",
+            "temperature": "127.0",
+            "temperature_unit": "C"
+          }
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": "0",
+        "messages": [
+          "Processor 0 of 10"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": "1",
+        "messages": [
+          "Processor 0 of 10"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": "2",
+        "messages": [
+          "x86_pkg_temp no state information available"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": "3",
+        "messages": [
+          "Processor 0 of 10"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": "4",
+        "messages": [
+          "intel_powerclamp no state information available"
+        ]
+      },
+      {
+        "type": "Cooling",
+        "id": "5",
+        "messages": [
+          "Processor 0 of 10"
+        ]
+      }
+    ]
+
+<a id="jc.parsers.acpi.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/airport.md

@@ -1,16 +1,44 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.airport"></a>
+
 # jc.parsers.airport
-jc - JSON CLI output utility airport -I Parser
 
-Usage:
+jc - JSON Convert `airport -I` command output parser
 
-    specify --airport as the first argument if the piped input is coming from airport -I (OSX)
+The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 
-    This program can be found at:
-    /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
+Usage (cli):
 
-Compatibility:
+    $ airport -I | jc --airport
 
-    'darwin'
+or
+
+    $ jc airport -I
+
+Usage (module):
+
+    import jc
+    result = jc.parse('airport', airport_command_output)
+
+Schema:
+
+    {
+      "agrctlrssi":        integer,
+      "agrextrssi":        integer,
+      "agrctlnoise":       integer,
+      "agrextnoise":       integer,
+      "state":             string,
+      "op_mode":           string,
+      "lasttxrate":        integer,
+      "maxrate":           integer,
+      "lastassocstatus":   integer,
+      "802_11_auth":       string,
+      "link_auth":         string,
+      "bssid":             string,
+      "ssid":              string,
+      "mcs":               integer,
+      "channel":           string
+    }
 
 Examples:
 
@@ -52,47 +80,12 @@ Examples:
       "channel": "48,80"
     }
 
-## info
+<a id="jc.parsers.airport.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    Dictionary. Structured data with the following schema:
-
-    {
-      "agrctlrssi":        integer,
-      "agrextrssi":        integer,
-      "agrctlnoise":       integer,
-      "agrextnoise":       integer,
-      "state":             string,
-      "op_mode":           string,
-      "lasttxrate":        integer,
-      "maxrate":           integer,
-      "lastassocstatus":   integer,
-      "802_11_auth":       string,
-      "link_auth":         string,
-      "bssid":             string,
-      "ssid":              string,
-      "mcs":               integer,
-      "channel":           string
-    }
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -100,10 +93,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
     Dictionary. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  darwin
+
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/airport_s.md

@@ -1,16 +1,40 @@
-# jc.parsers.airport_s
-jc - JSON CLI output utility airport -s Parser
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.airport_s"></a>
 
-Usage:
+# jc.parsers.airport\_s
 
-    specify --airport as the first argument if the piped input is coming from airport -s (OSX)
+jc - JSON Convert `airport -s` command output parser
 
-    This program can be found at:
-    /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport
+The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 
-Compatibility:
+Usage (cli):
 
-    'darwin'
+    $ airport -s | jc --airport-s
+
+or
+
+    $ jc airport -s
+
+Usage (module):
+
+    import jc
+    result = jc.parse('airport_s', airport_s_command_output)
+
+Schema:
+
+    [
+      {
+        "ssid":         string,
+        "bssid":        string,
+        "rssi":         integer,
+        "channel":      string,
+        "ht":           boolean,
+        "cc":           string,
+        "security": [
+                        string,
+        ]
+      }
+    ]
 
 Examples:
 
@@ -84,42 +108,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.airport_s.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-    [
-      {
-        "ssid":      string,
-        "bssid":     string,
-        "rssi":      integer,
-        "channel":   string,
-        "ht":        boolean,
-        "cc":        string,
-        "security": [
-                     string,
-        ]
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -127,10 +121,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  darwin
+
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/arp.md

@@ -1,17 +1,39 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.arp"></a>
+
 # jc.parsers.arp
-jc - JSON CLI output utility arp Parser
 
-Usage:
+jc - JSON Convert `arp` command output parser
 
-    specify --arp as the first argument if the piped input is coming from:
+Supports `arp` and `arp -a` output.
 
-    arp
-      or
-    arp -a
+Usage (cli):
 
-Compatibility:
+    $ arp | jc --arp
 
-    'linux', 'aix', 'freebsd', 'darwin'
+or
+
+    $ jc arp
+
+Usage (module):
+
+    import jc
+    result = jc.parse('arp', arp_command_output)
+
+Schema:
+
+    [
+      {
+        "name":         string,
+        "address":      string,
+        "hwtype":       string,
+        "hwaddress":    string,
+        "flags_mask":   string,
+        "iface":        string,
+        "permanent":    boolean,
+        "expires":      integer
+      }
+    ]
 
 Examples:
 
@@ -59,6 +81,8 @@ Examples:
         "hwtype": "ether",
         "hwaddress": "00:50:56:f0:98:26",
         "iface": "ens33"
+        "permanent": false,
+        "expires": 1182
       },
       {
         "name": "gateway",
@@ -66,6 +90,8 @@ Examples:
         "hwtype": "ether",
         "hwaddress": "00:50:56:f7:4a:fc",
         "iface": "ens33"
+        "permanent": false,
+        "expires": 110
       }
     ]
 
@@ -77,6 +103,8 @@ Examples:
         "hwtype": "ether",
         "hwaddress": "00:50:56:fe:7a:b4",
         "iface": "ens33"
+        "permanent": false,
+        "expires": "1182"
       },
       {
         "name": "_gateway",
@@ -84,43 +112,17 @@ Examples:
         "hwtype": "ether",
         "hwaddress": "00:50:56:f7:4a:fc",
         "iface": "ens33"
+        "permanent": false,
+        "expires": "110"
       }
     ]
 
-## info
+<a id="jc.parsers.arp.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "name":       string,
-        "address":    string,
-        "hwtype":     string,
-        "hwaddress":  string,
-        "flags_mask": string,
-        "iface":      string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
 ```
 
 Main text parsing function
@@ -128,10 +130,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, aix, freebsd, darwin
+
+Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/asciitable.md

@@ -0,0 +1,147 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.asciitable"></a>
+
+# jc.parsers.asciitable
+
+jc - JSON Convert `asciitable` parser
+
+This parser converts ASCII and Unicode text tables with single-line rows.
+
+Column headers must be at least two spaces apart from each other and must
+be unique. For best results, column headers should be left-justified. If
+column separators are present, then non-left-justified headers will be fixed
+automatically.
+
+Row separators are optional and are ignored. Each non-row-separator line is
+considered a separate row in the table.
+
+For example:
+
+    ╒══════════╤═════════╤════════╕
+    │ foo      │ bar     │ baz    │
+    ╞══════════╪═════════╪════════╡
+    │ good day │         │ 12345  │
+    ├──────────┼─────────┼────────┤
+    │ hi there │ abc def │ 3.14   │
+    ╘══════════╧═════════╧════════╛
+
+or
+
+    +-----------------------------+
+    | foo        bar       baz    |
+    +-----------------------------+
+    | good day             12345  |
+    | hi there   abc def   3.14   |
+    +-----------------------------+
+
+or
+
+    | foo      | bar     | baz    |
+    |----------|---------|--------|
+    | good day |         | 12345  |
+    | hi there | abc def | 3.14   |
+
+or
+
+    foo        bar       baz
+    ---------  --------  ------
+    good day             12345
+    hi there   abc def   3.14
+
+or
+
+    foo        bar       baz
+    good day             12345
+    hi there   abc def   3.14
+
+etc...
+
+Headers (keys) are converted to snake-case. All values are returned as
+strings, except empty strings, which are converted to None/null.
+
+> Note: To preserve the case of the keys use the `-r` cli option or
+> `raw=True` argument in `parse()`.
+
+Usage (cli):
+
+    $ cat table.txt | jc --asciitable
+
+Usage (module):
+
+    import jc
+    result = jc.parse('asciitable', asciitable_string)
+
+Schema:
+
+    [
+      {
+        "column_name1":     string,    # empty string is null
+        "column_name2":     string     # empty string is null
+      }
+    ]
+
+Examples:
+
+    $ echo '
+    >     ╒══════════╤═════════╤════════╕
+    >     │ foo      │ bar     │ baz    │
+    >     ╞══════════╪═════════╪════════╡
+    >     │ good day │         │ 12345  │
+    >     ├──────────┼─────────┼────────┤
+    >     │ hi there │ abc def │ 3.14   │
+    >     ╘══════════╧═════════╧════════╛' | jc --asciitable -p
+    [
+      {
+        "foo": "good day",
+        "bar": null,
+        "baz": "12345"
+      },
+      {
+        "foo": "hi there",
+        "bar": "abc def",
+        "baz": "3.14"
+      }
+    ]
+
+    $ echo '
+    >     foo        bar       baz
+    >     ---------  --------  ------
+    >     good day             12345
+    >     hi there   abc def   3.14'  | jc --asciitable -p
+    [
+      {
+        "foo": "good day",
+        "bar": null,
+        "baz": "12345"
+      },
+      {
+        "foo": "hi there",
+        "bar": "abc def",
+        "baz": "3.14"
+      }
+    ]
+
+<a id="jc.parsers.asciitable.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/asciitable_m.md

@@ -0,0 +1,132 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.asciitable_m"></a>
+
+# jc.parsers.asciitable\_m
+
+jc - JSON Convert `asciitable-m` parser
+
+This parser converts various styles of ASCII and Unicode text tables with
+multi-line rows. Tables must have a header row and separator line between
+rows.
+
+For example:
+
+    ╒══════════╤═════════╤════════╕
+    │ foo      │ bar baz │ fiz    │
+    │          │         │ buz    │
+    ╞══════════╪═════════╪════════╡
+    │ good day │ 12345   │        │
+    │ mate     │         │        │
+    ├──────────┼─────────┼────────┤
+    │ hi there │ abc def │ 3.14   │
+    │          │         │        │
+    ╘══════════╧═════════╧════════╛
+
+Cells with multiple lines within rows will be joined with a newline
+character ('\\n').
+
+Headers (keys) are converted to snake-case and newlines between multi-line
+headers are joined with an underscore. All values are returned as strings,
+except empty strings, which are converted to None/null.
+
+> Note: To preserve the case of the keys use the `-r` cli option or
+> `raw=True` argument in `parse()`.
+
+> Note: table column separator characters (e.g. `|`) cannot be present
+> inside the cell data. If detected, a warning message will be printed to
+> `STDERR` and the line will be skipped. The warning message can be
+> suppressed by using the `-q` command option or by setting `quiet=True` in
+> `parse()`.
+
+Usage (cli):
+
+    $ cat table.txt | jc --asciitable-m
+
+Usage (module):
+
+    import jc
+    result = jc.parse('asciitable_m', asciitable-string)
+
+Schema:
+
+    [
+      {
+        "column_name1":     string,    # empty string is null
+        "column_name2":     string     # empty string is null
+      }
+    ]
+
+Examples:
+
+    $ echo '
+    > +----------+---------+--------+
+    > | foo      | bar     | baz    |
+    > |          |         | buz    |
+    > +==========+=========+========+
+    > | good day | 12345   |        |
+    > | mate     |         |        |
+    > +----------+---------+--------+
+    > | hi there | abc def | 3.14   |
+    > |          |         |        |
+    > +==========+=========+========+' | jc --asciitable-m -p
+    [
+      {
+        "foo": "good day\\nmate",
+        "bar": "12345",
+        "baz_buz": null
+      },
+      {
+        "foo": "hi there",
+        "bar": "abc def",
+        "baz_buz": "3.14"
+      }
+    ]
+
+    $ echo '
+    > ╒══════════╤═════════╤════════╕
+    > │ foo      │ bar     │ baz    │
+    > │          │         │ buz    │
+    > ╞══════════╪═════════╪════════╡
+    > │ good day │ 12345   │        │
+    > │ mate     │         │        │
+    > ├──────────┼─────────┼────────┤
+    > │ hi there │ abc def │ 3.14   │
+    > │          │         │        │
+    > ╘══════════╧═════════╧════════╛' | jc --asciitable-m -p
+    [
+      {
+        "foo": "good day\\nmate",
+        "bar": "12345",
+        "baz_buz": null
+      },
+      {
+        "foo": "hi there",
+        "bar": "abc def",
+        "baz_buz": "3.14"
+      }
+    ]
+
+<a id="jc.parsers.asciitable_m.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/blkid.md

@@ -1,99 +1,24 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.blkid"></a>
+
 # jc.parsers.blkid
-jc - JSON CLI output utility blkid Parser
 
-Usage:
+jc - JSON Convert `blkid` command output parser
 
-    specify --blkid as the first argument if the piped input is coming from blkid
+Usage (cli):
 
-Compatibility:
+    $ blkid | jc --blkid
 
-    'linux'
+or
 
-Examples:
+    $ jc blkid
 
-    $ blkid | jc --blkid -p
-    [
-      {
-        "device": "/dev/sda1",
-        "uuid": "05d927ab-5875-49e4-ada1-7f46cb32c932",
-        "type": "xfs"
-      },
-      {
-        "device": "/dev/sda2",
-        "uuid": "3klkIj-w1kk-DkJi-0XBJ-y3i7-i2Ac-vHqWBM",
-        "type": "LVM2_member"
-      },
-      {
-        "device": "/dev/mapper/centos-root",
-        "uuid": "07d718ff-950c-4e5b-98f0-42a1147c77d9",
-        "type": "xfs"
-      },
-      {
-        "device": "/dev/mapper/centos-swap",
-        "uuid": "615eb89a-bcbf-46fd-80e3-c483ff5c931f",
-        "type": "swap"
-      }
-    ]
+Usage (module):
 
-    $ sudo blkid -o udev -ip /dev/sda2 | jc --blkid -p
-    [
-      {
-        "id_fs_uuid": "3klkIj-w1kk-DkJi-0XBJ-y3i7-i2Ac-vHqWBM",
-        "id_fs_uuid_enc": "3klkIj-w1kk-DkJi-0XBJ-y3i7-i2Ac-vHqWBM",
-        "id_fs_version": "LVM2\x20001",
-        "id_fs_type": "LVM2_member",
-        "id_fs_usage": "raid",
-        "id_iolimit_minimum_io_size": 512,
-        "id_iolimit_physical_sector_size": 512,
-        "id_iolimit_logical_sector_size": 512,
-        "id_part_entry_scheme": "dos",
-        "id_part_entry_type": "0x8e",
-        "id_part_entry_number": 2,
-        "id_part_entry_offset": 2099200,
-        "id_part_entry_size": 39843840,
-        "id_part_entry_disk": "8:0"
-      }
-    ]
+    import jc
+    result = jc.parse('blkid', blkid_command_output)
 
-    $ sudo blkid -ip /dev/sda1 | jc --blkid -p -r
-    [
-      {
-        "devname": "/dev/sda1",
-        "uuid": "05d927bb-5875-49e3-ada1-7f46cb31c932",
-        "type": "xfs",
-        "usage": "filesystem",
-        "minimum_io_size": "512",
-        "physical_sector_size": "512",
-        "logical_sector_size": "512",
-        "part_entry_scheme": "dos",
-        "part_entry_type": "0x83",
-        "part_entry_flags": "0x80",
-        "part_entry_number": "1",
-        "part_entry_offset": "2048",
-        "part_entry_size": "2097152",
-        "part_entry_disk": "8:0"
-      }
-    ]
-
-## info
-```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
+Schema:
 
     [
       {
@@ -129,9 +54,78 @@ Returns:
       }
     ]
 
-## parse
+Examples:
+
+    $ blkid | jc --blkid -p
+    [
+      {
+        "device": "/dev/sda1",
+        "uuid": "05d927ab-5875-49e4-ada1-7f46cb32c932",
+        "type": "xfs"
+      },
+      {
+        "device": "/dev/sda2",
+        "uuid": "3klkIj-w1kk-DkJi-0XBJ-y3i7-i2Ac-vHqWBM",
+        "type": "LVM2_member"
+      },
+      {
+        "device": "/dev/mapper/centos-root",
+        "uuid": "07d718ff-950c-4e5b-98f0-42a1147c77d9",
+        "type": "xfs"
+      },
+      {
+        "device": "/dev/mapper/centos-swap",
+        "uuid": "615eb89a-bcbf-46fd-80e3-c483ff5c931f",
+        "type": "swap"
+      }
+    ]
+
+    $ sudo blkid -o udev -ip /dev/sda2 | jc --blkid -p
+    [
+      {
+        "id_fs_uuid": "3klkIj-w1kk-DkJi-0XBJ-y3i7-i2Ac-vHqWBM",
+        "id_fs_uuid_enc": "3klkIj-w1kk-DkJi-0XBJ-y3i7-i2Ac-vHqWBM",
+        "id_fs_version": "LVM2\\x20001",
+        "id_fs_type": "LVM2_member",
+        "id_fs_usage": "raid",
+        "id_iolimit_minimum_io_size": 512,
+        "id_iolimit_physical_sector_size": 512,
+        "id_iolimit_logical_sector_size": 512,
+        "id_part_entry_scheme": "dos",
+        "id_part_entry_type": "0x8e",
+        "id_part_entry_number": 2,
+        "id_part_entry_offset": 2099200,
+        "id_part_entry_size": 39843840,
+        "id_part_entry_disk": "8:0"
+      }
+    ]
+
+    $ sudo blkid -ip /dev/sda1 | jc --blkid -p -r
+    [
+      {
+        "devname": "/dev/sda1",
+        "uuid": "05d927bb-5875-49e3-ada1-7f46cb31c932",
+        "type": "xfs",
+        "usage": "filesystem",
+        "minimum_io_size": "512",
+        "physical_sector_size": "512",
+        "logical_sector_size": "512",
+        "part_entry_scheme": "dos",
+        "part_entry_type": "0x83",
+        "part_entry_flags": "0x80",
+        "part_entry_number": "1",
+        "part_entry_offset": "2048",
+        "part_entry_size": "2097152",
+        "part_entry_disk": "8:0"
+      }
+    ]
+
+<a id="jc.parsers.blkid.parse"></a>
+
+### parse
+
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -139,10 +133,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux
+
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/cef.md

@@ -0,0 +1,146 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.cef"></a>
+
+# jc.parsers.cef
+
+jc - JSON Convert CEF string parser
+
+This parser conforms to the Microfocus Arcsight CEF specification.
+
+This parser will accept a single CEF string or multiple CEF string lines.
+Any text before "CEF" will be ignored. Syslog and CEF escaped characters
+(`\\`, `\\"`, `\\]`, `\\|`, `\\=`, `\\%`, `\\#`, `\\n`, and `\\r`) are
+unescaped.
+
+Extended fields, as defined in the CEF specification, are relabeled
+and the values are converted to their respective types. Extra naive and
+UTC epoch timestamps are added where appropriate per the CEF specification.
+
+A warning message to `STDERR` will be printed if an unparsable line is found
+unless `--quiet` or `quiet=True` is used.
+
+To preserve escaping and original keynames and to prevent type conversions
+use the `--raw` CLI option or `raw=True` param in the `parse()` function.
+
+Usage (cli):
+
+    $ echo 'CEF:0|Vendor|Product|3.2.0|1|SYSTEM|1|... | jc --cef
+
+Usage (module):
+
+    import jc
+    result = jc.parse('cef', cef_string_output)
+
+Schema:
+
+See: https://www.microfocus.com/documentation/arcsight/arcsight-smartconnectors-8.3/cef-implementation-standard/Content/CEF/Chapter%201%20What%20is%20CEF.htm
+
+> Note: Special characters in key names will be converted to underscores.
+
+    [
+      {
+        "deviceVendor":                   string,
+        "deviceProduct":                  string,
+        "deviceVersion":                  string,
+        "deviceEventClassId":             string,
+        "deviceEventClassIdNum":          integer/null,
+        "name":                           string,
+        "agentSeverity":                  string/integer,
+        "agentSeverityString":            string,
+        "agentSeverityNum":               integer/null,
+        "CEFVersion":                     integer,
+        <extended fields>                 string/integer/float,  # [0]
+        <extended fields>"_epoch":        integer/null,  # [1]
+        <extended fields>"_epoch_utc":    integer/null,  # [2]
+        <custom fields>                   string,
+        "unparsable":                     string  # [3]
+      }
+    ]
+
+    [0] Will attempt to convert extended fields to the type specified in the
+        CEF specification. If conversion fails, then the field will remain
+        a string.
+    [1] Naive calculated epoch timestamp
+    [2] Timezone-aware calculated epoch timestamp. (UTC only) This value
+        will be null if a UTC timezone cannot be extracted from the original
+        timestamp string value.
+    [3] This field exists if the CEF line is not parsable. The value
+        is the original syslog line.
+
+Examples:
+
+    $ cat cef.log | jc --cef -p
+    [
+      {
+        "deviceVendor": "Trend Micro",
+        "deviceProduct": "Deep Security Agent",
+        "deviceVersion": "<DSA version>",
+        "deviceEventClassId": "4000000",
+        "name": "Eicar_test_file",
+        "agentSeverity": 6,
+        "CEFVersion": 0,
+        "dvchost": "hostname",
+        "string": "hello \"world\"!",
+        "start": "Nov 08 2020 12:30:00.111 UTC",
+        "start_epoch": 1604867400,
+        "start_epoch_utc": 1604838600,
+        "Host_ID": 1,
+        "Quarantine": 205,
+        "myDate": "Nov 08 2022 12:30:00.111",
+        "myDate_epoch": 1667939400,
+        "myDate_epoch_utc": null,
+        "myFloat": 3.14,
+        "deviceEventClassIdNum": 4000000,
+        "agentSeverityString": "Medium",
+        "agentSeverityNum": 6
+      }
+    ]
+
+    $ cat cef.log | jc --cef -p -r
+    [
+      {
+        "deviceVendor": "Trend Micro",
+        "deviceProduct": "Deep Security Agent",
+        "deviceVersion": "<DSA version>",
+        "deviceEventClassId": "4000000",
+        "name": "Eicar_test_file",
+        "agentSeverity": "6",
+        "CEFVersion": "0",
+        "cn1": "1",
+        "cn1Label": "Host ID",
+        "dvchost": "hostname",
+        "cn2": "205",
+        "cn2Label": "Quarantine",
+        "string": "hello \\\"world\\\"!",
+        "start": "Nov 08 2020 12:30:00.111 UTC",
+        "deviceCustomDate1": "Nov 08 2022 12:30:00.111",
+        "deviceCustomDate1Label": "myDate",
+        "cfp1": "3.14",
+        "cfp1Label": "myFloat"
+      }
+    ]
+
+<a id="jc.parsers.cef.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/cef_s.md

@@ -0,0 +1,124 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.cef_s"></a>
+
+# jc.parsers.cef\_s
+
+jc - JSON Convert CEF string output streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+This parser conforms to the Microfocus Arcsight CEF specification.
+
+This parser will accept a single CEF string or multiple CEF string lines.
+Any text before "CEF" will be ignored. Syslog and CEF escaped characters
+(`\\`, `\\"`, `\\]`, `\\|`, `\\=`, `\\%`, `\\#`, `\\n`, and `\\r`) are
+unescaped.
+
+Extended fields, as defined in the CEF specification, are relabeled
+and the values are converted to their respective types. Extra naive and
+UTC epoch timestamps are added where appropriate per the CEF specification.
+
+A warning message to `STDERR` will be printed if an unparsable line is found
+unless `--quiet` or `quiet=True` is used.
+
+To preserve escaping and original keynames and to prevent type conversions
+use the `--raw` CLI option or `raw=True` param in the `parse()` function.
+
+Usage (cli):
+
+    $ echo 'CEF:0|Vendor|Product|3.2.0|1|SYSTEM|1|... | jc --cef-s
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('cef_s', cef_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+See: https://www.microfocus.com/documentation/arcsight/arcsight-smartconnectors-8.3/cef-implementation-standard/Content/CEF/Chapter%201%20What%20is%20CEF.htm
+
+> Note: Special characters in key names will be converted to underscores.
+
+    {
+      "deviceVendor":                   string,
+      "deviceProduct":                  string,
+      "deviceVersion":                  string,
+      "deviceEventClassId":             string,
+      "deviceEventClassIdNum":          integer/null,
+      "name":                           string,
+      "agentSeverity":                  string/integer,
+      "agentSeverityString":            string,
+      "agentSeverityNum":               integer/null,
+      "CEFVersion":                     integer,
+      <extended fields>                 string/integer/float,  # [0]
+      <extended fields>"_epoch":        integer/null,  # [1]
+      <extended fields>"_epoch_utc":    integer/null,  # [2]
+      <custom fields>                   string,
+      "unparsable":                     string  # [3]
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":      boolean,     # false if error parsing
+        "error":        string,      # exists if "success" is false
+        "line":         string       # exists if "success" is false
+      }
+    }
+
+    [0] Will attempt to convert extended fields to the type specified in the
+        CEF specification. If conversion fails, then the field will remain
+        a string.
+    [1] Naive calculated epoch timestamp
+    [2] Timezone-aware calculated epoch timestamp. (UTC only) This value
+        will be null if a UTC timezone cannot be extracted from the original
+        timestamp string value.
+    [3] This field exists if the CEF line is not parsable. The value
+        is the original syslog line.
+
+Examples:
+
+    $ cat cef.log | jc --cef-s
+    {"deviceVendor":"Fortinet","deviceProduct":"FortiDeceptor","deviceV...}
+    {"deviceVendor":"Trend Micro","deviceProduct":"Deep Security Agent"...}
+    ...
+
+    $ cat cef.log | jc --cef-s -r
+    {"deviceVendor":"Fortinet","deviceProduct":"FortiDeceptor","deviceV...}
+    {"deviceVendor":"Trend Micro","deviceProduct":"Deep Security Agent"...}
+    ...
+
+<a id="jc.parsers.cef_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+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 iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/chage.md

@@ -0,0 +1,82 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.chage"></a>
+
+# jc.parsers.chage
+
+jc - JSON Convert `chage --list` command output parser
+
+Supports `chage -l <username>` or `chage --list <username>`
+
+Usage (cli):
+
+    $ chage -l johndoe | jc --chage
+
+or
+
+    $ jc chage -l johndoe
+
+Usage (module):
+
+    import jc
+    result = jc.parse('chage', chage_command_output)
+
+Schema:
+
+    {
+      "password_last_changed":                      string,
+      "password_expires":                           string,
+      "password_inactive":                          string,
+      "account_expires":                            string,
+      "min_days_between_password_change":           integer,
+      "max_days_between_password_change":           integer,
+      "warning_days_before_password_expires":       integer
+    }
+
+Examples:
+
+    $ chage --list joeuser | jc --chage -p
+    {
+      "password_last_changed": "never",
+      "password_expires": "never",
+      "password_inactive": "never",
+      "account_expires": "never",
+      "min_days_between_password_change": 0,
+      "max_days_between_password_change": 99999,
+      "warning_days_before_password_expires": 7
+    }
+
+    $ chage --list joeuser | jc --chage -p -r
+    {
+      "password_last_changed": "never",
+      "password_expires": "never",
+      "password_inactive": "never",
+      "account_expires": "never",
+      "min_days_between_password_change": "0",
+      "max_days_between_password_change": "99999",
+      "warning_days_before_password_expires": "7"
+    }
+
+<a id="jc.parsers.chage.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/cksum.md

@@ -0,0 +1,80 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.cksum"></a>
+
+# jc.parsers.cksum
+
+jc - JSON Convert `cksum` command output parser
+
+This parser works with the following checksum calculation utilities:
+- `sum`
+- `cksum`
+
+Usage (cli):
+
+    $ cksum file.txt | jc --cksum
+
+or
+
+    $ jc cksum file.txt
+
+Usage (module):
+
+    import jc
+    result = jc.parse('cksum', cksum_command_output)
+
+Schema:
+
+    [
+      {
+        "filename":     string,
+        "checksum":     integer,
+        "blocks":       integer
+      }
+    ]
+
+Examples:
+
+    $ cksum * | jc --cksum -p
+    [
+      {
+        "filename": "__init__.py",
+        "checksum": 4294967295,
+        "blocks": 0
+      },
+      {
+        "filename": "airport.py",
+        "checksum": 2208551092,
+        "blocks": 3745
+      },
+      {
+        "filename": "airport_s.py",
+        "checksum": 1113817598,
+        "blocks": 4572
+      },
+      ...
+    ]
+
+<a id="jc.parsers.cksum.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, aix, freebsd
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/crontab.md

@@ -1,13 +1,58 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.crontab"></a>
+
 # jc.parsers.crontab
-jc - JSON CLI output utility crontab command and file Parser
 
-Usage:
+jc - JSON Convert `crontab -l` command output and crontab
+file parser
 
-    specify --crontab as the first argument if the piped input is coming from crontab -l or a crontab file
+Supports `crontab -l` command output and crontab files.
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'darwin', 'aix', 'freebsd'
+    $ crontab -l | jc --crontab
+
+or
+
+    $ jc crontab -l
+
+Usage (module):
+
+    import jc
+    result = jc.parse('crontab', crontab_output)
+
+Schema:
+
+    {
+      "variables": [
+        {
+          "name":             string,
+          "value":            string
+        }
+      ],
+      "schedule": [
+        {
+          "occurrence"        string,
+          "minute": [
+                              string
+          ],
+          "hour": [
+                              string
+          ],
+          "day_of_month": [
+                              string
+          ],
+          "month": [
+                              string
+          ],
+          "day_of_week": [
+                              string
+          ],
+          "occurrence":       string,
+          "command":          string
+        }
+      ]
+    }
 
 Examples:
 
@@ -128,59 +173,12 @@ Examples:
       ]
     }
 
-## info
+<a id="jc.parsers.crontab.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    Dictionary. Structured data with the following schema:
-
-    {
-      "variables": [
-        "name":               string,
-        "value":              string
-      ],
-      "schedule": [
-        {
-          "occurrence"        string,
-          "minute": [
-                              string
-          ],
-          "hour": [
-                              string
-          ],
-          "day_of_month": [
-                              string
-          ],
-          "month": [
-                              string
-          ],
-          "day_of_week": [
-                              string
-          ],
-          "occurrence":       string,
-          "command":          string
-        }
-      ]
-    }
-
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -188,10 +186,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
     Dictionary. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, aix, freebsd
+
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/crontab_u.md

@@ -1,158 +1,31 @@
-# jc.parsers.crontab_u
-jc - JSON CLI output utility crontab file Parser
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.crontab_u"></a>
 
-Usage:
+# jc.parsers.crontab\_u
 
-    specify --crontab-u as the first argument if the piped input is coming from a crontab file with User specified
+jc - JSON Convert `crontab -l` command output and crontab
+file parser
 
-Compatibility:
+This version of the `crontab -l` parser supports output that contains user
+information for processes.
 
-    'linux', 'darwin', 'aix', 'freebsd'
+Usage (cli):
 
-Examples:
+    $ crontab -l | jc --crontab-u
 
-    $ cat /etc/crontab | jc --crontab-u -p
-    {
-      "variables": [
-        {
-          "name": "PATH",
-          "value": "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin"
-        },
-        {
-          "name": "SHELL",
-          "value": "/bin/sh"
-        }
-      ],
-      "schedule": [
-        {
-          "minute": [
-            "25"
-          ],
-          "hour": [
-            "6"
-          ],
-          "day_of_month": [
-            "*"
-          ],
-          "month": [
-            "*"
-          ],
-          "day_of_week": [
-            "*"
-          ],
-          "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily )"
-        },
-        {
-          "minute": [
-            "47"
-          ],
-          "hour": [
-            "6"
-          ],
-          "day_of_month": [
-            "*"
-          ],
-          "month": [
-            "*"
-          ],
-          "day_of_week": [
-            "7"
-          ],
-          "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )"
-        },
-        {
-          "minute": [
-            "52"
-          ],
-          "hour": [
-            "6"
-          ],
-          "day_of_month": [
-            "1"
-          ],
-          "month": [
-            "*"
-          ],
-          "day_of_week": [
-            "*"
-          ],
-          "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly )"
-        }
-      ]
-    }
+Usage (module):
 
-    $ cat /etc/crontab | jc --crontab-u -p -r
-    {
-      "variables": [
-        {
-          "name": "PATH",
-          "value": "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin"
-        },
-        {
-          "name": "SHELL",
-          "value": "/bin/sh"
-        }
-      ],
-      "schedule": [
-        {
-          "minute": "25",
-          "hour": "6",
-          "day_of_month": "*",
-          "month": "*",
-          "day_of_week": "*",
-          "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily )"
-        },
-        {
-          "minute": "47",
-          "hour": "6",
-          "day_of_month": "*",
-          "month": "*",
-          "day_of_week": "7",
-          "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )"
-        },
-        {
-          "minute": "52",
-          "hour": "6",
-          "day_of_month": "1",
-          "month": "*",
-          "day_of_week": "*",
-          "user": "root",
-          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly )"
-        }
-      ]
-    }
+    import jc
+    result = jc.parse('crontab_u', crontab_u_output)
 
-
-
-## info
-```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    Dictionary. Structured data with the following schema:
+Schema:
 
     {
       "variables": [
-        "name":               string,
-        "value":              string
+        {
+          "name":             string,
+          "value":            string
+        }
       ],
       "schedule": [
         {
@@ -179,10 +52,130 @@ Returns:
       ]
     }
 
+Examples:
+
+    $ cat /etc/crontab | jc --crontab-u -p
+    {
+      "variables": [
+        {
+          "name": "PATH",
+          "value": "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sb..."
+        },
+        {
+          "name": "SHELL",
+          "value": "/bin/sh"
+        }
+      ],
+      "schedule": [
+        {
+          "minute": [
+            "25"
+          ],
+          "hour": [
+            "6"
+          ],
+          "day_of_month": [
+            "*"
+          ],
+          "month": [
+            "*"
+          ],
+          "day_of_week": [
+            "*"
+          ],
+          "user": "root",
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
+        },
+        {
+          "minute": [
+            "47"
+          ],
+          "hour": [
+            "6"
+          ],
+          "day_of_month": [
+            "*"
+          ],
+          "month": [
+            "*"
+          ],
+          "day_of_week": [
+            "7"
+          ],
+          "user": "root",
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
+        },
+        {
+          "minute": [
+            "52"
+          ],
+          "hour": [
+            "6"
+          ],
+          "day_of_month": [
+            "1"
+          ],
+          "month": [
+            "*"
+          ],
+          "day_of_week": [
+            "*"
+          ],
+          "user": "root",
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
+        }
+      ]
+    }
+
+    $ cat /etc/crontab | jc --crontab-u -p -r
+    {
+      "variables": [
+        {
+          "name": "PATH",
+          "value": "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/..."
+        },
+        {
+          "name": "SHELL",
+          "value": "/bin/sh"
+        }
+      ],
+      "schedule": [
+        {
+          "minute": "25",
+          "hour": "6",
+          "day_of_month": "*",
+          "month": "*",
+          "day_of_week": "*",
+          "user": "root",
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
+        },
+        {
+          "minute": "47",
+          "hour": "6",
+          "day_of_month": "*",
+          "month": "*",
+          "day_of_week": "7",
+          "user": "root",
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
+        },
+        {
+          "minute": "52",
+          "hour": "6",
+          "day_of_month": "1",
+          "month": "*",
+          "day_of_week": "*",
+          "user": "root",
+          "command": "test -x /usr/sbin/anacron || ( cd / && run-parts ..."
+        }
+      ]
+    }
+
+<a id="jc.parsers.crontab_u.parse"></a>
+
+### parse
 
-## parse
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -190,10 +183,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
     Dictionary. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, aix, freebsd
+
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/csv.md

@@ -1,21 +1,39 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.csv"></a>
+
 # jc.parsers.csv
-jc - JSON CLI output utility csv Parser
 
-Usage:
+jc - JSON Convert `csv` file parser
 
-    specify --csv as the first argument if the piped input is coming from a csv file.
-    the csv parser will attempt to automatically detect the delimiter character.
-    if the delimiter cannot be detected it will default to comma.
-    the first row of the file must be a header row.
+The `csv` parser will attempt to automatically detect the delimiter
+character. If the delimiter cannot be detected it will default to comma.
+The first row of the file must be a header row.
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+    $ cat file.csv | jc --csv
+
+Usage (module):
+
+    import jc
+    result = jc.parse('csv', csv_output)
+
+Schema:
+
+CSV file converted to a Dictionary:
+https://docs.python.org/3/library/csv.html
+
+    [
+      {
+        "column_name1":     string,
+        "column_name2":     string
+      }
+    ]
 
 Examples:
 
     $ cat homes.csv
-    "Sell", "List", "Living", "Rooms", "Beds", "Baths", "Age", "Acres", "Taxes"
+    "Sell", "List", "Living", "Rooms", "Beds", "Baths", "Age", "Acres"...
     142, 160, 28, 10, 5, 3,  60, 0.28,  3167
     175, 180, 18,  8, 4, 1,  12, 0.43,  4033
     129, 132, 13,  6, 3, 1,  41, 0.33,  1471
@@ -59,36 +77,14 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.csv.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Each dictionary represents a row in the csv file:
-
-    [
-      {
-        csv file converted to a Dictionary
-        https://docs.python.org/3/library/csv.html
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data: Union[str, bytes],
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
 ```
 
 Main text parsing function
@@ -96,10 +92,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/csv_s.md

@@ -0,0 +1,89 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.csv_s"></a>
+
+# jc.parsers.csv\_s
+
+jc - JSON Convert `csv` file streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+The `csv` streaming parser will attempt to automatically detect the
+delimiter character. If the delimiter cannot be detected it will default
+to comma. The first row of the file must be a header row.
+
+> Note: The first 100 rows are read into memory to enable delimiter
+> detection, then the rest of the rows are loaded lazily.
+
+Usage (cli):
+
+    $ cat file.csv | jc --csv-s
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('csv_s', csv_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+CSV file converted to a Dictionary:
+https://docs.python.org/3/library/csv.html
+
+    {
+      "column_name1":     string,
+      "column_name2":     string,
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":        boolean,     # false if error parsing
+        "error":          string,      # exists if "success" is false
+        "line":           string       # exists if "success" is false
+      }
+    }
+
+Examples:
+
+    $ cat homes.csv
+    "Sell", "List", "Living", "Rooms", "Beds", "Baths", "Age", "Acres"...
+    142, 160, 28, 10, 5, 3,  60, 0.28,  3167
+    175, 180, 18,  8, 4, 1,  12, 0.43,  4033
+    129, 132, 13,  6, 3, 1,  41, 0.33,  1471
+    ...
+
+    $ cat homes.csv | jc --csv-s
+    {"Sell":"142","List":"160","Living":"28","Rooms":"10","Beds":"5"...}
+    {"Sell":"175","List":"180","Living":"18","Rooms":"8","Beds":"4"...}
+    {"Sell":"129","List":"132","Living":"13","Rooms":"6","Beds":"3"...}
+    ...
+
+<a id="jc.parsers.csv_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
+```
+
+Main text parsing generator function. Returns an iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/date.md

@@ -0,0 +1,103 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.date"></a>
+
+# jc.parsers.date
+
+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)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ date | jc --date
+
+or
+
+    $ jc date
+
+Usage (module):
+
+    import jc
+    result = jc.parse('date', date_command_output)
+
+Schema:
+
+    {
+      "year":               integer,
+      "month":              string,
+      "month_num":          integer,
+      "day":                integer,
+      "weekday":            string,
+      "weekday_num":        integer,
+      "hour":               integer,
+      "hour_24":            integer,
+      "minute":             integer,
+      "second":             integer,
+      "period":             string,
+      "timezone":           string,
+      "utc_offset":         string,      # null if timezone field is not UTC
+      "day_of_year":        integer,
+      "week_of_year":       integer,
+      "iso":                string,
+      "epoch":              integer,     # [0]
+      "epoch_utc":          integer,     # [1]
+      "timezone_aware":     boolean      # [2]
+    }
+
+    [0] naive timestamp
+    [1] timezone-aware timestamp. Only available if timezone field is UTC
+    [2] if true, all fields are correctly based on UTC
+
+Examples:
+
+    $ date | jc --date -p
+    {
+      "year": 2021,
+      "month": "Mar",
+      "month_num": 3,
+      "day": 25,
+      "weekday": "Thu",
+      "weekday_num": 4,
+      "hour": 2,
+      "hour_24": 2,
+      "minute": 2,
+      "second": 26,
+      "period": "AM",
+      "timezone": "UTC",
+      "utc_offset": "+0000",
+      "day_of_year": 84,
+      "week_of_year": 12,
+      "iso": "2021-03-25T02:02:26+00:00",
+      "epoch": 1616662946,
+      "epoch_utc": 1616637746,
+      "timezone_aware": true
+    }
+
+<a id="jc.parsers.date.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, freebsd
+
+Version 2.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/datetime_iso.md

@@ -0,0 +1,91 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.datetime_iso"></a>
+
+# jc.parsers.datetime\_iso
+
+jc - JSON Convert ISO 8601 Datetime string parser
+
+This parser supports standard ISO 8601 strings that include both date and
+time. If no timezone or offset information is available in the sring, then
+UTC timezone is used.
+
+Usage (cli):
+
+    $ echo "2022-07-20T14:52:45Z" | jc --iso-datetime
+
+Usage (module):
+
+    import jc
+    result = jc.parse('iso_datetime', iso_8601_string)
+
+Schema:
+
+    {
+      "year":               integer,
+      "month":              string,
+      "month_num":          integer,
+      "day":                integer,
+      "weekday":            string,
+      "weekday_num":        integer,
+      "hour":               integer,
+      "hour_24":            integer,
+      "minute":             integer,
+      "second":             integer,
+      "microsecond":        integer,
+      "period":             string,
+      "utc_offset":         string,
+      "day_of_year":        integer,
+      "week_of_year":       integer,
+      "iso":                string,
+      "timestamp":          integer  # [0]
+    }
+
+    [0] timezone aware UNIX timestamp expressed in UTC
+
+Examples:
+
+    $ echo "2022-07-20T14:52:45Z" | jc --iso-datetime -p
+    {
+      "year": 2022,
+      "month": "Jul",
+      "month_num": 7,
+      "day": 20,
+      "weekday": "Wed",
+      "weekday_num": 3,
+      "hour": 2,
+      "hour_24": 14,
+      "minute": 52,
+      "second": 45,
+      "microsecond": 0,
+      "period": "PM",
+      "utc_offset": "+0000",
+      "day_of_year": 201,
+      "week_of_year": 29,
+      "iso": "2022-07-20T14:52:45+00:00",
+      "timestamp": 1658328765
+    }
+
+<a id="jc.parsers.datetime_iso.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, aix, freebsd, darwin, win32, cygwin
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/df.md

@@ -1,13 +1,41 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.df"></a>
+
 # jc.parsers.df
-jc - JSON CLI output utility df Parser
 
-Usage:
+jc - JSON Convert `df` command output parser
 
-    specify --df as the first argument if the piped input is coming from df
+Usage (cli):
 
-Compatibility:
+    $ df | jc --df
 
-    'linux', 'darwin'
+or
+
+    $ jc df
+
+Usage (module):
+
+    import jc
+    result = jc.parse('df', df_command_output)
+
+Schema:
+
+    [
+      {
+        "filesystem":        string,
+        "size":              string,
+        "1k_blocks":         integer,
+        "512_blocks":        integer,
+        "used":              integer,
+        "available":         integer,
+        "capacity_percent":  integer,
+        "ifree":             integer,
+        "iused":             integer,
+        "use_percent":       integer,
+        "iused_percent":     integer,
+        "mounted_on":        string
+      }
+    ]
 
 Examples:
 
@@ -69,46 +97,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.df.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "filesystem":        string,
-        "size":              string,
-        "1k_blocks":         integer,
-        "512_blocks":        integer,
-        "used":              integer,
-        "available":         integer,
-        "capacity_percent":  integer,
-        "ifree":             integer,
-        "iused":             integer,
-        "use_percent":       integer,
-        "iused_percent":     integer,
-        "mounted_on":        string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -116,10 +110,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, freebsd
+
+Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dig.md

@@ -1,20 +1,119 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.dig"></a>
+
 # jc.parsers.dig
-jc - JSON CLI output utility dig Parser
 
-Usage:
+jc - JSON Convert `dig` command output parser
 
-    Specify --dig as the first argument if the piped input is coming from dig
+Options supported:
+- `+noall +answer` options are supported in cases where only the answer
+  information is desired.
+- `+axfr` option is supported on its own
 
-Compatibility:
+The `when_epoch` calculated timestamp field is naive. (i.e. based on the
+local time of the system the parser is run on)
 
-    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+The `when_epoch_utc` calculated timestamp field is timezone-aware and is
+only available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ dig example.com | jc --dig
+
+or
+
+    $ jc dig example.com
+
+Usage (module):
+
+    import jc
+    result = jc.parse('dig', dig_command_output)
+
+Schema:
+
+    [
+      {
+        "id":                   integer,
+        "opcode":               string,
+        "status":               string,
+        "flags": [
+                                string
+        ],
+        "query_num":            integer,
+        "answer_num":           integer,
+        "authority_num":        integer,
+        "additional_num":       integer,
+        "axfr": [
+          {
+            "name":             string,
+            "class":            string,
+            "type":             string,
+            "ttl":              integer,
+            "data":             string
+          }
+        ],
+        "opt_pseudosection": {
+          "edns": {
+            "version":          integer,
+            "flags": [
+                                string
+            ],
+            "udp":              integer
+          },
+          "cookie":             string
+        },
+        "question": {
+          "name":               string,
+          "class":              string,
+          "type":               string
+        },
+        "answer": [
+          {
+            "name":             string,
+            "class":            string,
+            "type":             string,
+            "ttl":              integer,
+            "data":             string
+          }
+        ],
+        "additional": [
+          {
+            "name":             string,
+            "class":            string,
+            "type":             string,
+            "ttl":              integer,
+            "data":             string
+          }
+        ],
+        "authority": [
+          {
+            "name":             string,
+            "class":            string,
+            "type":             string,
+            "ttl":              integer,
+            "data":             string
+          }
+        ],
+        "query_size":           integer,
+        "query_time":           integer,   # in msec
+        "server":               string,
+        "when":                 string,
+        "when_epoch":           integer,   # [0]
+        "when_epoch_utc":       integer,   # [1]
+        "rcvd":                 integer
+        "size":                 string
+      }
+    ]
+
+    [0] naive timestamp if "when" field is parsable, else null
+    [1] timezone aware timestamp availabe for UTC, else null
 
 Examples:
 
-    $ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p
+    $ dig example.com | jc --dig -p
     [
       {
-        "id": 34128,
+        "id": 2951,
         "opcode": "QUERY",
         "status": "NOERROR",
         "flags": [
@@ -23,117 +122,43 @@ Examples:
           "ra"
         ],
         "query_num": 1,
-        "answer_num": 4,
+        "answer_num": 1,
         "authority_num": 0,
         "additional_num": 1,
+        "opt_pseudosection": {
+          "edns": {
+            "version": 0,
+            "flags": [],
+            "udp": 4096
+          }
+        },
         "question": {
-          "name": "cnn.com.",
+          "name": "example.com.",
           "class": "IN",
           "type": "A"
         },
         "answer": [
           {
-            "name": "cnn.com.",
+            "name": "example.com.",
             "class": "IN",
             "type": "A",
-            "ttl": 60,
-            "data": "151.101.65.67"
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "A",
-            "ttl": 60,
-            "data": "151.101.193.67"
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "A",
-            "ttl": 60,
-            "data": "151.101.1.67"
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "A",
-            "ttl": 60,
-            "data": "151.101.129.67"
+            "ttl": 39302,
+            "data": "93.184.216.34"
           }
         ],
-        "query_time": 37,
-        "server": "2600",
-        "when": "Tue Nov 12 07:14:42 PST 2019",
-        "rcvd": 100
-      },
-      {
-        "id": 15273,
-        "opcode": "QUERY",
-        "status": "NOERROR",
-        "flags": [
-          "qr",
-          "aa",
-          "rd"
-        ],
-        "query_num": 1,
-        "answer_num": 1,
-        "authority_num": 4,
-        "additional_num": 1,
-        "question": {
-          "name": "www.cnn.com.",
-          "class": "IN",
-          "type": "A"
-        },
-        "answer": [
-          {
-            "name": "www.cnn.com.",
-            "class": "IN",
-            "type": "CNAME",
-            "ttl": 300,
-            "data": "turner-tls.map.fastly.net."
-          }
-        ],
-        "authority": [
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "NS",
-            "ttl": 3600,
-            "data": "ns-1086.awsdns-07.org."
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "NS",
-            "ttl": 3600,
-            "data": "ns-1630.awsdns-11.co.uk."
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "NS",
-            "ttl": 3600,
-            "data": "ns-47.awsdns-05.com."
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "NS",
-            "ttl": 3600,
-            "data": "ns-576.awsdns-08.net."
-          }
-        ],
-        "query_time": 23,
-        "server": "205.251.194.64#53(205.251.194.64)",
-        "when": "Tue Nov 12 07:14:42 PST 2019",
-        "rcvd": 212
+        "query_time": 49,
+        "server": "2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)",
+        "when": "Fri Apr 16 16:05:10 PDT 2021",
+        "rcvd": 56,
+        "when_epoch": 1618614310,
+        "when_epoch_utc": null
       }
     ]
 
     $ dig cnn.com www.cnn.com @205.251.194.64 | jc --dig -p -r
     [
       {
-        "id": "23843",
+        "id": "46052",
         "opcode": "QUERY",
         "status": "NOERROR",
         "flags": [
@@ -142,117 +167,41 @@ Examples:
           "ra"
         ],
         "query_num": "1",
-        "answer_num": "4",
+        "answer_num": "1",
         "authority_num": "0",
         "additional_num": "1",
+        "opt_pseudosection": {
+          "edns": {
+            "version": "0",
+            "flags": [],
+            "udp": "4096"
+          }
+        },
         "question": {
-          "name": "cnn.com.",
+          "name": "example.com.",
           "class": "IN",
           "type": "A"
         },
         "answer": [
           {
-            "name": "cnn.com.",
+            "name": "example.com.",
             "class": "IN",
             "type": "A",
-            "ttl": "30",
-            "data": "151.101.193.67"
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "A",
-            "ttl": "30",
-            "data": "151.101.1.67"
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "A",
-            "ttl": "30",
-            "data": "151.101.65.67"
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "A",
-            "ttl": "30",
-            "data": "151.101.129.67"
+            "ttl": "40426",
+            "data": "93.184.216.34"
           }
         ],
-        "query_time": "24 msec",
-        "server": "192.168.1.254#53(192.168.1.254)",
-        "when": "Tue Nov 12 07:16:19 PST 2019",
-        "rcvd": "100"
-      },
-      {
-        "id": "8266",
-        "opcode": "QUERY",
-        "status": "NOERROR",
-        "flags": [
-          "qr",
-          "aa",
-          "rd"
-        ],
-        "query_num": "1",
-        "answer_num": "1",
-        "authority_num": "4",
-        "additional_num": "1",
-        "question": {
-          "name": "www.cnn.com.",
-          "class": "IN",
-          "type": "A"
-        },
-        "answer": [
-          {
-            "name": "www.cnn.com.",
-            "class": "IN",
-            "type": "CNAME",
-            "ttl": "300",
-            "data": "turner-tls.map.fastly.net."
-          }
-        ],
-        "authority": [
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "NS",
-            "ttl": "3600",
-            "data": "ns-1086.awsdns-07.org."
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "NS",
-            "ttl": "3600",
-            "data": "ns-1630.awsdns-11.co.uk."
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "NS",
-            "ttl": "3600",
-            "data": "ns-47.awsdns-05.com."
-          },
-          {
-            "name": "cnn.com.",
-            "class": "IN",
-            "type": "NS",
-            "ttl": "3600",
-            "data": "ns-576.awsdns-08.net."
-          }
-        ],
-        "query_time": "26 msec",
-        "server": "205.251.194.64#53(205.251.194.64)",
-        "when": "Tue Nov 12 07:16:19 PST 2019",
-        "rcvd": "212"
+        "query_time": "48 msec",
+        "server": "2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)",
+        "when": "Fri Apr 16 16:06:12 PDT 2021",
+        "rcvd": "56"
       }
     ]
 
     $ dig -x 1.1.1.1 | jc --dig -p
     [
       {
-        "id": 34898,
+        "id": 20785,
         "opcode": "QUERY",
         "status": "NOERROR",
         "flags": [
@@ -264,6 +213,13 @@ Examples:
         "answer_num": 1,
         "authority_num": 0,
         "additional_num": 1,
+        "opt_pseudosection": {
+          "edns": {
+            "version": 0,
+            "flags": [],
+            "udp": 4096
+          }
+        },
         "question": {
           "name": "1.1.1.1.in-addr.arpa.",
           "class": "IN",
@@ -274,21 +230,23 @@ Examples:
             "name": "1.1.1.1.in-addr.arpa.",
             "class": "IN",
             "type": "PTR",
-            "ttl": 952,
+            "ttl": 1800,
             "data": "one.one.one.one."
           }
         ],
-        "query_time": 103,
-        "server": "2600",
-        "when": "Tue Nov 12 07:15:33 PST 2019",
-        "rcvd": 78
+        "query_time": 40,
+        "server": "2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)",
+        "when": "Sat Apr 17 14:50:50 PDT 2021",
+        "rcvd": 78,
+        "when_epoch": 1618696250,
+        "when_epoch_utc": null
       }
     ]
 
     $ dig -x 1.1.1.1 | jc --dig -p -r
     [
       {
-        "id": "50986",
+        "id": "32644",
         "opcode": "QUERY",
         "status": "NOERROR",
         "flags": [
@@ -300,6 +258,13 @@ Examples:
         "answer_num": "1",
         "authority_num": "0",
         "additional_num": "1",
+        "opt_pseudosection": {
+          "edns": {
+            "version": "0",
+            "flags": [],
+            "udp": "4096"
+          }
+        },
         "question": {
           "name": "1.1.1.1.in-addr.arpa.",
           "class": "IN",
@@ -314,88 +279,55 @@ Examples:
             "data": "one.one.one.one."
           }
         ],
-        "query_time": "38 msec",
-        "server": "2600",
-        "when": "Tue Nov 12 07:17:19 PST 2019",
+        "query_time": "52 msec",
+        "server": "2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1)",
+        "when": "Sat Apr 17 14:51:46 PDT 2021",
         "rcvd": "78"
       }
     ]
 
-## info
-```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
+    $ dig +noall +answer cnn.com | jc --dig -p
     [
       {
-        "id":             integer,
-        "opcode":         string,
-        "status":         string,
-        "flags": [
-                          string
-        ],
-        "query_num":      integer,
-        "answer_num":     integer,
-        "authority_num":  integer,
-        "additional_num": integer,
-        "axfr": [
-          {
-            "name":       string,
-            "class":      string,
-            "type":       string,
-            "ttl":        integer,
-            "data":       string
-          }
-        ],
-        "question": {
-          "name":         string,
-          "class":        string,
-          "type":         string
-        },
         "answer": [
           {
-            "name":       string,
-            "class":      string,
-            "type":       string,
-            "ttl":        integer,
-            "data":       string
-          }
-        ],
-        "authority": [
+            "name": "cnn.com.",
+            "class": "IN",
+            "type": "A",
+            "ttl": 60,
+            "data": "151.101.193.67"
+          },
           {
-            "name":       string,
-            "class":      string,
-            "type":       string,
-            "ttl":        integer,
-            "data":       string
+            "name": "cnn.com.",
+            "class": "IN",
+            "type": "A",
+            "ttl": 60,
+            "data": "151.101.65.67"
+          },
+          {
+            "name": "cnn.com.",
+            "class": "IN",
+            "type": "A",
+            "ttl": 60,
+            "data": "151.101.1.67"
+          },
+          {
+            "name": "cnn.com.",
+            "class": "IN",
+            "type": "A",
+            "ttl": 60,
+            "data": "151.101.129.67"
           }
-        ],
-        "query_time":     integer,   # in msec
-        "server":         string,
-        "when":           string,
-        "rcvd":           integer
-        "size":           string
+        ]
       }
     ]
 
-## parse
+<a id="jc.parsers.dig.parse"></a>
+
+### parse
+
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -403,10 +335,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, aix, freebsd, darwin, win32, cygwin
+
+Version 2.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dir.md

@@ -0,0 +1,146 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.dir"></a>
+
+# jc.parsers.dir
+
+jc - JSON Convert `dir` command output parser
+
+Options supported:
+- `/T timefield`
+- `/O sortorder`
+- `/C, /-C`
+- `/S`
+
+The "Magic" syntax is not supported since the `dir` command is a shell
+builtin.
+
+The `epoch` calculated timestamp field is naive. (i.e. based on the local
+time of the system the parser is run on)
+
+Usage (cli):
+
+    C:\> dir | jc --dir
+
+Usage (module):
+
+    import jc
+    result = jc.parse('dir', dir_command_output)
+
+Schema:
+
+    [
+      {
+        "date":         string,
+        "time":         string,
+        "epoch":        integer,    # naive timestamp
+        "dir":          boolean,
+        "size":         integer,
+        "filename:      string,
+        "parent":       string
+      }
+    ]
+
+Examples:
+
+    C:\> dir | jc --dir -p
+    [
+      {
+        "date": "03/24/2021",
+        "time": "03:15 PM",
+        "dir": true,
+        "size": null,
+        "filename": ".",
+        "parent": "C:\\Program Files\\Internet Explorer",
+        "epoch": 1616624100
+      },
+      {
+        "date": "03/24/2021",
+        "time": "03:15 PM",
+        "dir": true,
+        "size": null,
+        "filename": "..",
+        "parent": "C:\\Program Files\\Internet Explorer",
+        "epoch": 1616624100
+      },
+      {
+        "date": "12/07/2019",
+        "time": "02:49 AM",
+        "dir": true,
+        "size": null,
+        "filename": "en-US",
+        "parent": "C:\\Program Files\\Internet Explorer",
+        "epoch": 1575715740
+      },
+      {
+        "date": "12/07/2019",
+        "time": "02:09 AM",
+        "dir": false,
+        "size": 54784,
+        "filename": "ExtExport.exe",
+        "parent": "C:\\Program Files\\Internet Explorer",
+        "epoch": 1575713340
+      },
+      ...
+    ]
+
+    C:\> dir | jc --dir -p -r
+    [
+      {
+        "date": "03/24/2021",
+        "time": "03:15 PM",
+        "dir": true,
+        "size": null,
+        "filename": ".",
+        "parent": "C:\\Program Files\\Internet Explorer"
+      },
+      {
+        "date": "03/24/2021",
+        "time": "03:15 PM",
+        "dir": true,
+        "size": null,
+        "filename": "..",
+        "parent": "C:\\Program Files\\Internet Explorer"
+      },
+      {
+        "date": "12/07/2019",
+        "time": "02:49 AM",
+        "dir": true,
+        "size": null,
+        "filename": "en-US",
+        "parent": "C:\\Program Files\\Internet Explorer"
+      },
+      {
+        "date": "12/07/2019",
+        "time": "02:09 AM",
+        "dir": false,
+        "size": "54,784",
+        "filename": "ExtExport.exe",
+        "parent": "C:\\Program Files\\Internet Explorer"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.dir.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  win32
+
+Version 1.6 by Rasheed Elsaleh (rasheed@rebelliondefense.com)

docs/parsers/dmidecode.md

@@ -0,0 +1,151 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.dmidecode"></a>
+
+# jc.parsers.dmidecode
+
+jc - JSON Convert `dmidecode` command output parser
+
+Usage (cli):
+
+    $ dmidecode | jc --dmidecode
+
+or
+
+    $ jc dmidecode
+
+Usage (module):
+
+    import jc
+    result = jc.parse('dmidecode', dmidecode_command_output)
+
+Schema:
+
+    [
+      {
+        "handle":                      string,
+        "type":                        integer,
+        "bytes":                       integer,
+        "description":                 string,
+        "values": {                                 # null if empty
+          "lowercase_no_spaces_keys":  string,
+          "multiline_key_values": [
+                                       string,
+          ]
+        }
+      }
+    ]
+
+Examples:
+
+    # dmidecode | jc --dmidecode -p
+    [
+      {
+        "handle": "0x0000",
+        "type": 0,
+        "bytes": 24,
+        "description": "BIOS Information",
+        "values": {
+          "vendor": "Phoenix Technologies LTD",
+          "version": "6.00",
+          "release_date": "04/13/2018",
+          "address": "0xEA490",
+          "runtime_size": "88944 bytes",
+          "rom_size": "64 kB",
+          "characteristics": [
+            "ISA is supported",
+            "PCI is supported",
+            "PC Card (PCMCIA) is supported",
+            "PNP is supported",
+            "APM is supported",
+            "BIOS is upgradeable",
+            "BIOS shadowing is allowed",
+            "ESCD support is available",
+            "Boot from CD is supported",
+            "Selectable boot is supported",
+            "EDD is supported",
+            "Print screen service is supported (int 5h)",
+            "8042 keyboard services are supported (int 9h)",
+            "Serial services are supported (int 14h)",
+            "Printer services are supported (int 17h)",
+            "CGA/mono video services are supported (int 10h)",
+            "ACPI is supported",
+            "Smart battery is supported",
+            "BIOS boot specification is supported",
+            "Function key-initiated network boot is supported",
+            "Targeted content distribution is supported"
+          ],
+          "bios_revision": "4.6",
+          "firmware_revision": "0.0"
+        }
+      },
+      ...
+    ]
+
+    # dmidecode | jc --dmidecode -p -r
+    [
+      {
+        "handle": "0x0000",
+        "type": "0",
+        "bytes": "24",
+        "description": "BIOS Information",
+        "values": {
+          "vendor": "Phoenix Technologies LTD",
+          "version": "6.00",
+          "release_date": "04/13/2018",
+          "address": "0xEA490",
+          "runtime_size": "88944 bytes",
+          "rom_size": "64 kB",
+          "characteristics": [
+            "ISA is supported",
+            "PCI is supported",
+            "PC Card (PCMCIA) is supported",
+            "PNP is supported",
+            "APM is supported",
+            "BIOS is upgradeable",
+            "BIOS shadowing is allowed",
+            "ESCD support is available",
+            "Boot from CD is supported",
+            "Selectable boot is supported",
+            "EDD is supported",
+            "Print screen service is supported (int 5h)",
+            "8042 keyboard services are supported (int 9h)",
+            "Serial services are supported (int 14h)",
+            "Printer services are supported (int 17h)",
+            "CGA/mono video services are supported (int 10h)",
+            "ACPI is supported",
+            "Smart battery is supported",
+            "BIOS boot specification is supported",
+            "Function key-initiated network boot is supported",
+            "Targeted content distribution is supported"
+          ],
+          "bios_revision": "4.6",
+          "firmware_revision": "0.0"
+        }
+      },
+      ...
+    ]
+
+<a id="jc.parsers.dmidecode.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/dpkg_l.md

@@ -0,0 +1,157 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.dpkg_l"></a>
+
+# jc.parsers.dpkg\_l
+
+jc - JSON Convert `dpkg -l` command output parser
+
+Set the `COLUMNS` environment variable to a large value to avoid field
+truncation. For example:
+
+    $ COLUMNS=500 dpkg -l | jc --dpkg-l
+
+Usage (cli):
+
+    $ dpkg -l | jc --dpkg-l
+
+or
+
+    $ jc dpkg -l
+
+Usage (module):
+
+    import jc
+    result = jc.parse('dpkg_l', dpkg_command_output)
+
+Schema:
+
+    [
+      {
+        "codes":            string,
+        "name":             string,
+        "version":          string,
+        "architecture":     string,
+        "description":      string,
+        "desired":          string,
+        "status":           string,
+        "error":            string
+      }
+    ]
+
+Examples:
+
+    $ dpkg -l | jc --dpkg-l -p
+    [
+      {
+        "codes": "ii",
+        "name": "accountsservice",
+        "version": "0.6.45-1ubuntu1.3",
+        "architecture": "amd64",
+        "description": "query and manipulate user account information",
+        "desired": "install",
+        "status": "installed"
+      },
+      {
+        "codes": "rc",
+        "name": "acl",
+        "version": "2.2.52-3build1",
+        "architecture": "amd64",
+        "description": "Access control list utilities",
+        "desired": "remove",
+        "status": "config-files"
+      },
+      {
+        "codes": "uWR",
+        "name": "acpi",
+        "version": "1.7-1.1",
+        "architecture": "amd64",
+        "description": "displays information on ACPI devices",
+        "desired": "unknown",
+        "status": "trigger await",
+        "error": "reinstall required"
+      },
+      {
+        "codes": "rh",
+        "name": "acpid",
+        "version": "1:2.0.28-1ubuntu1",
+        "architecture": "amd64",
+        "description": "Advanced Configuration and Power Interface...",
+        "desired": "remove",
+        "status": "half installed"
+      },
+      {
+        "codes": "pn",
+        "name": "adduser",
+        "version": "3.116ubuntu1",
+        "architecture": "all",
+        "description": "add and remove users and groups",
+        "desired": "purge",
+        "status": "not installed"
+      },
+      ...
+    ]
+
+    $ dpkg -l | jc --dpkg-l -p -r
+    [
+      {
+        "codes": "ii",
+        "name": "accountsservice",
+        "version": "0.6.45-1ubuntu1.3",
+        "architecture": "amd64",
+        "description": "query and manipulate user account information"
+      },
+      {
+        "codes": "rc",
+        "name": "acl",
+        "version": "2.2.52-3build1",
+        "architecture": "amd64",
+        "description": "Access control list utilities"
+      },
+      {
+        "codes": "uWR",
+        "name": "acpi",
+        "version": "1.7-1.1",
+        "architecture": "amd64",
+        "description": "displays information on ACPI devices"
+      },
+      {
+        "codes": "rh",
+        "name": "acpid",
+        "version": "1:2.0.28-1ubuntu1",
+        "architecture": "amd64",
+        "description": "Advanced Configuration and Power Interface..."
+      },
+      {
+        "codes": "pn",
+        "name": "adduser",
+        "version": "3.116ubuntu1",
+        "architecture": "all",
+        "description": "add and remove users and groups"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.dpkg_l.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/du.md

@@ -1,13 +1,35 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.du"></a>
+
 # jc.parsers.du
-jc - JSON CLI output utility du Parser
 
-Usage:
+jc - JSON Convert `du` command output parser
 
-    specify --du as the first argument if the piped input is coming from du
+The `du -h` option is not supported with the default output. If you
+would like to use `du -h` or other options that change the output, be sure
+to use `jc --raw` (cli) or `raw=True` (module).
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'darwin', 'aix', 'freebsd'
+    $ du | jc --du
+
+or
+
+    $ jc du
+
+Usage (module):
+
+    import jc
+    result = jc.parse('du', du_command_output)
+
+Schema:
+
+    [
+      {
+        "size":     integer,
+        "name":     string
+      }
+    ]
 
 Examples:
 
@@ -19,23 +41,23 @@ Examples:
       },
       {
         "size": 56,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/_CodeSignature"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": 0,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr/local/standalone"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": 0,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr/local"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": 0,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": 1008,
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/dfu"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       ...
     ]
@@ -48,57 +70,33 @@ Examples:
       },
       {
         "size": "56",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/_CodeSignature"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": "0",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr/local/standalone"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": "0",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr/local"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": "0",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/usr"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       {
         "size": "1008",
-        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/Contents/Resources/Firmware/dfu"
+        "name": "/usr/standalone/firmware/iBridge1_1Customer.bundle/..."
       },
       ...
     ]
 
-## info
+<a id="jc.parsers.du.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "size":     integer,
-        "name":     string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -106,10 +104,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, aix, freebsd
+
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/email_address.md

@@ -0,0 +1,67 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.email_address"></a>
+
+# jc.parsers.email\_address
+
+jc - JSON Convert Email Address string parser
+
+Usage (cli):
+
+    $ echo "username@example.com" | jc --email-address
+
+Usage (module):
+
+    import jc
+    result = jc.parse('email_address', email_address_string)
+
+Schema:
+
+    {
+      "username":             string,
+      "domain":               string,
+      "local":                string,
+      "local_plus_suffix":    string or null
+    }
+
+Examples:
+
+    $ echo 'joe.user@gmail.com' | jc --email-address -p
+    {
+      "username": "joe.user",
+      "domain": "gmail.com",
+      "local": "joe.user",
+      "local_plus_suffix": null
+    }
+
+    $ echo 'joe.user+spam@gmail.com' | jc --email-address -p
+    {
+      "username": "joe.user",
+      "domain": "gmail.com",
+      "local": "joe.user+spam",
+      "local_plus_suffix": "spam"
+    }
+
+<a id="jc.parsers.email_address.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/env.md

@@ -1,13 +1,36 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.env"></a>
+
 # jc.parsers.env
-jc - JSON CLI output utility env Parser
 
-Usage:
+jc - JSON Convert `env` and `printenv` command output parser
 
-    specify --env as the first argument if the piped input is coming from env
+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
+`-r` command-line option or the `raw=True` argument in the `parse()`
+function.
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+    $ env | jc --env
+
+or
+
+    $ jc env
+
+Usage (module):
+
+    import jc
+    result = jc.parse('env', env_command_output)
+
+Schema:
+
+    [
+      {
+        "name":     string,
+        "value":    string
+      }
+    ]
 
 Examples:
 
@@ -49,36 +72,12 @@ Examples:
       "_": "/usr/bin/env"
     }
 
-## info
+<a id="jc.parsers.env.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "name":     string,
-        "value":    string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -86,11 +85,15 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
     Dictionary of raw structured data or
-    list of dictionaries of processed structured data
+    List of Dictionaries of processed structured data
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/file.md

@@ -1,13 +1,31 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.file"></a>
+
 # jc.parsers.file
-jc - JSON CLI output utility file command Parser
 
-Usage:
+jc - JSON Convert `file` command output parser
 
-    specify --file as the first argument if the piped input is coming from file.
+Usage (cli):
 
-Compatibility:
+    $ file * | jc --file
 
-    'linux', 'aix', 'freebsd', 'darwin'
+or
+
+    $ jc file *
+
+Usage (module):
+
+    import jc
+    result = jc.parse('file', file_command_output)
+
+Schema:
+
+    [
+      {
+        "filename":   string,
+        "type":       string
+      }
+    ]
 
 Examples:
 
@@ -35,45 +53,21 @@ Examples:
       },
       {
         "filename": "cd_catalog.xml",
-        "type": "XML 1.0 document text, ASCII text, with CRLF line terminators"
+        "type": "XML 1.0 document text, ASCII text, with CRLF line ..."
       },
       {
         "filename": "centosserial.sh",
-        "type": "Bourne-Again shell script text executable, UTF-8 Unicode text"
+        "type": "Bourne-Again shell script text executable, UTF-8 ..."
       },
       ...
     ]
 
-## info
+<a id="jc.parsers.file.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "filename":   string,
-        "type   ":    string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -81,10 +75,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, aix, freebsd, darwin
+
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/findmnt.md

@@ -0,0 +1,118 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.findmnt"></a>
+
+# jc.parsers.findmnt
+
+jc - JSON Convert `findmnt` command output parser
+
+Supports `-a`, `-l`, or no `findmnt` options.
+
+> Note: Newer versions of `findmnt` have a JSON output option.
+
+Usage (cli):
+
+    $ findmnt | jc --findmnt
+
+or
+
+    $ jc findmnt
+
+Usage (module):
+
+    import jc
+    result = jc.parse('findmnt', findmnt_command_output)
+
+Schema:
+
+    [
+      {
+        "target":                   string,
+        "source":                   string,
+        "fstype":                   string,
+        "options": [
+                                    string
+        ],
+        "kv_options": {
+          "<key_name>":             string
+        }
+    ]
+
+Examples:
+
+    $ findmnt | jc --findmnt -p
+    [
+      {
+        "target": "/",
+        "source": "/dev/mapper/centos-root",
+        "fstype": "xfs",
+        "options": [
+          "rw",
+          "relatime",
+          "seclabel",
+          "attr2",
+          "inode64",
+          "noquota"
+        ]
+      },
+      {
+        "target": "/sys/fs/cgroup",
+        "source": "tmpfs",
+        "fstype": "tmpfs",
+        "options": [
+          "ro",
+          "nosuid",
+          "nodev",
+          "noexec",
+          "seclabel"
+        ],
+        "kv_options": {
+          "mode": "755"
+        }
+      },
+      ...
+    ]
+
+
+    $ findmnt | jc --findmnt -p -r
+    [
+      {
+        "target": "/",
+        "source": "/dev/mapper/centos-root",
+        "fstype": "xfs",
+        "options": "rw,relatime,seclabel,attr2,inode64,noquota"
+      },
+      {
+        "target": "/sys/fs/cgroup",
+        "source": "tmpfs",
+        "fstype": "tmpfs",
+        "options": "ro,nosuid,nodev,noexec,seclabel,mode=755"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.findmnt.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/finger.md

@@ -0,0 +1,116 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.finger"></a>
+
+# jc.parsers.finger
+
+jc - JSON Convert `finger` command output parser
+
+Supports `-s` output option. Does not support the `-l` detail option.
+
+Usage (cli):
+
+    $ finger | jc --finger
+
+or
+
+    $ jc finger
+
+Usage (module):
+
+    import jc
+    result = jc.parse('finger', finger_command_output)
+
+Schema:
+
+    [
+      {
+        "login":                string,
+        "name":                 string,
+        "tty":                  string,
+        "idle":                 string,     # null if empty
+        "login_time":           string,
+        "details":              string,
+        "tty_writeable":        boolean,
+        "idle_minutes":         integer,
+        "idle_hours":           integer,
+        "idle_days":            integer,
+        "total_idle_minutes":   integer
+      }
+    ]
+
+Examples:
+
+    $ finger | jc --finger -p
+    [
+      {
+        "login": "jdoe",
+        "name": "John Doe",
+        "tty": "tty1",
+        "idle": "14d",
+        "login_time": "Mar 22 21:14",
+        "tty_writeable": false,
+        "idle_minutes": 0,
+        "idle_hours": 0,
+        "idle_days": 14,
+        "total_idle_minutes": 20160
+      },
+      {
+        "login": "jdoe",
+        "name": "John Doe",
+        "tty": "pts/0",
+        "idle": null,
+        "login_time": "Apr  5 15:33",
+        "details": "(192.168.1.22)",
+        "tty_writeable": true,
+        "idle_minutes": 0,
+        "idle_hours": 0,
+        "idle_days": 0,
+        "total_idle_minutes": 0
+      },
+      ...
+    ]
+
+    $ finger | jc --finger -p -r
+    [
+      {
+        "login": "jdoe",
+        "name": "John Doe",
+        "tty": "*tty1",
+        "idle": "14d",
+        "login_time": "Mar 22 21:14"
+      },
+      {
+        "login": "jdoe",
+        "name": "John Doe",
+        "tty": "pts/0",
+        "idle": null,
+        "login_time": "Apr  5 15:33",
+        "details": "(192.168.1.22)"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.finger.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, freebsd
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/free.md

@@ -1,13 +1,36 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.free"></a>
+
 # jc.parsers.free
-jc - JSON CLI output utility free Parser
 
-Usage:
+jc - JSON Convert `free` command output parser
 
-    specify --free as the first argument if the piped input is coming from free
+Usage (cli):
 
-Compatibility:
+    $ free | jc --free
 
-    'linux'
+or
+
+    $ jc free
+
+Usage (module):
+
+    import jc
+    result = jc.parse('free', free_command_output)
+
+Schema:
+
+    [
+      {
+        "type":         string,
+        "total":        integer,
+        "used":         integer,
+        "free":         integer,
+        "shared":       integer,
+        "buff_cache":   integer,
+        "available":    integer
+      }
+    ]
 
 Examples:
 
@@ -49,41 +72,12 @@ Examples:
       }
     ]
 
-## info
+<a id="jc.parsers.free.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "type":         string,
-        "total":        integer,
-        "used":         integer,
-        "free":         integer,
-        "shared":       integer,
-        "buff_cache":   integer,
-        "available":    integer
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -91,10 +85,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux
+
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/fstab.md

@@ -1,13 +1,31 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.fstab"></a>
+
 # jc.parsers.fstab
-jc - JSON CLI output utility fstab Parser
 
-Usage:
+jc - JSON Convert `fstab` file parser
 
-    specify --fstab as the first argument if the piped input is coming from a fstab file
+Usage (cli):
 
-Compatibility:
+    $ cat /etc/fstab | jc --fstab
 
-    'linux'
+Usage (module):
+
+    import jc
+    result = jc.parse('fstab', fstab_command_output)
+
+Schema:
+
+    [
+      {
+        "fs_spec":      string,
+        "fs_file":      string,
+        "fs_vfstype":   string,
+        "fs_mntops":    string,
+        "fs_freq":      integer,
+        "fs_passno":    integer
+      }
+    ]
 
 Examples:
 
@@ -67,40 +85,12 @@ Examples:
       }
     ]
 
-## info
+<a id="jc.parsers.fstab.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "fs_spec":      string,
-        "fs_file":      string,
-        "fs_vfstype":   string,
-        "fs_mntops":    string,
-        "fs_freq":      integer,
-        "fs_passno":    integer
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -108,10 +98,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, freebsd
+
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/git_log.md

@@ -0,0 +1,175 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.git_log"></a>
+
+# jc.parsers.git\_log
+
+jc - JSON Convert `git log` command output parser
+
+Can be used with the following format options:
+- `oneline`
+- `short`
+- `medium`
+- `full`
+- `fuller`
+
+Additional options supported:
+- `--stat`
+- `--shortstat`
+
+The `epoch` calculated timestamp field is naive. (i.e. based on the
+local time of the system the parser is run on)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is
+only available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ git log | jc --git-log
+
+or
+
+    $ jc git log
+
+Usage (module):
+
+    import jc
+    result = jc.parse('git_log', git_log_command_output)
+
+Schema:
+
+    [
+      {
+        "commit":               string,
+        "author":               string,
+        "author_email":         string,
+        "date":                 string,
+        "epoch":                integer,  # [0]
+        "epoch_utc":            integer,  # [1]
+        "commit_by":            string,
+        "commit_by_email":      string,
+        "commit_by_date":       string,
+        "message":              string,
+        "stats" : {
+          "files_changed":      integer,
+          "insertions":         integer,
+          "deletions":          integer,
+          "files": [
+                                string
+          ]
+        }
+      }
+    ]
+
+    [0] naive timestamp if "date" field is parsable, else null
+    [1] timezone aware timestamp availabe for UTC, else null
+
+Examples:
+
+    $ git log --stat | jc --git-log -p
+    [
+      {
+        "commit": "728d882ed007b3c8b785018874a0eb06e1143b66",
+        "author": "Kelly Brazil",
+        "author_email": "kellyjonbrazil@gmail.com",
+        "date": "Wed Apr 20 09:50:19 2022 -0400",
+        "stats": {
+          "files_changed": 2,
+          "insertions": 90,
+          "deletions": 12,
+          "files": [
+            "docs/parsers/git_log.md",
+            "jc/parsers/git_log.py"
+          ]
+        },
+        "message": "add timestamp docs and examples",
+        "epoch": 1650462619,
+        "epoch_utc": null
+      },
+      {
+        "commit": "b53e42aca623181aa9bc72194e6eeef1e9a3a237",
+        "author": "Kelly Brazil",
+        "author_email": "kellyjonbrazil@gmail.com",
+        "date": "Wed Apr 20 09:44:42 2022 -0400",
+        "stats": {
+          "files_changed": 5,
+          "insertions": 29,
+          "deletions": 6,
+          "files": [
+            "docs/parsers/git_log.md",
+            "docs/utils.md",
+            "jc/parsers/git_log.py",
+            "jc/utils.py",
+            "man/jc.1"
+          ]
+        },
+        "message": "add calculated timestamp",
+        "epoch": 1650462282,
+        "epoch_utc": null
+      },
+      ...
+    ]
+
+    $ git log --stat | jc --git-log -p -r
+    [
+      {
+        "commit": "728d882ed007b3c8b785018874a0eb06e1143b66",
+        "author": "Kelly Brazil",
+        "author_email": "kellyjonbrazil@gmail.com",
+        "date": "Wed Apr 20 09:50:19 2022 -0400",
+        "stats": {
+          "files_changed": "2",
+          "insertions": "90",
+          "deletions": "12",
+          "files": [
+            "docs/parsers/git_log.md",
+            "jc/parsers/git_log.py"
+          ]
+        },
+        "message": "add timestamp docs and examples"
+      },
+      {
+        "commit": "b53e42aca623181aa9bc72194e6eeef1e9a3a237",
+        "author": "Kelly Brazil",
+        "author_email": "kellyjonbrazil@gmail.com",
+        "date": "Wed Apr 20 09:44:42 2022 -0400",
+        "stats": {
+          "files_changed": "5",
+          "insertions": "29",
+          "deletions": "6",
+          "files": [
+            "docs/parsers/git_log.md",
+            "docs/utils.md",
+            "jc/parsers/git_log.py",
+            "jc/utils.py",
+            "man/jc.1"
+          ]
+        },
+        "message": "add calculated timestamp"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.git_log.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/git_log_s.md

@@ -0,0 +1,111 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.git_log_s"></a>
+
+# jc.parsers.git\_log\_s
+
+jc - JSON Convert `git log` command output streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+Can be used with the following format options:
+- `oneline`
+- `short`
+- `medium`
+- `full`
+- `fuller`
+
+Additional options supported:
+- `--stat`
+- `--shortstat`
+
+The `epoch` calculated timestamp field is naive. (i.e. based on the
+local time of the system the parser is run on)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is
+only available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ git log | jc --git-log-s
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('git_log_s', git_log_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "commit":               string,
+      "author":               string,
+      "author_email":         string,
+      "date":                 string,
+      "epoch":                integer,  # [0]
+      "epoch_utc":            integer,  # [1]
+      "commit_by":            string,
+      "commit_by_email":      string,
+      "commit_by_date":       string,
+      "message":              string,
+      "stats" : {
+        "files_changed":      integer,
+        "insertions":         integer,
+        "deletions":          integer,
+        "files": [
+                              string
+        ]
+      }
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":      boolean,     # false if error parsing
+        "error":        string,      # exists if "success" is false
+        "line":         string       # exists if "success" is false
+      }
+    }
+
+    [0] naive timestamp if "date" field is parsable, else null
+    [1] timezone aware timestamp availabe for UTC, else null
+
+Examples:
+
+    $ git log | jc --git-log-s
+    {"commit":"a730ae18c8e81c5261db132df73cd74f272a0a26","author":"Kelly...}
+    {"commit":"930bf439c06c48a952baec05a9896c8d92b7693e","author":"Kelly...}
+    ...
+
+<a id="jc.parsers.git_log_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+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 iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/git_ls_remote.md

@@ -0,0 +1,92 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.git_ls_remote"></a>
+
+# jc.parsers.git\_ls\_remote
+
+jc - JSON Convert `git ls-remote` command output parser
+
+This parser outputs two schemas:
+
+- Default: A single object with key/value pairs
+- Raw: An array of objects (`--raw` (cli) or `raw=True (module))
+
+See the Schema section for more details
+
+Usage (cli):
+
+    $ git ls-remote | jc --git-ls-remote
+
+or
+
+    $ jc git ls-remote
+
+Usage (module):
+
+    import jc
+    result = jc.parse('git_ls_remote', git_ls_remote_command_output)
+
+Schema:
+
+    Default:
+    {
+      <reference>:            string
+    }
+
+    Raw:
+    [
+      {
+        "reference":          string,
+        "commit":             string
+      }
+    ]
+
+Examples:
+
+    $ git ls-remote | jc --git-ls-remote -p
+    {
+      "HEAD": "214cd6b9e09603b3c4fa02203b24fb2bc3d4e338",
+      "refs/heads/dev": "b884f6aacca39e05994596d8fdfa7e7c4f1e0389",
+      "refs/heads/master": "214cd6b9e09603b3c4fa02203b24fb2bc3d4e338",
+      "refs/pull/1/head": "e416c77bed1267254da972b0f95b7ff1d43fccef",
+      ...
+    }
+
+    $ git ls-remote | jc --git-ls-remote -p -r
+    [
+      {
+        "reference": "HEAD",
+        "commit": "214cd6b9e09603b3c4fa02203b24fb2bc3d4e338"
+      },
+      {
+        "reference": "refs/heads/dev",
+        "commit": "b884f6aacca39e05994596d8fdfa7e7c4f1e0389"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.git_ls_remote.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary (default) or List of Dictionaries (raw)
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/gpg.md

@@ -0,0 +1,145 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.gpg"></a>
+
+# jc.parsers.gpg
+
+jc - JSON Convert `gpg --with-colons` command output parser
+
+Usage (cli):
+
+    $ gpg --with-colons --show-keys file.gpg | jc --gpg
+
+or
+
+    $ jc gpg --with-colons --show-keys file.gpg
+
+Usage (module):
+
+    import jc
+    result = jc.parse('gpg', gpg_command_output)
+
+Schema:
+
+Field definitions from https://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob_plain;f=doc/DETAILS
+
+> Note: Number values are not converted to integers because many field
+> specifications are overloaded and future augmentations are implied in the
+> documentation.
+
+    [
+      {
+        "type":                             string,
+        "validity":                         string,
+        "key_length":                       string,
+        "pub_key_alg":                      string,
+        "key_id":                           string,
+        "creation_date":                    string,
+        "expiration_date":                  string,
+        "certsn_uidhash_trustinfo":         string,
+        "owner_trust":                      string,
+        "user_id":                          string,
+        "signature_class":                  string,
+        "key_capabilities":                 string,
+        "cert_fingerprint_other":           string,
+        "flag":                             string,
+        "token_sn":                         string,
+        "hash_alg":                         string,
+        "curve_name":                       string,
+        "compliance_flags":                 string,
+        "last_update_date":                 string,
+        "origin":                           string,
+        "comment":                          string,
+        "index":                            string,  # [0]
+        "bits":                             string,  # [0]
+        "value":                            string,  # [0]
+        "version":                          string,  # [1], [4]
+        "signature_count":                  string,  # [1]
+        "encryption_count":                 string,  # [1]
+        "policy":                           string,  # [1]
+        "signature_first_seen":             string,  # [1]
+        "signature_most_recent_seen":       string,  # [1]
+        "encryption_first_done":            string,  # [1]
+        "encryption_most_recent_done":      string,  # [1]
+        "staleness_reason":                 string,  # [2]
+        "trust_model":                      string,  # [2]
+        "trust_db_created":                 string,  # [2]
+        "trust_db_expires":                 string,  # [2]
+        "marginally_trusted_users":         string,  # [2]
+        "completely_trusted_users":         string,  # [2]
+        "cert_chain_max_depth":             string,  # [2]
+        "subpacket_number":                 string,  # [3]
+        "hex_flags":                        string,  # [3]
+        "subpacket_length":                 string,  # [3]
+        "subpacket_data":                   string,  # [3]
+        "pubkey":                           string,  # [4]
+        "cipher":                           string,  # [4]
+        "digest":                           string,  # [4]
+        "compress":                         string,  # [4]
+        "group":                            string,  # [4]
+        "members":                          string,  # [4]
+        "curve_names":                      string,  # [4]
+      }
+    ]
+
+    All blank values are converted to null/None.
+
+    [0] for 'pkd' type
+    [1] for 'tfs' type
+    [2] for 'tru' type
+    [3] for 'skp' type
+    [4] for 'cfg' type
+
+Examples:
+
+    $ gpg --with-colons --show-keys file.gpg | jc --gpg -p
+    [
+      {
+        "type": "pub",
+        "validity": "f",
+        "key_length": "1024",
+        "pub_key_alg": "17",
+        "key_id": "6C7EE1B8621CC013",
+        "creation_date": "899817715",
+        "expiration_date": "1055898235",
+        "certsn_uidhash_trustinfo": null,
+        "owner_trust": "m",
+        "user_id": null,
+        "signature_class": null,
+        "key_capabilities": "scESC",
+        "cert_fingerprint_other": null,
+        "flag": null,
+        "token_sn": null,
+        "hash_alg": null,
+        "curve_name": null,
+        "compliance_flags": null,
+        "last_update_date": null,
+        "origin": null,
+        "comment": null
+      },
+      ...
+    ]
+
+<a id="jc.parsers.gpg.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/group.md

@@ -1,13 +1,31 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.group"></a>
+
 # jc.parsers.group
-jc - JSON CLI output utility /etc/group file Parser
 
-Usage:
+jc - JSON Convert `/etc/group` file parser
 
-    specify --group as the first argument if the piped input is coming from /etc/group
+Usage (cli):
 
-Compatibility:
+    $ cat /etc/group | jc --group
 
-    'linux', 'darwin', 'aix', 'freebsd'
+Usage (module):
+
+    import jc
+    result = jc.parse('group', group_file_output)
+
+Schema:
+
+    [
+      {
+        "group_name":    string,
+        "password":      string,
+        "gid":           integer,
+        "members": [
+                         string
+        ]
+      }
+    ]
 
 Examples:
 
@@ -91,40 +109,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.group.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "group_name":    string,
-        "password":      string,
-        "gid":           integer,
-        "members": [
-                         string
-        ]
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -132,10 +122,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, aix, freebsd
+
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/gshadow.md

@@ -1,13 +1,33 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.gshadow"></a>
+
 # jc.parsers.gshadow
-jc - JSON CLI output utility /etc/gshadow file Parser
 
-Usage:
+jc - JSON Convert `/etc/gshadow` file parser
 
-    specify --gshadow as the first argument if the piped input is coming from /etc/gshadow
+Usage (cli):
 
-Compatibility:
+    $ cat /etc/gshadow | jc --gshadow
 
-    'linux', 'aix', 'freebsd'
+Usage (module):
+
+    import jc
+    result = jc.parse('gshadow', gshadow_file_output)
+
+Schema:
+
+    [
+      {
+        "group_name":       string,
+        "password":         string,
+        "administrators": [
+                            string
+        ],
+        "members": [
+                            string
+        ]
+      }
+    ]
 
 Examples:
 
@@ -57,42 +77,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.gshadow.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "group_name":       string,
-        "password":         string,
-        "administrators": [
-                            string
-        ],
-        "members": [
-                            string
-        ]
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -100,10 +90,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, aix, freebsd
+
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hash.md

@@ -0,0 +1,63 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.hash"></a>
+
+# jc.parsers.hash
+
+jc - JSON Convert `hash` command output parser
+
+Usage (cli):
+
+    $ hash | jc --hash
+
+Usage (module):
+
+    import jc
+    result = jc.parse('hash', hash_command_output)
+
+Schema:
+
+    [
+      {
+        "command":       string,
+        "hits":          integer
+      }
+    ]
+
+Examples:
+
+    $ hash | jc --hash -p
+    [
+      {
+        "hits": 2,
+        "command": "/bin/cat"
+      },
+      {
+        "hits": 1,
+        "command": "/bin/ls"
+      }
+    ]
+
+<a id="jc.parsers.hash.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, aix, freebsd
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hashsum.md

@@ -0,0 +1,94 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.hashsum"></a>
+
+# jc.parsers.hashsum
+
+jc - JSON Convert `hash sum` command output parser
+
+This parser works with the following hash calculation utilities:
+- `md5`
+- `md5sum`
+- `shasum`
+- `sha1sum`
+- `sha224sum`
+- `sha256sum`
+- `sha384sum`
+- `sha512sum`
+
+Usage (cli):
+
+    $ md5sum file.txt | jc --hashsum
+
+or
+
+    $ jc md5sum file.txt
+
+Usage (module):
+
+    import jc
+    result = jc.parse('hashsum', md5sum_command_output)
+
+Schema:
+
+    [
+      {
+        "filename":     string,
+        "hash":         string,
+      }
+    ]
+
+Examples:
+
+    $ md5sum * | jc --hashsum -p
+    [
+      {
+        "filename": "devtoolset-3-gcc-4.9.2-6.el7.x86_64.rpm",
+        "hash": "65fc958c1add637ec23c4b137aecf3d3"
+      },
+      {
+        "filename": "digout",
+        "hash": "5b9312ee5aff080927753c63a347707d"
+      },
+      {
+        "filename": "dmidecode.out",
+        "hash": "716fd11c2ac00db109281f7110b8fb9d"
+      },
+      {
+        "filename": "file with spaces in the name",
+        "hash": "d41d8cd98f00b204e9800998ecf8427e"
+      },
+      {
+        "filename": "id-centos.out",
+        "hash": "4295be239a14ad77ef3253103de976d2"
+      },
+      {
+        "filename": "ifcfg.json",
+        "hash": "01fda0d9ba9a75618b072e64ff512b43"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.hashsum.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, aix, freebsd
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hciconfig.md

@@ -0,0 +1,343 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.hciconfig"></a>
+
+# jc.parsers.hciconfig
+
+jc - JSON Convert `hciconfig` command output parser
+
+Usage (cli):
+
+    $ hciconfig | jc --hciconfig
+
+or
+
+    $ jc hciconfig
+
+Usage (module):
+
+    import jc
+    result = jc.parse('hciconfig', hciconfig_command_output)
+
+Schema:
+
+    [
+      {
+        "device":               string,
+        "type":                 string,
+        "bus":                  string,
+        "bd_address":           string,
+        "acl_mtu":              integer,
+        "acl_mtu_packets":      integer,
+        "sco_mtu":              integer,
+        "sco_mtu_packets":      integer,
+        "state": [
+                                string
+        ],
+        "rx_bytes":             integer,
+        "rx_acl":               integer,
+        "rx_sco":               integer,
+        "rx_events":            integer,
+        "rx_errors":            integer,
+        "tx_bytes":             integer,
+        "tx_acl":               integer,
+        "tx_sco":               integer,
+        "tx_commands":          integer,
+        "tx_errors":            integer,
+        "features": [
+                                string
+        ],
+        "packet_type": [
+                                string
+        ],
+        "link_policy": [
+                                string
+        ],
+        "link_mode": [
+                                string
+        ],
+        "name":                 string,
+        "class":                string,
+        "service_classes": [
+                                string       # 'Unspecified' is null
+        ],
+        "device_class":         string,
+        "hci_version":          string,
+        "hci_revision":         string,
+        "lmp_version":          string,
+        "lmp_subversion":       string,
+        "manufacturer":         string
+      }
+    ]
+
+Examples:
+
+    $ hciconfig -a | jc --hciconfig -p
+    [
+      {
+        "device": "hci0",
+        "type": "Primary",
+        "bus": "USB",
+        "bd_address": "00:1A:7D:DA:71:13",
+        "acl_mtu": 310,
+        "acl_mtu_packets": 10,
+        "sco_mtu": 64,
+        "sco_mtu_packets": 8,
+        "state": [
+          "UP",
+          "RUNNING"
+        ],
+        "rx_bytes": 13905869,
+        "rx_acl": 0,
+        "rx_sco": 0,
+        "rx_events": 393300,
+        "rx_errors": 0,
+        "tx_bytes": 62629,
+        "tx_acl": 0,
+        "tx_sco": 0,
+        "tx_commands": 3893,
+        "tx_errors": 0,
+        "features": [
+          "0xff",
+          "0xff",
+          "0x8f",
+          "0xfe",
+          "0xdb",
+          "0xff",
+          "0x5b",
+          "0x87"
+        ],
+        "packet_type": [
+          "DM1",
+          "DM3",
+          "DM5",
+          "DH1",
+          "DH3",
+          "DH5",
+          "HV1",
+          "HV2",
+          "HV3"
+        ],
+        "link_policy": [
+          "RSWITCH",
+          "HOLD",
+          "SNIFF",
+          "PARK"
+        ],
+        "link_mode": [
+          "SLAVE",
+          "ACCEPT"
+        ],
+        "name": "CSR8510 A10",
+        "class": "0x000000",
+        "service_classes": null,
+        "device_class": "Miscellaneous",
+        "hci_version": "4.0 (0x6)",
+        "hci_revision": "0x22bb",
+        "lmp_version": "4.0 (0x6)",
+        "lmp_subversion": "0x22bb",
+        "manufacturer": "Cambridge Silicon Radio (10)"
+      },
+      {
+        "device": "hci1",
+        "type": "Primary",
+        "bus": "USB",
+        "bd_address": "00:1A:7D:DA:71:13",
+        "acl_mtu": 310,
+        "acl_mtu_packets": 10,
+        "sco_mtu": 64,
+        "sco_mtu_packets": 8,
+        "state": [
+          "DOWN"
+        ],
+        "rx_bytes": 4388363,
+        "rx_acl": 0,
+        "rx_sco": 0,
+        "rx_events": 122021,
+        "rx_errors": 0,
+        "tx_bytes": 52350,
+        "tx_acl": 0,
+        "tx_sco": 0,
+        "tx_commands": 3480,
+        "tx_errors": 2,
+        "features": [
+          "0xff",
+          "0xff",
+          "0x8f",
+          "0xfe",
+          "0xdb",
+          "0xff",
+          "0x5b",
+          "0x87"
+        ],
+        "packet_type": [
+          "DM1",
+          "DM3",
+          "DM5",
+          "DH1",
+          "DH3",
+          "DH5",
+          "HV1",
+          "HV2",
+          "HV3"
+        ],
+        "link_policy": [
+          "RSWITCH",
+          "HOLD",
+          "SNIFF",
+          "PARK"
+        ],
+        "link_mode": [
+          "SLAVE",
+          "ACCEPT"
+        ]
+      }
+    ]
+
+    $ hciconfig -a | jc --hciconfig -p -r
+    [
+      {
+        "device": "hci0",
+        "type": "Primary",
+        "bus": "USB",
+        "bd_address": "00:1A:7D:DA:71:13",
+        "acl_mtu": "310",
+        "acl_mtu_packets": "10",
+        "sco_mtu": "64",
+        "sco_mtu_packets": "8",
+        "state": [
+          "UP",
+          "RUNNING"
+        ],
+        "rx_bytes": "13905869",
+        "rx_acl": "0",
+        "rx_sco": "0",
+        "rx_events": "393300",
+        "rx_errors": "0",
+        "tx_bytes": "62629",
+        "tx_acl": "0",
+        "tx_sco": "0",
+        "tx_commands": "3893",
+        "tx_errors": "0",
+        "features": [
+          "0xff",
+          "0xff",
+          "0x8f",
+          "0xfe",
+          "0xdb",
+          "0xff",
+          "0x5b",
+          "0x87"
+        ],
+        "packet_type": [
+          "DM1",
+          "DM3",
+          "DM5",
+          "DH1",
+          "DH3",
+          "DH5",
+          "HV1",
+          "HV2",
+          "HV3"
+        ],
+        "link_policy": [
+          "RSWITCH",
+          "HOLD",
+          "SNIFF",
+          "PARK"
+        ],
+        "link_mode": [
+          "SLAVE",
+          "ACCEPT"
+        ],
+        "name": "CSR8510 A10",
+        "class": "0x000000",
+        "service_classes": [
+          "Unspecified"
+        ],
+        "device_class": "Miscellaneous",
+        "hci_version": "4.0 (0x6)",
+        "hci_revision": "0x22bb",
+        "lmp_version": "4.0 (0x6)",
+        "lmp_subversion": "0x22bb",
+        "manufacturer": "Cambridge Silicon Radio (10)"
+      },
+      {
+        "device": "hci1",
+        "type": "Primary",
+        "bus": "USB",
+        "bd_address": "00:1A:7D:DA:71:13",
+        "acl_mtu": "310",
+        "acl_mtu_packets": "10",
+        "sco_mtu": "64",
+        "sco_mtu_packets": "8",
+        "state": [
+          "DOWN"
+        ],
+        "rx_bytes": "4388363",
+        "rx_acl": "0",
+        "rx_sco": "0",
+        "rx_events": "122021",
+        "rx_errors": "0",
+        "tx_bytes": "52350",
+        "tx_acl": "0",
+        "tx_sco": "0",
+        "tx_commands": "3480",
+        "tx_errors": "2",
+        "features": [
+          "0xff",
+          "0xff",
+          "0x8f",
+          "0xfe",
+          "0xdb",
+          "0xff",
+          "0x5b",
+          "0x87"
+        ],
+        "packet_type": [
+          "DM1",
+          "DM3",
+          "DM5",
+          "DH1",
+          "DH3",
+          "DH5",
+          "HV1",
+          "HV2",
+          "HV3"
+        ],
+        "link_policy": [
+          "RSWITCH",
+          "HOLD",
+          "SNIFF",
+          "PARK"
+        ],
+        "link_mode": [
+          "SLAVE",
+          "ACCEPT"
+        ]
+      }
+    ]
+
+<a id="jc.parsers.hciconfig.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/history.md

@@ -1,13 +1,35 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.history"></a>
+
 # jc.parsers.history
-jc - JSON CLI output utility history Parser
 
-Usage:
+jc - JSON Convert `history` command output parser
 
-    specify --history as the first argument if the piped input is coming from history
+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
+`-r` command-line option or the `raw=True` argument in the `parse()`
+function.
 
-Compatibility:
+The "Magic" syntax is not supported since the `history` command is a shell
+builtin.
 
-    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+Usage (cli):
+
+    $ history | jc --history
+
+Usage (module):
+
+    import jc
+    result = jc.parse('history', history_command_output)
+
+Schema:
+
+    [
+      {
+        "line":     integer,
+        "command":  string
+      }
+    ]
 
 Examples:
 
@@ -23,7 +45,7 @@ Examples:
       },
       {
         "line": 120,
-        "command": "echo "hello""
+        "command": "echo \"hello\""
       },
       {
         "line": 121,
@@ -36,41 +58,17 @@ Examples:
     {
       "118": "sleep 100",
       "119": "ls /bin",
-      "120": "echo "hello"",
+      "120": "echo \"hello\"",
       "121": "docker images",
       ...
     }
 
-## info
+<a id="jc.parsers.history.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "line":     integer,
-        "command":  string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -78,11 +76,15 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
     Dictionary of raw structured data or
-    list of dictionaries of processed structured data
+    List of Dictionaries of processed structured data
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, aix, freebsd
+
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/hosts.md

@@ -1,13 +1,29 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.hosts"></a>
+
 # jc.parsers.hosts
-jc - JSON CLI output utility hosts Parser
 
-Usage:
+jc - JSON Convert `/etc/hosts` file parser
 
-    specify --hosts as the first argument if the piped input is coming from a hosts file
+Usage (cli):
 
-Compatibility:
+    $ cat /etc/hosts | jc --hosts
 
-    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+Usage (module):
+
+    import jc
+    result = jc.parse('hosts', hosts_file_output)
+
+Schema:
+
+    [
+      {
+        "ip":           string,
+        "hostname": [
+                        string
+        ]
+      }
+    ]
 
 Examples:
 
@@ -58,38 +74,12 @@ Examples:
       }
     ]
 
-## info
+<a id="jc.parsers.hosts.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "ip":           string,
-        "hostname": [
-                        string
-        ]
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -97,10 +87,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/id.md

@@ -1,13 +1,51 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.id"></a>
+
 # jc.parsers.id
-jc - JSON CLI output utility id Parser
 
-Usage:
+jc - JSON Convert `id` command output parser
 
-    specify --id as the first argument if the piped input is coming from id
+Usage (cli):
 
-Compatibility:
+    $ id | jc --id
 
-    'linux', 'darwin', 'aix', 'freebsd'
+or
+
+    $ jc id
+
+Usage (module):
+
+    import jc
+    result = jc.parse('id', id_command_output)
+
+Schema:
+
+    {
+      "uid": {
+        "id":       integer,
+        "name":     string
+      },
+      "gid": {
+        "id":       integer,
+        "name":     string
+      },
+      "groups": [
+        {
+          "id":     integer,
+          "name":   string
+        },
+        {
+          "id":     integer,
+          "name":   string
+        }
+      ],
+      "context": {
+        "user":     string,
+        "role":     string,
+        "type":     string,
+        "level":    string
+      }
+    }
 
 Examples:
 
@@ -67,56 +105,12 @@ Examples:
       }
     }
 
-## info
+<a id="jc.parsers.id.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    Dictionary. Structured data with the following schema:
-
-    {
-      "uid": {
-        "id":       integer,
-        "name":     string
-      },
-      "gid": {
-        "id":       integer,
-        "name":     string
-      },
-      "groups": [
-        {
-          "id":     integer,
-          "name":   string
-        },
-        {
-          "id":     integer,
-          "name":   string
-        }
-      ],
-      "context": {
-        "user":     string,
-        "role":     string,
-        "type":     string,
-        "level":    string
-      }
-    }
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -124,10 +118,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    Dictionary. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, aix, freebsd
+
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ifconfig.md

@@ -1,19 +1,108 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ifconfig"></a>
+
 # jc.parsers.ifconfig
-jc - JSON CLI output utility ifconfig Parser
 
-Usage:
+jc - JSON Convert `foo` command output parser
 
-    specify --ifconfig as the first argument if the piped input is coming from ifconfig
+No `ifconfig` options are supported.
 
-    no ifconfig options are supported.
+Consider using the `ip` command instead of `ifconfig` as it supports native
+JSON output.
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'aix', 'freebsd', 'darwin'
+    $ ifconfig | jc --ifconfig
+
+or
+
+    $ jc ifconfig
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ifconfig', ifconfig_command_output)
+
+Schema:
+
+    [
+      {
+        "name":                     string,
+        "type":                     string,
+        "metric":                   integer
+        "flags":                    integer,
+        "state": [
+                                    string
+        ],
+        "mtu":                      integer,
+        "mac_addr":                 string,
+        "ipv4_addr":                string,    # [0]
+        "ipv4_mask":                string,    # [0]
+        "ipv4_bcast":               string,    # [0]
+        "ipv6_addr":                string,    # [0]
+        "ipv6_mask":                integer,   # [0]
+        "ipv6_scope":               string,    # [0]
+        "ipv6_type":                string,    # [0]
+        "rx_packets":               integer,
+        "rx_bytes":                 integer,
+        "rx_errors":                integer,
+        "rx_dropped":               integer,
+        "rx_overruns":              integer,
+        "rx_frame":                 integer,
+        "tx_packets":               integer,
+        "tx_bytes":                 integer,
+        "tx_errors":                integer,
+        "tx_dropped":               integer,
+        "tx_overruns":              integer,
+        "tx_carrier":               integer,
+        "tx_collisions":            integer,
+        "options":                  string,
+        "options_flags": [
+                                    string
+        ],
+        "status":                   string,
+        "hw_address":               string,
+        "media":                    string,
+        "media_flags": [
+                                    string
+        ],
+        "nd6_options":              integer,
+        "nd6_flags": [
+                                    string
+        ],
+        "plugged":                  string,
+        "vendor":                   string,
+        "vendor_pn":                string,
+        "vendor_sn":                string,
+        "vendor_date":              string,
+        "module_temperature":       string,
+        "module_voltage":           string
+        "ipv4": [
+          {
+            "address":              string,
+            "mask":                 string,
+            "broadcast":            string
+          }
+        ],
+        "ipv6: [
+          {
+            "address":              string,
+            "mask":                 integer,
+            "scope":                string,
+            "type":                 string
+          }
+        ]
+      }
+    ]
+
+    [0] these fields only pick up the last IP address in the interface
+        output and are here for backwards compatibility. For information on
+        all IP addresses, use the `ipv4` and `ipv6` objects which contain an
+        array of IP address objects.
 
 Examples:
 
-    $ ifconfig | jc --ifconfig -p
+    $ ifconfig ens33 | jc --ifconfig -p
     [
       {
         "name": "ens33",
@@ -25,190 +114,103 @@ Examples:
           "MULTICAST"
         ],
         "mtu": 1500,
+        "type": "Ethernet",
+        "mac_addr": "00:0c:29:3b:58:0e",
         "ipv4_addr": "192.168.71.137",
         "ipv4_mask": "255.255.255.0",
         "ipv4_bcast": "192.168.71.255",
         "ipv6_addr": "fe80::c1cb:715d:bc3e:b8a0",
         "ipv6_mask": 64,
         "ipv6_scope": "0x20",
-        "mac_addr": "00:0c:29:3b:58:0e",
-        "type": "Ethernet",
+        "ipv6_type": "link",
+        "metric": null,
         "rx_packets": 8061,
-        "rx_bytes": 1514413,
         "rx_errors": 0,
         "rx_dropped": 0,
         "rx_overruns": 0,
         "rx_frame": 0,
         "tx_packets": 4502,
+        "tx_errors": 0,
+        "tx_dropped": 0,
+        "tx_overruns": 0,
+        "tx_carrier": 0,
+        "tx_collisions": 0,
+        "rx_bytes": 1514413,
         "tx_bytes": 866622,
-        "tx_errors": 0,
-        "tx_dropped": 0,
-        "tx_overruns": 0,
-        "tx_carrier": 0,
-        "tx_collisions": 0,
-        "metric": null
-      },
-      {
-        "name": "lo",
-        "flags": 73,
-        "state": [
-          "UP",
-          "LOOPBACK",
-          "RUNNING"
+        "ipv4": [
+          {
+            "address": "192.168.71.137",
+            "mask": "255.255.255.0",
+            "broadcast": "192.168.71.255"
+          }
         ],
-        "mtu": 65536,
-        "ipv4_addr": "127.0.0.1",
-        "ipv4_mask": "255.0.0.0",
-        "ipv4_bcast": null,
-        "ipv6_addr": "::1",
-        "ipv6_mask": 128,
-        "ipv6_scope": "0x10",
-        "mac_addr": null,
-        "type": "Local Loopback",
-        "rx_packets": 73,
-        "rx_bytes": 6009,
-        "rx_errors": 0,
-        "rx_dropped": 0,
-        "rx_overruns": 0,
-        "rx_frame": 0,
-        "tx_packets": 73,
-        "tx_bytes": 6009,
-        "tx_errors": 0,
-        "tx_dropped": 0,
-        "tx_overruns": 0,
-        "tx_carrier": 0,
-        "tx_collisions": 0,
-        "metric": null
+        "ipv6": [
+          {
+            "address": "fe80::c1cb:715d:bc3e:b8a0",
+            "mask": 64,
+            "scope": "0x20",
+            "type": "link"
+          }
+        ]
       }
     ]
 
-    $ ifconfig | jc --ifconfig -p -r
+    $ ifconfig ens33 | jc --ifconfig -p -r
     [
       {
         "name": "ens33",
         "flags": "4163",
         "state": "UP,BROADCAST,RUNNING,MULTICAST",
         "mtu": "1500",
+        "type": "Ethernet",
+        "mac_addr": "00:0c:29:3b:58:0e",
         "ipv4_addr": "192.168.71.137",
         "ipv4_mask": "255.255.255.0",
         "ipv4_bcast": "192.168.71.255",
         "ipv6_addr": "fe80::c1cb:715d:bc3e:b8a0",
         "ipv6_mask": "64",
         "ipv6_scope": "0x20",
-        "mac_addr": "00:0c:29:3b:58:0e",
-        "type": "Ethernet",
+        "ipv6_type": "link",
+        "metric": null,
         "rx_packets": "8061",
-        "rx_bytes": "1514413",
         "rx_errors": "0",
         "rx_dropped": "0",
         "rx_overruns": "0",
         "rx_frame": "0",
         "tx_packets": "4502",
+        "tx_errors": "0",
+        "tx_dropped": "0",
+        "tx_overruns": "0",
+        "tx_carrier": "0",
+        "tx_collisions": "0",
+        "rx_bytes": "1514413",
         "tx_bytes": "866622",
-        "tx_errors": "0",
-        "tx_dropped": "0",
-        "tx_overruns": "0",
-        "tx_carrier": "0",
-        "tx_collisions": "0",
-        "metric": null
-      },
-      {
-        "name": "lo",
-        "flags": "73",
-        "state": "UP,LOOPBACK,RUNNING",
-        "mtu": "65536",
-        "ipv4_addr": "127.0.0.1",
-        "ipv4_mask": "255.0.0.0",
-        "ipv4_bcast": null,
-        "ipv6_addr": "::1",
-        "ipv6_mask": "128",
-        "ipv6_scope": "0x10",
-        "mac_addr": null,
-        "type": "Local Loopback",
-        "rx_packets": "73",
-        "rx_bytes": "6009",
-        "rx_errors": "0",
-        "rx_dropped": "0",
-        "rx_overruns": "0",
-        "rx_frame": "0",
-        "tx_packets": "73",
-        "tx_bytes": "6009",
-        "tx_errors": "0",
-        "tx_dropped": "0",
-        "tx_overruns": "0",
-        "tx_carrier": "0",
-        "tx_collisions": "0",
-        "metric": null
-      }
-    ]
-
-## info
-```python
-info(self, /, *args, **kwargs)
-```
-
-## IfconfigParser
-```python
-IfconfigParser(self, console_output)
-```
-
-## InterfaceNotFound
-```python
-InterfaceNotFound(self, /, *args, **kwargs)
-```
-
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "name":             string,
-        "flags":            integer,
-        "state": [
-                            string
+        "ipv4": [
+          {
+            "address": "192.168.71.137",
+            "mask": "255.255.255.0",
+            "broadcast": "192.168.71.255"
+          }
         ],
-        "mtu":              integer,
-        "ipv4_addr":        string,
-        "ipv4_mask":        string,
-        "ipv4_bcast":       string,
-        "ipv6_addr":        string,
-        "ipv6_mask":        integer,
-        "ipv6_scope":       string,
-        "mac_addr":         string,
-        "type":             string,
-        "rx_packets":       integer,
-        "rx_bytes":         integer,
-        "rx_errors":        integer,
-        "rx_dropped":       integer,
-        "rx_overruns":      integer,
-        "rx_frame":         integer,
-        "tx_packets":       integer,
-        "tx_bytes":         integer,
-        "tx_errors":        integer,
-        "tx_dropped":       integer,
-        "tx_overruns":      integer,
-        "tx_carrier":       integer,
-        "tx_collisions":    integer,
-        "metric":           integer
+        "ipv6": [
+          {
+            "address": "fe80::c1cb:715d:bc3e:b8a0",
+            "mask": "64",
+            "scope": "0x20",
+            "type": "link"
+          }
+        ]
       }
     ]
 
-## parse
+<a id="jc.parsers.ifconfig.parse"></a>
+
+### parse
+
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
 ```
 
 Main text parsing function
@@ -216,10 +218,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, aix, freebsd, darwin
+
+Version 2.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ini.md

@@ -1,13 +1,39 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ini"></a>
+
 # jc.parsers.ini
-jc - JSON CLI output utility INI Parser
 
-Usage:
+jc - JSON Convert `INI` file parser
 
-    specify --ini as the first argument if the piped input is coming from an INI file
+Parses standard `INI` files and files containing simple key/value pairs.
 
-Compatibility:
+- Delimiter can be `=` or `:`. Missing values are supported.
+- Comment prefix can be `#` or `;`. Comments must be on their own line.
+- If duplicate keys are found, only the last value will be used.
 
-    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+> Note: Values starting and ending with double or single quotation marks
+> will have the marks removed. If you would like to keep the quotation
+> marks, use the `-r` command-line argument or the `raw=True` argument in
+> `parse()`.
+
+Usage (cli):
+
+    $ cat foo.ini | jc --ini
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ini', ini_file_output)
+
+Schema:
+
+ini or key/value document converted to a dictionary - see the configparser
+standard library documentation for more details.
+
+    {
+      "key1":       string,
+      "key2":       string
+    }
 
 Examples:
 
@@ -28,49 +54,27 @@ Examples:
     $ cat example.ini | jc --ini -p
     {
       "bitbucket.org": {
-        "serveraliveinterval": "45",
-        "compression": "yes",
-        "compressionlevel": "9",
-        "forwardx11": "yes",
-        "user": "hg"
+        "ServerAliveInterval": "45",
+        "Compression": "yes",
+        "CompressionLevel": "9",
+        "ForwardX11": "yes",
+        "User": "hg"
       },
       "topsecret.server.com": {
-        "serveraliveinterval": "45",
-        "compression": "yes",
-        "compressionlevel": "9",
-        "forwardx11": "no",
-        "port": "50022"
+        "ServerAliveInterval": "45",
+        "Compression": "yes",
+        "CompressionLevel": "9",
+        "ForwardX11": "no",
+        "Port": "50022"
       }
     }
 
-## info
+<a id="jc.parsers.ini.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    Dictionary representing an ini document:
-
-    {
-      ini document converted to a dictionary
-      see configparser standard library documentation for more details
-    }
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -78,10 +82,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
     Dictionary representing the ini file
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iostat.md

@@ -0,0 +1,185 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iostat"></a>
+
+# jc.parsers.iostat
+
+jc - JSON Convert `iostat` command output parser
+
+> Note: `iostat` version 11 and higher include a JSON output option
+
+Usage (cli):
+
+    $ iostat | jc --iostat
+
+or
+
+    $ jc iostat
+
+Usage (module):
+
+    import jc
+    result = jc.parse('iostat', iostat_command_output)
+
+Schema:
+
+    [
+      {
+        "type":             string,
+        "percent_user":     float,
+        "percent_nice":     float,
+        "percent_system":   float,
+        "percent_iowait":   float,
+        "percent_steal":    float,
+        "percent_idle":     float,
+        "device":           string,
+        "tps":              float,
+        "kb_read_s":        float,
+        "mb_read_s":        float,
+        "kb_wrtn_s":        float,
+        "mb_wrtn_s":        float,
+        "kb_read":          integer,
+        "mb_read":          integer,
+        "kb_wrtn":          integer,
+        "mb_wrtn":          integer,
+        'kb_dscd':          integer,
+        'mb_dscd':          integer,
+        "rrqm_s":           float,
+        "wrqm_s":           float,
+        "r_s":              float,
+        "w_s":              float,
+        "rmb_s":            float,
+        "rkb_s":            float,
+        "wmb_s":            float,
+        "wkb_s":            float,
+        "avgrq_sz":         float,
+        "avgqu_sz":         float,
+        "await":            float,
+        "r_await":          float,
+        "w_await":          float,
+        "svctm":            float,
+        "aqu_sz":           float,
+        "rareq_sz":         float,
+        "wareq_sz":         float,
+        "d_s":              float,
+        "dkb_s":            float,
+        "dmb_s":            float,
+        "drqm_s":           float,
+        "percent_drqm":     float,
+        "d_await":          float,
+        "dareq_sz":         float,
+        "f_s":              float,
+        "f_await":          float,
+        "kb_dscd_s":        float,
+        "mb_dscd_s":        float,
+        "percent_util":     float,
+        "percent_rrqm":     float,
+        "percent_wrqm":     float
+      }
+    ]
+
+Examples:
+
+    $ iostat | jc --iostat -p
+    [
+      {
+          "percent_user": 0.15,
+          "percent_nice": 0.0,
+          "percent_system": 0.18,
+          "percent_iowait": 0.0,
+          "percent_steal": 0.0,
+          "percent_idle": 99.67,
+          "type": "cpu"
+      },
+      {
+          "device": "sda",
+          "tps": 0.29,
+          "kb_read_s": 7.22,
+          "kb_wrtn_s": 1.25,
+          "kb_read": 194341,
+          "kb_wrtn": 33590,
+          "type": "device"
+      },
+      {
+          "device": "dm-0",
+          "tps": 0.29,
+          "kb_read_s": 5.99,
+          "kb_wrtn_s": 1.17,
+          "kb_read": 161361,
+          "kb_wrtn": 31522,
+          "type": "device"
+      },
+      {
+          "device": "dm-1",
+          "tps": 0.0,
+          "kb_read_s": 0.08,
+          "kb_wrtn_s": 0.0,
+          "kb_read": 2204,
+          "kb_wrtn": 0,
+          "type": "device"
+      }
+    ]
+
+    $ iostat | jc --iostat -p -r
+    [
+      {
+        "percent_user": "0.15",
+        "percent_nice": "0.00",
+        "percent_system": "0.18",
+        "percent_iowait": "0.00",
+        "percent_steal": "0.00",
+        "percent_idle": "99.67",
+        "type": "cpu"
+      },
+      {
+        "device": "sda",
+        "tps": "0.29",
+        "kb_read_s": "7.22",
+        "kb_wrtn_s": "1.25",
+        "kb_read": "194341",
+        "kb_wrtn": "33590",
+        "type": "device"
+      },
+      {
+        "device": "dm-0",
+        "tps": "0.29",
+        "kb_read_s": "5.99",
+        "kb_wrtn_s": "1.17",
+        "kb_read": "161361",
+        "kb_wrtn": "31522",
+        "type": "device"
+      },
+      {
+        "device": "dm-1",
+        "tps": "0.00",
+        "kb_read_s": "0.08",
+        "kb_wrtn_s": "0.00",
+        "kb_read": "2204",
+        "kb_wrtn": "0",
+        "type": "device"
+      }
+    ]
+
+<a id="jc.parsers.iostat.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iostat_s.md

@@ -0,0 +1,133 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iostat_s"></a>
+
+# jc.parsers.iostat\_s
+
+jc - JSON Convert `iostat` command output streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+> Note: `iostat` version 11 and higher include a JSON output option
+
+Usage (cli):
+
+    $ iostat | jc --iostat-s
+
+> Note: When piping `jc` converted `iostat` output to other processes it may
+> appear the output is hanging due to the OS pipe buffers. This is because
+> `iostat` output is too small to quickly fill up the buffer. Use the `-u`
+> option to unbuffer the `jc` output if you would like immediate output. See
+> the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
+> for more information.
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('iostat_s', iostat_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "type":             string,
+      "percent_user":     float,
+      "percent_nice":     float,
+      "percent_system":   float,
+      "percent_iowait":   float,
+      "percent_steal":    float,
+      "percent_idle":     float,
+      "device":           string,
+      "tps":              float,
+      "kb_read_s":        float,
+      "mb_read_s":        float,
+      "kb_wrtn_s":        float,
+      "mb_wrtn_s":        float,
+      "kb_read":          integer,
+      "mb_read":          integer,
+      "kb_wrtn":          integer,
+      "mb_wrtn":          integer,
+      'kb_dscd':          integer,
+      'mb_dscd':          integer,
+      "rrqm_s":           float,
+      "wrqm_s":           float,
+      "r_s":              float,
+      "w_s":              float,
+      "rmb_s":            float,
+      "rkb_s":            float,
+      "wmb_s":            float,
+      "wkb_s":            float,
+      "avgrq_sz":         float,
+      "avgqu_sz":         float,
+      "await":            float,
+      "r_await":          float,
+      "w_await":          float,
+      "svctm":            float,
+      "aqu_sz":           float,
+      "rareq_sz":         float,
+      "wareq_sz":         float,
+      "d_s":              float,
+      "dkb_s":            float,
+      "dmb_s":            float,
+      "drqm_s":           float,
+      "percent_drqm":     float,
+      "d_await":          float,
+      "dareq_sz":         float,
+      "f_s":              float,
+      "f_await":          float,
+      "kb_dscd_s":        float,
+      "mb_dscd_s":        float,
+      "percent_util":     float,
+      "percent_rrqm":     float,
+      "percent_wrqm":     float,
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":        boolean,     # false if error parsing
+        "error":          string,      # exists if "success" is false
+        "line":           string       # exists if "success" is false
+      }
+    }
+
+Examples:
+
+    $ iostat | jc --iostat-s
+    {"percent_user":0.14,"percent_nice":0.0,"percent_system":0.16,...}
+    {"device":"sda","tps":0.24,"kb_read_s":5.28,"kb_wrtn_s":1.1...}
+    ...
+
+    $ iostat | jc --iostat-s -r
+    {"percent_user":"0.14","percent_nice":"0.00","percent_system":"0.16"...}
+    {"device":"sda","tps":"0.24","kb_read_s":"5.28","kb_wrtn_s":"1.10"...}
+    ...
+
+<a id="jc.parsers.iostat_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
+```
+
+Main text parsing generator function. Returns an iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ip_address.md

@@ -0,0 +1,555 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ip_address"></a>
+
+# jc.parsers.ip\_address
+
+jc - JSON Convert IP Address string parser
+
+Accepts standard and integer IP address notation for both IPv4 and IPv6
+addresses. CIDR subnet mask and Scope ID is also allowed for standard
+notation. See examples below.
+
+Usage (cli):
+
+    $ echo '192.168.1.1' | jc --ip-address
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ip_address', ip_address_string)
+
+Schema:
+
+    {
+      "version":                  integer,
+      "max_prefix_length":        integer,
+      "ip":                       string,
+      "ip_compressed":            string,
+      "ip_exploded":              string,
+      "ip_split": [
+                                  string
+      ],
+      "scope_id":                 string/null,
+      "ipv4_mapped":              string/null,
+      "six_to_four":              string/null,
+      "teredo_client":            string/null,
+      "teredo_server":            string/null,
+      "dns_ptr":                  string,
+      "network":                  string,
+      "broadcast":                string,
+      "hostmask":                 string,
+      "netmask":                  string,
+      "cidr_netmask":             integer,
+      "hosts":                    integer,
+      "first_host":               string,
+      "last_host":                string,
+      "is_multicast":             boolean,
+      "is_private":               boolean,
+      "is_global":                boolean,
+      "is_link_local":            boolean,
+      "is_loopback":              boolean,
+      "is_reserved":              boolean,
+      "is_unspecified":           boolean,
+      "int": {
+        "ip":                     integer,
+        "network":                integer,
+        "broadcast":              integer,
+        "first_host":             integer,
+        "last_host":              integer
+      },
+      "hex": {
+        "ip":                     string,
+        "network":                string,
+        "broadcast":              string,
+        "hostmask":               string,
+        "netmask":                string,
+        "first_host":             string,
+        "last_host":              string
+      },
+      "bin": {
+        "ip":                     string,
+        "network":                string,
+        "broadcast":              string,
+        "hostmask":               string,
+        "netmask":                string,
+        "first_host":             string,
+        "last_host":              string
+      }
+    }
+
+Examples:
+
+    $ echo 192.168.2.10/24 | jc --ip-address -p
+    {
+      "version": 4,
+      "max_prefix_length": 32,
+      "ip": "192.168.2.10",
+      "ip_compressed": "192.168.2.10",
+      "ip_exploded": "192.168.2.10",
+      "ip_split": [
+        "192",
+        "168",
+        "2",
+        "10"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "10.2.168.192.in-addr.arpa",
+      "network": "192.168.2.0",
+      "broadcast": "192.168.2.255",
+      "hostmask": "0.0.0.255",
+      "netmask": "255.255.255.0",
+      "cidr_netmask": 24,
+      "hosts": 254,
+      "first_host": "192.168.2.1",
+      "last_host": "192.168.2.254",
+      "is_multicast": false,
+      "is_private": true,
+      "is_global": false,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": false,
+      "is_unspecified": false,
+      "int": {
+        "ip": 3232236042,
+        "network": 3232236032,
+        "broadcast": 3232236287,
+        "first_host": 3232236033,
+        "last_host": 3232236286
+      },
+      "hex": {
+        "ip": "c0:a8:02:0a",
+        "network": "c0:a8:02:00",
+        "broadcast": "c0:a8:02:ff",
+        "hostmask": "00:00:00:ff",
+        "netmask": "ff:ff:ff:00",
+        "first_host": "c0:a8:02:01",
+        "last_host": "c0:a8:02:fe"
+      },
+      "bin": {
+        "ip": "11000000101010000000001000001010",
+        "network": "11000000101010000000001000000000",
+        "broadcast": "11000000101010000000001011111111",
+        "hostmask": "00000000000000000000000011111111",
+        "netmask": "11111111111111111111111100000000",
+        "first_host": "11000000101010000000001000000001",
+        "last_host": "11000000101010000000001011111110"
+      }
+    }
+
+    $ echo 3232236042 | jc --ip-address -p
+    {
+      "version": 4,
+      "max_prefix_length": 32,
+      "ip": "192.168.2.10",
+      "ip_compressed": "192.168.2.10",
+      "ip_exploded": "192.168.2.10",
+      "ip_split": [
+        "192",
+        "168",
+        "2",
+        "10"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "10.2.168.192.in-addr.arpa",
+      "network": "192.168.2.10",
+      "broadcast": "192.168.2.10",
+      "hostmask": "0.0.0.0",
+      "netmask": "255.255.255.255",
+      "cidr_netmask": 32,
+      "hosts": 1,
+      "first_host": "192.168.2.10",
+      "last_host": "192.168.2.10",
+      "is_multicast": false,
+      "is_private": true,
+      "is_global": false,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": false,
+      "is_unspecified": false,
+      "int": {
+        "ip": 3232236042,
+        "network": 3232236042,
+        "broadcast": 3232236042,
+        "first_host": 3232236042,
+        "last_host": 3232236042
+      },
+      "hex": {
+        "ip": "c0:a8:02:0a",
+        "network": "c0:a8:02:0a",
+        "broadcast": "c0:a8:02:0a",
+        "hostmask": "00:00:00:00",
+        "netmask": "ff:ff:ff:ff",
+        "first_host": "c0:a8:02:0a",
+        "last_host": "c0:a8:02:0a"
+      },
+      "bin": {
+        "ip": "11000000101010000000001000001010",
+        "network": "11000000101010000000001000001010",
+        "broadcast": "11000000101010000000001000001010",
+        "hostmask": "00000000000000000000000000000000",
+        "netmask": "11111111111111111111111111111111",
+        "first_host": "11000000101010000000001000001010",
+        "last_host": "11000000101010000000001000001010"
+      }
+    }
+
+    $ echo 127:0:de::1%128/96 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "127:0:de::1",
+      "ip_compressed": "127:0:de::1",
+      "ip_exploded": "0127:0000:00de:0000:0000:0000:0000:0001",
+      "ip_split": [
+        "0127",
+        "0000",
+        "00de",
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "0001"
+      ],
+      "scope_id": "128",
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "1.0.0.0.0.0...0.0.0.e.d.0.0.0.0.0.0.7.2.1.0.ip6.arpa",
+      "network": "127:0:de::",
+      "broadcast": "127:0:de::ffff:ffff",
+      "hostmask": "::ffff:ffff",
+      "netmask": "ffff:ffff:ffff:ffff:ffff:ffff::",
+      "cidr_netmask": 96,
+      "hosts": 4294967294,
+      "first_host": "127:0:de::1",
+      "last_host": "127:0:de::ffff:fffe",
+      "is_multicast": false,
+      "is_private": false,
+      "is_global": true,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": true,
+      "is_unspecified": false,
+      "int": {
+        "ip": 1531727573536155682370944093904699393,
+        "network": 1531727573536155682370944093904699392,
+        "broadcast": 1531727573536155682370944098199666687,
+        "first_host": 1531727573536155682370944093904699393,
+        "last_host": 1531727573536155682370944098199666686
+      },
+      "hex": {
+        "ip": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "network": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:00",
+        "broadcast": "01:27:00:00:00:de:00:00:00:00:00:00:ff:ff:ff:ff",
+        "hostmask": "00:00:00:00:00:00:00:00:00:00:00:00:ff:ff:ff:ff",
+        "netmask": "ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:00:00:00:00",
+        "first_host": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "last_host": "01:27:00:00:00:de:00:00:00:00:00:00:ff:ff:ff:fe"
+      },
+      "bin": {
+        "ip": "0000000100100111000000000000000000000000110...000000000001",
+        "network": "00000001001001110000000000000000000000...000000000000",
+        "broadcast": "000000010010011100000000000000000000...111111111111",
+        "hostmask": "0000000000000000000000000000000000000...111111111111",
+        "netmask": "11111111111111111111111111111111111111...000000000000",
+        "first_host": "00000001001001110000000000000000000...000000000001",
+        "last_host": "000000010010011100000000000000000000...1111111111110"
+      }
+    }
+
+    $ echo 1531727573536155682370944093904699393 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "127:0:de::1",
+      "ip_compressed": "127:0:de::1",
+      "ip_exploded": "0127:0000:00de:0000:0000:0000:0000:0001",
+      "ip_split": [
+        "0127",
+        "0000",
+        "00de",
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "0001"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "1.0.0.0.0.0....0.0.0.0.e.d.0.0.0.0.0.0.7.2.1.0.ip6.arpa",
+      "network": "127:0:de::1",
+      "broadcast": "127:0:de::1",
+      "hostmask": "::",
+      "netmask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+      "cidr_netmask": 128,
+      "hosts": 1,
+      "first_host": "127:0:de::1",
+      "last_host": "127:0:de::1",
+      "is_multicast": false,
+      "is_private": false,
+      "is_global": true,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": true,
+      "is_unspecified": false,
+      "int": {
+        "ip": 1531727573536155682370944093904699393,
+        "network": 1531727573536155682370944093904699393,
+        "broadcast": 1531727573536155682370944093904699393,
+        "first_host": 1531727573536155682370944093904699393,
+        "last_host": 1531727573536155682370944093904699393
+      },
+      "hex": {
+        "ip": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "network": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "broadcast": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "hostmask": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00",
+        "netmask": "ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "first_host": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01",
+        "last_host": "01:27:00:00:00:de:00:00:00:00:00:00:00:00:00:01"
+      },
+      "bin": {
+        "ip": "0000000100100111000000000000000000000000110111100...000001",
+        "network": "00000001001001110000000000000000000000001101...000001",
+        "broadcast": "000000010010011100000000000000000000000011...000001",
+        "hostmask": "0000000000000000000000000000000000000000000...000000",
+        "netmask": "11111111111111111111111111111111111111111111...111111",
+        "first_host": "00000001001001110000000000000000000000001...000001",
+        "last_host": "000000010010011100000000000000000000000011...0000001"
+      }
+    }
+
+    # IPv4 Mapped Address
+    $ echo ::FFFF:192.168.1.35 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "::ffff:c0a8:123",
+      "ip_compressed": "::ffff:c0a8:123",
+      "ip_exploded": "0000:0000:0000:0000:0000:ffff:c0a8:0123",
+      "ip_split": [
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "ffff",
+        "c0a8",
+        "0123"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": "192.168.1.35",
+      "six_to_four": null,
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "3.2.1.0.8.a.0.c.f.f.f.f.0.0....0.0.0.0.0.0.ip6.arpa",
+      "network": "::ffff:c0a8:123",
+      "broadcast": "::ffff:c0a8:123",
+      "hostmask": "::",
+      "netmask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+      "cidr_netmask": 128,
+      "hosts": 1,
+      "first_host": "::ffff:c0a8:123",
+      "last_host": "::ffff:c0a8:123",
+      "is_multicast": false,
+      "is_private": true,
+      "is_global": false,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": true,
+      "is_unspecified": false,
+      "int": {
+        "ip": 281473913979171,
+        "network": 281473913979171,
+        "broadcast": 281473913979171,
+        "first_host": 281473913979171,
+        "last_host": 281473913979171
+      },
+      "hex": {
+        "ip": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23",
+        "network": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23",
+        "broadcast": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23",
+        "hostmask": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00",
+        "netmask": "ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "first_host": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23",
+        "last_host": "00:00:00:00:00:00:00:00:00:00:ff:ff:c0:a8:01:23"
+      },
+      "bin": {
+        "ip": "000000000000000000000000000000000000000000000...100100011",
+        "network": "0000000000000000000000000000000000000000...000100011",
+        "broadcast": "00000000000000000000000000000000000000...000100011",
+        "hostmask": "000000000000000000000000000000000000000...000000000",
+        "netmask": "1111111111111111111111111111111111111111...111111111",
+        "first_host": "0000000000000000000000000000000000000...100100011",
+        "last_host": "00000000000000000000000000000000000000...0100100011"
+      }
+    }
+
+    # 6to4 Address
+    $ echo 2002:c000:204::/48 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "2002:c000:204::",
+      "ip_compressed": "2002:c000:204::",
+      "ip_exploded": "2002:c000:0204:0000:0000:0000:0000:0000",
+      "ip_split": [
+        "2002",
+        "c000",
+        "0204",
+        "0000",
+        "0000",
+        "0000",
+        "0000",
+        "0000"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": "192.0.2.4",
+      "teredo_client": null,
+      "teredo_server": null,
+      "dns_ptr": "0.0.0.0.0.0.0...0.0.0.4.0.2.0.0.0.0.c.2.0.0.2.ip6.arpa",
+      "network": "2002:c000:204::",
+      "broadcast": "2002:c000:204:ffff:ffff:ffff:ffff:ffff",
+      "hostmask": "::ffff:ffff:ffff:ffff:ffff",
+      "netmask": "ffff:ffff:ffff::",
+      "cidr_netmask": 48,
+      "hosts": 1208925819614629174706174,
+      "first_host": "2002:c000:204::1",
+      "last_host": "2002:c000:204:ffff:ffff:ffff:ffff:fffe",
+      "is_multicast": false,
+      "is_private": false,
+      "is_global": true,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": false,
+      "is_unspecified": false,
+      "int": {
+        "ip": 42549574682102084431821433448024768512,
+        "network": 42549574682102084431821433448024768512,
+        "broadcast": 42549574682103293357641048077199474687,
+        "first_host": 42549574682102084431821433448024768513,
+        "last_host": 42549574682103293357641048077199474686
+      },
+      "hex": {
+        "ip": "20:02:c0:00:02:04:00:00:00:00:00:00:00:00:00:00",
+        "network": "20:02:c0:00:02:04:00:00:00:00:00:00:00:00:00:00",
+        "broadcast": "20:02:c0:00:02:04:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "hostmask": "00:00:00:00:00:00:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "netmask": "ff:ff:ff:ff:ff:ff:00:00:00:00:00:00:00:00:00:00",
+        "first_host": "20:02:c0:00:02:04:00:00:00:00:00:00:00:00:00:01",
+        "last_host": "20:02:c0:00:02:04:ff:ff:ff:ff:ff:ff:ff:ff:ff:fe"
+      },
+      "bin": {
+        "ip": "00100000000000101100000000000000000000100000010...00000000",
+        "network": "001000000000001011000000000000000000001000...00000000",
+        "broadcast": "0010000000000010110000000000000000000010...11111111",
+        "hostmask": "00000000000000000000000000000000000000000...11111111",
+        "netmask": "111111111111111111111111111111111111111111...00000000",
+        "first_host": "001000000000001011000000000000000000001...00000001",
+        "last_host": "0010000000000010110000000000000000000010...111111110"
+      }
+    }
+
+    # Teredo Address
+    $ echo 2001:0000:4136:e378:8000:63bf:3fff:fdd2 | jc --ip-address -p
+    {
+      "version": 6,
+      "max_prefix_length": 128,
+      "ip": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "ip_compressed": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "ip_exploded": "2001:0000:4136:e378:8000:63bf:3fff:fdd2",
+      "ip_split": [
+        "2001",
+        "0000",
+        "4136",
+        "e378",
+        "8000",
+        "63bf",
+        "3fff",
+        "fdd2"
+      ],
+      "scope_id": null,
+      "ipv4_mapped": null,
+      "six_to_four": null,
+      "teredo_client": "192.0.2.45",
+      "teredo_server": "65.54.227.120",
+      "dns_ptr": "2.d.d.f.f.f.f.3.f.b.3.6.0.0.0.8.8....0.1.0.0.2.ip6.arpa",
+      "network": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "broadcast": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "hostmask": "::",
+      "netmask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
+      "cidr_netmask": 128,
+      "hosts": 1,
+      "first_host": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "last_host": "2001:0:4136:e378:8000:63bf:3fff:fdd2",
+      "is_multicast": false,
+      "is_private": true,
+      "is_global": false,
+      "is_link_local": false,
+      "is_loopback": false,
+      "is_reserved": false,
+      "is_unspecified": false,
+      "int": {
+        "ip": 42540488182158724593221357832373272018,
+        "network": 42540488182158724593221357832373272018,
+        "broadcast": 42540488182158724593221357832373272018,
+        "first_host": 42540488182158724593221357832373272018,
+        "last_host": 42540488182158724593221357832373272018
+      },
+      "hex": {
+        "ip": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2",
+        "network": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2",
+        "broadcast": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2",
+        "hostmask": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00",
+        "netmask": "ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff:ff",
+        "first_host": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2",
+        "last_host": "20:01:00:00:41:36:e3:78:80:00:63:bf:3f:ff:fd:d2"
+      },
+      "bin": {
+        "ip": "0010000000000001000000000000000001000001001...110111010010",
+        "network": "00100000000000010000000000000000010000...110111010010",
+        "broadcast": "001000000000000100000000000000000100...110111010010",
+        "hostmask": "0000000000000000000000000000000000000...000000000000",
+        "netmask": "11111111111111111111111111111111111111...111111111111",
+        "first_host": "00100000000000010000000000000000010...110111010010",
+        "last_host": "001000000000000100000000000000000100...110111010010"
+      }
+    }
+
+<a id="jc.parsers.ip_address.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iptables.md

@@ -1,15 +1,47 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iptables"></a>
+
 # jc.parsers.iptables
-jc - JSON CLI output utility ipables Parser
 
-Usage:
+jc - JSON Convert `iptables` command output parser
 
-    Specify --iptables as the first argument if the piped input is coming from iptables
+Supports `-vLn` and `--line-numbers` for all tables.
 
-    Supports -vLn and --line-numbers for all tables
+Usage (cli):
 
-Compatibility:
+    $ sudo iptables -L -t nat | jc --iptables
 
-    'linux'
+or
+
+    $ jc iptables -L -t nat
+
+Usage (module):
+
+    import jc
+    result = jc.parse('iptables', iptables_command_output)
+
+Schema:
+
+    [
+      {
+        "chain":                string,
+        "rules": [
+          {
+            "num"               integer,
+            "pkts":             integer,
+            "bytes":            integer,  # converted based on suffix
+            "target":           string,
+            "prot":             string,
+            "opt":              string,   # "--" = Null
+            "in":               string,
+            "out":              string,
+            "source":           string,
+            "destination":      string,
+            "options":          string
+          }
+        ]
+      }
+    ]
 
 Examples:
 
@@ -131,50 +163,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.iptables.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "chain":                string,
-        "rules": [
-          {
-            "num"               integer,
-            "pkts":             integer,
-            "bytes":            integer,  # converted based on suffix
-            "target":           string,
-            "prot":             string,
-            "opt":              string,   # "--" = Null
-            "in":               string,
-            "out":              string,
-            "source":           string,
-            "destination":      string,
-            "options":          string
-          }
-        ]
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -182,10 +176,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux
+
+Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iso_datetime.md

@@ -0,0 +1,37 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iso_datetime"></a>
+
+# jc.parsers.iso\_datetime
+
+jc - JSON Convert ISO 8601 Datetime string parser
+
+This parser has been renamed to datetime-iso (cli) or datetime_iso (module).
+
+This parser will be removed in a future version, so please start using
+the new parser name.
+
+<a id="jc.parsers.iso_datetime.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+This parser is deprecated and calls datetime_iso. Please use datetime_iso
+directly. This parser will be removed in the future.
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, aix, freebsd, darwin, win32, cygwin
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/iw_scan.md

@@ -0,0 +1,147 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.iw_scan"></a>
+
+# jc.parsers.iw\_scan
+
+jc - JSON Convert `iw dev <device> scan` command output parser
+
+This parser is considered beta quality. Not all fields are parsed and there
+are not enough samples to test.
+
+Usage (cli):
+
+    $ iw dev wlan0 scan | jc --iw-scan
+
+or
+
+    $ jc iw dev wlan0 scan
+
+Usage (module):
+
+    import jc
+    result = jc.parse('iw_scan', iw_scan_command_output)
+
+Schema:
+
+    [
+      {
+        "foo":     string/integer/float,      # best guess based on value
+        "bar":     string/integer/float,
+        "baz":     string/integer/float
+      }
+    ]
+
+Examples:
+
+    $ iw dev wlan0 scan | jc --iw-scan -p
+    [
+      {
+        "bssid": "71:31:72:65:e1:a2",
+        "interface": "wlan0",
+        "freq": 2462,
+        "capability": "ESS Privacy ShortSlotTime (0x0411)",
+        "ssid": "WLAN-1234",
+        "supported_rates": [
+          1.0,
+          2.0,
+          5.5,
+          11.0,
+          18.0,
+          24.0,
+          36.0,
+          54.0
+        ],
+        "erp": "<no flags>",
+        "erp_d4.0": "<no flags>",
+        "rsn": "Version: 1",
+        "group_cipher": "CCMP",
+        "pairwise_ciphers": "CCMP",
+        "authentication_suites": "PSK",
+        "capabilities": "0x186c",
+        "extended_supported_rates": [
+          6.0,
+          9.0,
+          12.0,
+          48.0
+        ],
+        "ht_rx_mcs_rate_indexes_supported": "0-15",
+        "primary_channel": 11,
+        "secondary_channel_offset": "no secondary",
+        "rifs": 1,
+        "ht_protection": "no",
+        "non-gf_present": 1,
+        "obss_non-gf_present": 0,
+        "dual_beacon": 0,
+        "dual_cts_protection": 0,
+        "stbc_beacon": 0,
+        "l-sig_txop_prot": 0,
+        "pco_active": 0,
+        "pco_phase": 0,
+        "bss_width_channel_transition_delay_factor": 5,
+        "extended_capabilities": "HT Information Exchange Supported",
+        "wmm": "Parameter version 1",
+        "be": "CW 15-1023, AIFSN 3",
+        "bk": "CW 15-1023, AIFSN 7",
+        "vi": "CW 7-15, AIFSN 2, TXOP 3008 usec",
+        "vo": "CW 3-7, AIFSN 2, TXOP 1504 usec",
+        "wps": "Version: 1.0",
+        "wi-fi_protected_setup_state": "2 (Configured)",
+        "selected_registrar": "0x0",
+        "response_type": "3 (AP)",
+        "uuid": "00000000-0000-0003-0000-75317074f1a2",
+        "manufacturer": "Corporation",
+        "model": "VGV8539JW",
+        "model_number": "1.47.000",
+        "serial_number": "J144024542",
+        "primary_device_type": "6-0050f204-1",
+        "device_name": "Wireless Router(WFA)",
+        "config_methods": "Label, PBC",
+        "rf_bands": "0x3",
+        "tsf_usec": 212098649788,
+        "sta_channel_width_mhz": 20,
+        "passive_dwell_tus": 20,
+        "active_dwell_tus": 10,
+        "channel_width_trigger_scan_interval_s": 300,
+        "scan_passive_total_per_channel_tus": 200,
+        "scan_active_total_per_channel_tus": 20,
+        "beacon_interval_tus": 100,
+        "signal_dbm": -80.0,
+        "last_seen_ms": 11420,
+        "selected_rates": [
+          1.0,
+          2.0,
+          5.5,
+          11.0
+        ],
+        "obss_scan_activity_threshold_percent": 0.25,
+        "ds_parameter_set_channel": 11,
+        "max_amsdu_length_bytes": 7935,
+        "minimum_rx_ampdu_time_spacing_usec": 16
+      },
+      ...
+    ]
+
+<a id="jc.parsers.iw_scan.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 0.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/jar_manifest.md

@@ -0,0 +1,103 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.jar_manifest"></a>
+
+# jc.parsers.jar\_manifest
+
+jc - JSON Convert Java `MANIFEST.MF` file parser
+
+Usage (cli):
+
+    $ cat MANIFEST.MF | jc --jar-manifest
+
+Usage (module):
+
+    import jc
+    result = jc.parse('jar_manifest', jar_manifest_file_output)
+
+Schema:
+
+    [
+      {
+        "key1":     string,
+        "key2":     string
+      }
+    ]
+
+Examples:
+
+    $ cat MANIFEST.MF | jc --jar-manifest -p
+    $ unzip -c log4j-core-2.16.0.jar META-INF/MANIFEST.MF | \\
+      jc --jar-manifest -p
+    $ unzip -c 'apache-log4j-2.16.0-bin/*.jar' META-INF/MANIFEST.MF | \\
+      jc --jar-manifest -p
+
+    $ cat MANIFEST.MF | jc --jar-manifest -p
+    [
+      {
+        "Import_Package": "com.conversantmedia.util.concurrent;resoluti...",
+        "Export_Package": "org.apache.logging.log4j.core;uses:=\"org.ap...",
+        "Manifest_Version": "1.0",
+        "Bundle_License": "https://www.apache.org/licenses/LICENSE-2.0.txt",
+        "Bundle_SymbolicName": "org.apache.logging.log4j.core",
+        "Built_By": "matt",
+        "Bnd_LastModified": "1639373735804",
+        "Implementation_Vendor_Id": "org.apache.logging.log4j",
+        "Specification_Title": "Apache Log4j Core",
+        "Log4jReleaseManager": "Matt Sicker",
+        ...
+      }
+    ]
+
+    $ unzip -c 'apache-log4j-2.16.0-bin/*.jar' META-INF/MANIFEST.MF | \\
+      jc --jar-manifest -p
+    [
+      ...
+      {
+        "Archive": "apache-log4j-2.16.0-bin/log4j-spring-boot-2.16.0-so...",
+        "Manifest_Version": "1.0",
+        "Built_By": "matt",
+        "Created_By": "Apache Maven 3.8.4",
+        "Build_Jdk": "1.8.0_312"
+      },
+      {
+        "Archive": "apache-log4j-2.16.0-bin/log4j-spring-boot-2.16.0-ja...",
+        "Manifest_Version": "1.0",
+        "Built_By": "matt",
+        "Created_By": "Apache Maven 3.8.4",
+        "Build_Jdk": "1.8.0_312"
+      },
+      {
+        "Bundle_SymbolicName": "org.apache.logging.log4j.spring-cloud-c...",
+        "Export_Package": "org.apache.logging.log4j.spring.cloud.config...",
+        "Archive": "apache-log4j-2.16.0-bin/log4j-spring-cloud-config-c...",
+        "Manifest_Version": "1.0",
+        "Bundle_License": "https://www.apache.org/licenses/LICENSE-2.0.txt",
+        ...
+      }
+      ...
+    ]
+
+<a id="jc.parsers.jar_manifest.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 0.01 by Matt J (https://github.com/listuser)

docs/parsers/jobs.md

@@ -1,15 +1,35 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.jobs"></a>
+
 # jc.parsers.jobs
-jc - JSON CLI output utility jobs Parser
 
-Usage:
+jc - JSON Convert `jobs` command output parser
 
-    specify --jobs as the first argument if the piped input is coming from jobs
+Also supports the `-l` option.
 
-    Also supports the -l option
+The "Magic" syntax is not supported since the `jobs` command is a shell
+builtin.
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+    $ jobs | jc --jobs
+
+Usage (module):
+
+    import jc
+    result = jc.parse('jobs', jobs_command_output)
+
+Schema:
+
+    [
+      {
+        "job_number":   integer,
+        "pid":          integer,
+        "history":      string,
+        "status":       string,
+        "command":      string
+      }
+    ]
 
 Example:
 
@@ -73,39 +93,12 @@ Example:
       }
     ]
 
-## info
+<a id="jc.parsers.jobs.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "job_number":   integer,
-        "pid":          integer,
-        "history":      string,
-        "status":       string,
-        "command":      string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -113,10 +106,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, aix, freebsd
+
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/jwt.md

@@ -0,0 +1,73 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.jwt"></a>
+
+# jc.parsers.jwt
+
+jc - JSON Convert JWT string parser
+
+> Note: `jc` will not check the integrity of the JWT payload.
+
+Usage (cli):
+
+    $ echo "eyJhbGciOiJIUzI1N..." | jc --jwt
+
+Usage (module):
+
+    import jc
+    result = jc.parse('jwt', jwt_string)
+
+Schema:
+
+    {
+      "header": {
+        "alg":                    string,
+        "typ":                    string
+      },
+      "payload": {
+        <key name>:               string/integer/float/boolean/null
+      },
+      "signature":                string  # [0]
+    }
+
+    [0] in colon-delimited hex notation
+
+Examples:
+
+    % echo 'eyJhbGciOiJIUzI1N...' | jc --jwt -p
+    {
+      "header": {
+        "alg": "HS256",
+        "typ": "JWT"
+      },
+      "payload": {
+        "sub": "1234567890",
+        "name": "John Doe",
+        "iat": 1516239022
+      },
+      "signature": "49:f9:4a:c7:04:49:48:c7:8a:28:5d:90:4f:87:f0:a4:c7..."
+    }
+
+<a id="jc.parsers.jwt.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/kv.md

@@ -0,0 +1,83 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.kv"></a>
+
+# jc.parsers.kv
+
+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 `;`. Comments must be on their own line.
+- If duplicate keys are found, only the last value will be used.
+
+> Note: Values starting and ending with quotation marks will have the marks
+> removed. If you would like to keep the quotation marks, use the `-r`
+> command-line argument or the `raw=True` argument in `parse()`.
+
+Usage (cli):
+
+    $ cat foo.txt | jc --kv
+
+Usage (module):
+
+    import jc
+    result = jc.parse('kv', kv_file_output)
+
+Schema:
+
+key/value document converted to a dictionary - see the configparser standard
+library documentation for more details.
+
+    {
+      "key1":       string,
+      "key2":       string
+    }
+
+Examples:
+
+    $ cat keyvalue.txt
+    # this file contains key/value pairs
+    name = John Doe
+    address=555 California Drive
+    age: 34
+    ; comments can include # or ;
+    # delimiter can be = or :
+    # quoted values have quotation marks stripped by default
+    # but can be preserved with the -r argument
+    occupation:"Engineer"
+
+    $ cat keyvalue.txt | jc --kv -p
+    {
+      "name": "John Doe",
+      "address": "555 California Drive",
+      "age": "34",
+      "occupation": "Engineer"
+    }
+
+<a id="jc.parsers.kv.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+    Note: this is just a wrapper for jc.parsers.ini
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary representing the key/value file
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/last.md

@@ -1,40 +1,77 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.last"></a>
+
 # jc.parsers.last
-jc - JSON CLI output utility last Parser
 
-Usage:
+jc - JSON Convert `last` and `lastb` command output parser
 
-    specify --last as the first argument if the piped input is coming from last or lastb
+Supports `-w` and `-F` options.
 
-Compatibility:
+Calculated epoch time fields are naive (i.e. based on the local time of the
+system the parser is run on) since there is no timezone information in the
+`last` command output.
 
-    'linux', 'darwin', 'aix', 'freebsd'
+Usage (cli):
+
+    $ last | jc --last
+
+or
+
+    $ jc last
+
+Usage (module):
+
+    import jc
+    result = jc.parse('last', last_command_output)
+
+Schema:
+
+    [
+      {
+        "user":             string,
+        "tty":              string,
+        "hostname":         string,
+        "login":            string,
+        "logout":           string,
+        "duration":         string,
+        "login_epoch":      integer,  # (naive) available w/last -F option
+        "logout_epoch":     integer,  # (naive) available w/last -F option
+        "duration_seconds": integer   # available w/last -F option
+      }
+    ]
 
 Examples:
 
-    $ last | jc --last -p
+    $ last -F | jc --last -p
     [
       {
         "user": "kbrazil",
         "tty": "ttys002",
         "hostname": null,
-        "login": "Thu Feb 27 14:31",
+        "login": "Mon Dec 28 17:24:10 2020",
         "logout": "still logged in"
       },
       {
         "user": "kbrazil",
         "tty": "ttys003",
         "hostname": null,
-        "login": "Thu Feb 27 10:38",
-        "logout": "10:38",
-        "duration": "00:00"
+        "login": "Mon Dec 28 17:24:10 2020",
+        "logout": "Mon Dec 28 17:25:01 2020",
+        "duration": "00:00",
+        "login_epoch": 1565891826,
+        "logout_epoch": 1565895404,
+        "duration_seconds": 3578
       },
       {
         "user": "kbrazil",
         "tty": "ttys003",
         "hostname": null,
-        "login": "Thu Feb 27 10:18",
-        "logout": "10:18",
-        "duration": "00:00"
+        "login": "Mon Dec 28 17:24:10 2020",
+        "logout": "Mon Dec 28 17:25:01 2020",
+        "duration": "00:00",
+        "login_epoch": 1565891826,
+        "logout_epoch": 1565895404,
+        "duration_seconds": 3578
       },
       ...
     ]
@@ -67,41 +104,12 @@ Examples:
       ...
     ]
 
+<a id="jc.parsers.last.parse"></a>
+
+### parse
 
-## info
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "user":       string,
-        "tty":        string,
-        "hostname":   string,
-        "login":      string,
-        "logout":     string,
-        "duration":   string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -109,10 +117,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, aix, freebsd
+
+Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ls.md

@@ -1,25 +1,60 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ls"></a>
+
 # jc.parsers.ls
-jc - JSON CLI output utility ls Parser
 
-Note: The -l or -b option of ls should be used to correctly parse filenames that include newline characters.
-      Since ls does not encode newlines in filenames when outputting to a pipe it will cause jc to see
-      multiple files instead of a single file if -l or -b is not used.
+jc - JSON Convert `ls` and `vdir` command output parser
 
-Usage:
+Options supported:
+- `lbaR1`
+- `--time-style=full-iso`
 
-    specify --ls as the first argument if the piped input is coming from ls
+> Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly
+> parse filenames that include newline characters. Since `ls` does not
+> encode newlines in filenames when outputting to a pipe it will cause `jc`
+> to see multiple files instead of a single file if `-1`, `-l`, or `-b` is
+> not used. Alternatively, `vdir` can be used, which is the same as running
+> `ls -lb`.
 
-    ls options supported:
+The `epoch` calculated timestamp field is naive. (i.e. based on the local
+time of the system the parser is run on)
 
-                    -lbaR
-    --time-style=full-iso
-                       -h  file sizes will be available in text form with -r but larger file sizes
-                               with human readable suffixes will be converted to Null in default view
-                               since the parser attempts to convert this field to an integer.
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the timezone field is UTC.
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'darwin', 'cygwin', 'aix', 'freebsd'
+    $ ls | jc --ls
+
+or
+
+    $ jc ls
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ls', ls_command_output)
+
+Schema:
+
+    [
+      {
+        "filename":     string,
+        "flags":        string,
+        "links":        integer,
+        "parent":       string,
+        "owner":        string,
+        "group":        string,
+        "size":         integer,
+        "date":         string,
+        "epoch":        integer,     # [0]
+        "epoch_utc":    integer      # [1]
+      }
+    ]
+
+    [0] naive timestamp if date field exists and can be converted.
+    [1] timezone aware timestamp if date field is in UTC and can
+        be converted.
 
 Examples:
 
@@ -31,12 +66,6 @@ Examples:
       {
         "filename": "arch"
       },
-      {
-        "filename": "awk"
-      },
-      {
-        "filename": "base64"
-      },
       ...
     ]
 
@@ -61,15 +90,6 @@ Examples:
         "size": 62744,
         "date": "Aug 8 16:14"
       },
-      {
-        "filename": "arch",
-        "flags": "-rwxr-xr-x.",
-        "links": 1,
-        "owner": "root",
-        "group": "root",
-        "size": 33080,
-        "date": "Aug 19 23:25"
-      },
       ...
     ]
 
@@ -94,93 +114,15 @@ Examples:
         "size": "33080",
         "date": "Aug 19 23:25"
       },
-      {
-        "filename": "awk",
-        "link_to": "gawk",
-        "flags": "lrwxrwxrwx.",
-        "links": "1",
-        "owner": "root",
-        "group": "root",
-        "size": "4",
-        "date": "Aug 15 10:53"
-      },
-      {
-        "filename": "base64",
-        "flags": "-rwxr-xr-x.",
-        "links": "1",
-        "owner": "root",
-        "group": "root",
-        "size": "37360",
-        "date": "Aug 19 23:25"
-      },
-      {
-        "filename": "basename",
-        "flags": "-rwxr-xr-x.",
-        "links": "1",
-        "owner": "root",
-        "group": "root",
-        "size": "29032",
-        "date": "Aug 19 23:25"
-      },
-      {
-        "filename": "bash",
-        "flags": "-rwxr-xr-x.",
-        "links": "1",
-        "owner": "root",
-        "group": "root",
-        "size": "964600",
-        "date": "Aug 8 05:06"
-      },
       ...
     ]
 
-    $ ls -l /usr/bin | jc --ls | jq '.[] | select(.size > 50000000)'
-    {
-      "filename": "emacs",
-      "flags": "-r-xr-xr-x",
-      "links": 1,
-      "owner": "root",
-      "group": "wheel",
-      "size": 117164432,
-      "date": "May 3 2019"
-    }
+<a id="jc.parsers.ls.parse"></a>
+
+### parse
 
-## info
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "filename": string,
-        "flags":    string,
-        "links":    integer,
-        "parent":   string,
-        "owner":    string,
-        "group":    string,
-        "size":     integer,
-        "date":     string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -188,10 +130,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, aix, freebsd
+
+Version 1.12 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ls_s.md

@@ -0,0 +1,102 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ls_s"></a>
+
+# jc.parsers.ls\_s
+
+jc - JSON Convert `ls` and `vdir` command output streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+Requires the `-l` option to be used on `ls`. If there are newline characters
+in the filename, then make sure to use the `-b` option on `ls`.
+
+The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames
+with newline characters, but `-b` was not used)
+
+The `epoch` calculated timestamp field is naive (i.e. based on the local
+time of the system the parser is run on)
+
+The `epoch_utc` calculated timestamp field is timezone-aware and is only
+available if the timezone field is UTC.
+
+Usage (cli):
+
+    $ ls | jc --ls-s
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('ls_s', ls_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "filename":       string,
+      "flags":          string,
+      "links":          integer,
+      "parent":         string,
+      "owner":          string,
+      "group":          string,
+      "size":           integer,
+      "date":           string,
+      "epoch":          integer,     # [0]
+      "epoch_utc":      integer,     # [1]
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":      boolean,     # false if error parsing
+        "error":        string,      # exists if "success" is false
+        "line":         string       # exists if "success" is false
+      }
+    }
+
+    [0] naive timestamp if date field exists and can be converted.
+    [1] timezone aware timestamp if date field is in UTC and can
+        be converted
+
+Examples:
+
+    $ ls -l /usr/bin | jc --ls-s
+    {"filename":"2to3-","flags":"-rwxr-xr-x","links":4,"owner":"root","...}
+    {"filename":"2to3-2.7","link_to":"../../System/Library/Frameworks/P...}
+    {"filename":"AssetCacheLocatorUtil","flags":"-rwxr-xr-x","links":1,...}
+    ...
+
+    $ ls -l /usr/bin | jc --ls-s -r
+    {"filename":"2to3-","flags":"-rwxr-xr-x","links":"4","owner":"roo"..."}
+    {"filename":"2to3-2.7","link_to":"../../System/Library/Frameworks/P...}
+    {"filename":"AssetCacheLocatorUtil","flags":"-rwxr-xr-x","links":"1...}
+    ...
+
+<a id="jc.parsers.ls_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
+```
+
+Main text parsing generator function. Returns an iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, aix, freebsd
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsblk.md

@@ -1,236 +1,24 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lsblk"></a>
+
 # jc.parsers.lsblk
-jc - JSON CLI output utility lsblk Parser
 
-Usage:
+jc - JSON Convert `lsblk` command output parser
 
-    specify --lsblk as the first argument if the piped input is coming from lsblk
+Usage (cli):
 
-Compatibility:
+    $ lsblk | jc --lsblk
 
-    'linux'
+or
 
-Examples:
+    $ jc lsblk
 
-    $ lsblk | jc --lsblk -p
-    [
-      {
-        "name": "sda",
-        "maj_min": "8:0",
-        "rm": false,
-        "size": "20G",
-        "ro": false,
-        "type": "disk",
-        "mountpoint": null
-      },
-      {
-        "name": "sda1",
-        "maj_min": "8:1",
-        "rm": false,
-        "size": "1G",
-        "ro": false,
-        "type": "part",
-        "mountpoint": "/boot"
-      },
-      ...
-    ]
+Usage (module):
 
-    $ lsblk -o +KNAME,FSTYPE,LABEL,UUID,PARTLABEL,PARTUUID,RA,MODEL,SERIAL,STATE,OWNER,GROUP,MODE,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,SCHED,RQ-SIZE,DISC-ALN,DISC-GRAN,DISC-MAX,DISC-ZERO,WSAME,WWN,RAND,PKNAME,HCTL,TRAN,REV,VENDOR | jc --lsblk -p
-    [
-      {
-        "name": "sda",
-        "maj_min": "8:0",
-        "rm": false,
-        "size": "20G",
-        "ro": false,
-        "type": "disk",
-        "mountpoint": null,
-        "kname": "sda",
-        "fstype": null,
-        "label": null,
-        "uuid": null,
-        "partlabel": null,
-        "partuuid": null,
-        "ra": 4096,
-        "model": "VMware Virtual S",
-        "serial": null,
-        "state": "running",
-        "owner": "root",
-        "group": "disk",
-        "mode": "brw-rw----",
-        "alignment": 0,
-        "min_io": 512,
-        "opt_io": 0,
-        "phy_sec": 512,
-        "log_sec": 512,
-        "rota": true,
-        "sched": "deadline",
-        "rq_size": 128,
-        "disc_aln": 0,
-        "disc_gran": "0B",
-        "disc_max": "0B",
-        "disc_zero": false,
-        "wsame": "32M",
-        "wwn": null,
-        "rand": true,
-        "pkname": null,
-        "hctl": "0:0:0:0",
-        "tran": "spi",
-        "rev": "1.0",
-        "vendor": "VMware,"
-      },
-      {
-        "name": "sda1",
-        "maj_min": "8:1",
-        "rm": false,
-        "size": "1G",
-        "ro": false,
-        "type": "part",
-        "mountpoint": "/boot",
-        "kname": "sda1",
-        "fstype": "xfs",
-        "label": null,
-        "uuid": "05d927bb-5875-49e3-ada1-7f46cb31c932",
-        "partlabel": null,
-        "partuuid": null,
-        "ra": 4096,
-        "model": null,
-        "serial": null,
-        "state": null,
-        "owner": "root",
-        "group": "disk",
-        "mode": "brw-rw----",
-        "alignment": 0,
-        "min_io": 512,
-        "opt_io": 0,
-        "phy_sec": 512,
-        "log_sec": 512,
-        "rota": true,
-        "sched": "deadline",
-        "rq_size": 128,
-        "disc_aln": 0,
-        "disc_gran": "0B",
-        "disc_max": "0B",
-        "disc_zero": false,
-        "wsame": "32M",
-        "wwn": null,
-        "rand": true,
-        "pkname": "sda",
-        "hctl": null,
-        "tran": null,
-        "rev": null,
-        "vendor": null
-      },
-      ...
-    ]
+    import jc
+    result = jc.parse('lsblk', lsblk_command_output)
 
-    $ lsblk -o +KNAME,FSTYPE,LABEL,UUID,PARTLABEL,PARTUUID,RA,MODEL,SERIAL,STATE,OWNER,GROUP,MODE,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,SCHED,RQ-SIZE,DISC-ALN,DISC-GRAN,DISC-MAX,DISC-ZERO,WSAME,WWN,RAND,PKNAME,HCTL,TRAN,REV,VENDOR | jc --lsblk -p -r
-    [
-      {
-        "name": "sda",
-        "maj_min": "8:0",
-        "rm": "0",
-        "size": "20G",
-        "ro": "0",
-        "type": "disk",
-        "mountpoint": null,
-        "kname": "sda",
-        "fstype": null,
-        "label": null,
-        "uuid": null,
-        "partlabel": null,
-        "partuuid": null,
-        "ra": "4096",
-        "model": "VMware Virtual S",
-        "serial": null,
-        "state": "running",
-        "owner": "root",
-        "group": "disk",
-        "mode": "brw-rw----",
-        "alignment": "0",
-        "min_io": "512",
-        "opt_io": "0",
-        "phy_sec": "512",
-        "log_sec": "512",
-        "rota": "1",
-        "sched": "deadline",
-        "rq_size": "128",
-        "disc_aln": "0",
-        "disc_gran": "0B",
-        "disc_max": "0B",
-        "disc_zero": "0",
-        "wsame": "32M",
-        "wwn": null,
-        "rand": "1",
-        "pkname": null,
-        "hctl": "0:0:0:0",
-        "tran": "spi",
-        "rev": "1.0",
-        "vendor": "VMware,"
-      },
-      {
-        "name": "sda1",
-        "maj_min": "8:1",
-        "rm": "0",
-        "size": "1G",
-        "ro": "0",
-        "type": "part",
-        "mountpoint": "/boot",
-        "kname": "sda1",
-        "fstype": "xfs",
-        "label": null,
-        "uuid": "05d927bb-5875-49e3-ada1-7f46cb31c932",
-        "partlabel": null,
-        "partuuid": null,
-        "ra": "4096",
-        "model": null,
-        "serial": null,
-        "state": null,
-        "owner": "root",
-        "group": "disk",
-        "mode": "brw-rw----",
-        "alignment": "0",
-        "min_io": "512",
-        "opt_io": "0",
-        "phy_sec": "512",
-        "log_sec": "512",
-        "rota": "1",
-        "sched": "deadline",
-        "rq_size": "128",
-        "disc_aln": "0",
-        "disc_gran": "0B",
-        "disc_max": "0B",
-        "disc_zero": "0",
-        "wsame": "32M",
-        "wwn": null,
-        "rand": "1",
-        "pkname": "sda",
-        "hctl": null,
-        "tran": null,
-        "rev": null,
-        "vendor": null
-      },
-      ...
-    ]
-
-## info
-```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
+Schema:
 
     [
       {
@@ -277,9 +65,221 @@ Returns:
       }
     ]
 
-## parse
+Examples:
+
+    $ lsblk | jc --lsblk -p
+    [
+      {
+        "name": "sda",
+        "maj_min": "8:0",
+        "rm": false,
+        "size": "20G",
+        "ro": false,
+        "type": "disk",
+        "mountpoint": null
+      },
+      {
+        "name": "sda1",
+        "maj_min": "8:1",
+        "rm": false,
+        "size": "1G",
+        "ro": false,
+        "type": "part",
+        "mountpoint": "/boot"
+      },
+      ...
+    ]
+
+    $ lsblk -o +KNAME,FSTYPE,LABEL,UUID,PARTLABEL,PARTUUID,RA,MODEL,SERIAL,\\
+      STATE,OWNER,GROUP,MODE,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,\\
+      SCHED,RQ-SIZE,DISC-ALN,DISC-GRAN,DISC-MAX,DISC-ZERO,WSAME,WWN,RAND,\\
+      PKNAME,HCTL,TRAN,REV,VENDOR | jc --lsblk -p
+    [
+      {
+        "name": "sda",
+        "maj_min": "8:0",
+        "rm": false,
+        "size": "20G",
+        "ro": false,
+        "type": "disk",
+        "mountpoint": null,
+        "kname": "sda",
+        "fstype": null,
+        "label": null,
+        "uuid": null,
+        "partlabel": null,
+        "partuuid": null,
+        "ra": 4096,
+        "model": "VMware Virtual S",
+        "serial": null,
+        "state": "running",
+        "owner": "root",
+        "group": "disk",
+        "mode": "brw-rw----",
+        "alignment": 0,
+        "min_io": 512,
+        "opt_io": 0,
+        "phy_sec": 512,
+        "log_sec": 512,
+        "rota": true,
+        "sched": "deadline",
+        "rq_size": 128,
+        "disc_aln": 0,
+        "disc_gran": "0B",
+        "disc_max": "0B",
+        "disc_zero": false,
+        "wsame": "32M",
+        "wwn": null,
+        "rand": true,
+        "pkname": null,
+        "hctl": "0:0:0:0",
+        "tran": "spi",
+        "rev": "1.0",
+        "vendor": "VMware,"
+      },
+      {
+        "name": "sda1",
+        "maj_min": "8:1",
+        "rm": false,
+        "size": "1G",
+        "ro": false,
+        "type": "part",
+        "mountpoint": "/boot",
+        "kname": "sda1",
+        "fstype": "xfs",
+        "label": null,
+        "uuid": "05d927bb-5875-49e3-ada1-7f46cb31c932",
+        "partlabel": null,
+        "partuuid": null,
+        "ra": 4096,
+        "model": null,
+        "serial": null,
+        "state": null,
+        "owner": "root",
+        "group": "disk",
+        "mode": "brw-rw----",
+        "alignment": 0,
+        "min_io": 512,
+        "opt_io": 0,
+        "phy_sec": 512,
+        "log_sec": 512,
+        "rota": true,
+        "sched": "deadline",
+        "rq_size": 128,
+        "disc_aln": 0,
+        "disc_gran": "0B",
+        "disc_max": "0B",
+        "disc_zero": false,
+        "wsame": "32M",
+        "wwn": null,
+        "rand": true,
+        "pkname": "sda",
+        "hctl": null,
+        "tran": null,
+        "rev": null,
+        "vendor": null
+      },
+      ...
+    ]
+
+    $ lsblk -o +KNAME,FSTYPE,LABEL,UUID,PARTLABEL,PARTUUID,RA,MODEL,SERIAL,\\
+      STATE,OWNER,GROUP,MODE,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,\\
+      SCHED,RQ-SIZE,DISC-ALN,DISC-GRAN,DISC-MAX,DISC-ZERO,WSAME,WWN,RAND,\\
+      PKNAME,HCTL,TRAN,REV,VENDOR | jc --lsblk -p -r
+    [
+      {
+        "name": "sda",
+        "maj_min": "8:0",
+        "rm": "0",
+        "size": "20G",
+        "ro": "0",
+        "type": "disk",
+        "mountpoint": null,
+        "kname": "sda",
+        "fstype": null,
+        "label": null,
+        "uuid": null,
+        "partlabel": null,
+        "partuuid": null,
+        "ra": "4096",
+        "model": "VMware Virtual S",
+        "serial": null,
+        "state": "running",
+        "owner": "root",
+        "group": "disk",
+        "mode": "brw-rw----",
+        "alignment": "0",
+        "min_io": "512",
+        "opt_io": "0",
+        "phy_sec": "512",
+        "log_sec": "512",
+        "rota": "1",
+        "sched": "deadline",
+        "rq_size": "128",
+        "disc_aln": "0",
+        "disc_gran": "0B",
+        "disc_max": "0B",
+        "disc_zero": "0",
+        "wsame": "32M",
+        "wwn": null,
+        "rand": "1",
+        "pkname": null,
+        "hctl": "0:0:0:0",
+        "tran": "spi",
+        "rev": "1.0",
+        "vendor": "VMware,"
+      },
+      {
+        "name": "sda1",
+        "maj_min": "8:1",
+        "rm": "0",
+        "size": "1G",
+        "ro": "0",
+        "type": "part",
+        "mountpoint": "/boot",
+        "kname": "sda1",
+        "fstype": "xfs",
+        "label": null,
+        "uuid": "05d927bb-5875-49e3-ada1-7f46cb31c932",
+        "partlabel": null,
+        "partuuid": null,
+        "ra": "4096",
+        "model": null,
+        "serial": null,
+        "state": null,
+        "owner": "root",
+        "group": "disk",
+        "mode": "brw-rw----",
+        "alignment": "0",
+        "min_io": "512",
+        "opt_io": "0",
+        "phy_sec": "512",
+        "log_sec": "512",
+        "rota": "1",
+        "sched": "deadline",
+        "rq_size": "128",
+        "disc_aln": "0",
+        "disc_gran": "0B",
+        "disc_max": "0B",
+        "disc_zero": "0",
+        "wsame": "32M",
+        "wwn": null,
+        "rand": "1",
+        "pkname": "sda",
+        "hctl": null,
+        "tran": null,
+        "rev": null,
+        "vendor": null
+      },
+      ...
+    ]
+
+<a id="jc.parsers.lsblk.parse"></a>
+
+### parse
+
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -287,10 +287,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux
+
+Version 1.9 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsmod.md

@@ -1,13 +1,35 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lsmod"></a>
+
 # jc.parsers.lsmod
-jc - JSON CLI output utility lsmod Parser
 
-Usage:
+jc - JSON Convert `lsmod` command output parser
 
-    specify --lsmod as the first argument if the piped input is coming from lsmod
+Usage (cli):
 
-Compatibility:
+    $ lsmod | jc --lsmod
 
-    'linux'
+or
+
+    $ jc lsmod
+
+Usage (module):
+
+    import jc
+    result = jc.parse('lsmod', lsmod_command_output)
+
+Schema:
+
+    [
+      {
+        "module":     string,
+        "size":       integer,
+        "used":       integer,
+        "by": [
+                      string
+        ]
+      }
+    ]
 
 Examples:
 
@@ -103,40 +125,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.lsmod.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "module": string,
-        "size":   integer,
-        "used":   integer,
-        "by": [
-                  string
-        ]
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -144,10 +138,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux
+
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsof.md

@@ -1,13 +1,39 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lsof"></a>
+
 # jc.parsers.lsof
-jc - JSON CLI output utility lsof Parser
 
-Usage:
+jc - JSON Convert `lsof` command output parser
 
-    specify --lsof as the first argument if the piped input is coming from lsof
+Usage (cli):
 
-Compatibility:
+    $ lsof | jc --lsof
 
-    'linux'
+or
+
+    $ jc lsof
+
+Usage (module):
+
+    import jc
+    result = jc.parse('lsof', lsof_command_output)
+
+Schema:
+
+    [
+      {
+        "command":    string,
+        "pid":        integer,
+        "tid":        integer,
+        "user":       string,
+        "fd":         string,
+        "type":       string,
+        "device":     string,
+        "size_off":   integer,
+        "node":       integer,
+        "name":       string
+      }
+    ]
 
 Examples:
 
@@ -93,44 +119,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.lsof.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "command":    string,
-        "pid":        integer,
-        "tid":        integer,
-        "user":       string,
-        "fd":         string,
-        "type":       string,
-        "device":     string,
-        "size_off":   integer,
-        "node":       integer,
-        "name":       string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -138,10 +132,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, aix, freebsd
+
+Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lspci.md

@@ -0,0 +1,148 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lspci"></a>
+
+# jc.parsers.lspci
+
+jc - JSON Convert `lspci -mmv` command output parser
+
+This parser supports the following `lspci` options:
+- `-mmv`
+- `-nmmv`
+- `-nnmmv`
+
+Usage (cli):
+
+    $ lspci -nnmmv | jc --lspci
+
+or
+
+    $ jc lspci -nnmmv
+
+Usage (module):
+
+    import jc
+    result = jc.parse('lspci', lspci_command_output)
+
+Schema:
+
+    [
+      {
+        "slot":                         string,
+        "domain":                       string,
+        "domain_int":                   integer,
+        "bus":                          string,
+        "bus_int":                      integer,
+        "dev":                          string,
+        "dev_int":                      integer,
+        "function":                     string,
+        "function_int":                 integer,
+        "class":                        string,
+        "class_id":                     string,
+        "class_id_int":                 integer,
+        "vendor":                       string,
+        "vendor_id":                    string,
+        "vendor_id_int":                integer,
+        "device":                       string,
+        "device_id":                    string,
+        "device_id_int":                integer,
+        "svendor":                      string,
+        "svendor_id":                   string,
+        "svendor_id_int":               integer,
+        "sdevice":                      string,
+        "sdevice_id":                   string,
+        "sdevice_id_int":               integer,
+        "rev":                          string,
+        "physlot":                      string,
+        "physlot_int":                  integer,
+        "progif":                       string,
+        "progif_int":                   integer
+      }
+    ]
+
+Examples:
+
+    $ lspci -nnmmv | jc --lspci -p
+    [
+      {
+        "slot": "ff:02:05.0",
+        "domain": "ff",
+        "domain_int": 255,
+        "bus": "02",
+        "bus_int": 2,
+        "dev": "05",
+        "dev_int": 5,
+        "function": "0",
+        "function_int": 0,
+        "class": "SATA controller",
+        "class_id": "0106",
+        "class_id_int": 262,
+        "vendor": "VMware",
+        "vendor_id": "15ad",
+        "vendor_id_int": 5549,
+        "device": "SATA AHCI controller",
+        "device_id": "07e0",
+        "device_id_int": 2016,
+        "svendor": "VMware",
+        "svendor_id": "15ad",
+        "svendor_id_int": 5549,
+        "sdevice": "SATA AHCI controller",
+        "sdevice_id": "07e0",
+        "sdevice_id_int": 2016,
+        "physlot": "37",
+        "physlot_int": 55,
+        "progif": "01",
+        "progif_int": 1
+      },
+      ...
+    ]
+
+    $ lspci -nnmmv | jc --lspci -p -r
+    [
+      {
+        "slot": "ff:02:05.0",
+        "domain": "ff",
+        "bus": "02",
+        "dev": "05",
+        "function": "0",
+        "class": "SATA controller",
+        "class_id": "0106",
+        "vendor": "VMware",
+        "vendor_id": "15ad",
+        "device": "SATA AHCI controller",
+        "device_id": "07e0",
+        "svendor": "VMware",
+        "svendor_id": "15ad",
+        "sdevice": "SATA AHCI controller",
+        "sdevice_id": "07e0",
+        "physlot": "37",
+        "progif": "01"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.lspci.parse"></a>
+
+### parse
+
+```python
+def parse(data: str,
+          raw: bool = False,
+          quiet: bool = False) -> List[JSONDictType]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/lsusb.md

@@ -0,0 +1,293 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.lsusb"></a>
+
+# jc.parsers.lsusb
+
+jc - JSON Convert `lsusb` command output parser
+
+Supports the `-v` option or no options.
+
+Usage (cli):
+
+    $ lsusb -v | jc --lsusb
+
+or
+
+    $ jc lsusb -v
+
+Usage (module):
+
+    import jc
+    result = jc.parse('lsusb', lsusb_command_output)
+
+Schema:
+
+> Note: <item> object keynames are assigned directly from the lsusb
+> output. If there are duplicate <item> names in a section, only the
+> last one is converted.
+
+    [
+      {
+        "bus":                                string,
+        "device":                             string,
+        "id":                                 string,
+        "description":                        string,
+        "device_descriptor": {
+          "<item>": {
+            "value":                          string,
+            "description":                    string,
+            "attributes": [
+                                              string
+            ]
+          },
+          "configuration_descriptor": {
+            "<item>": {
+              "value":                        string,
+              "description":                  string,
+              "attributes": [
+                                              string
+              ]
+            },
+            "interface_association": {
+              "<item>": {
+                "value":                      string,
+                "description":                string,
+                "attributes": [
+                                              string
+                ]
+              }
+            },
+            "interface_descriptors": [
+              {
+                "<item>": {
+                  "value":                    string,
+                  "description":              string,
+                  "attributes": [
+                                              string
+                  ]
+                },
+                "cdc_header": {
+                  "<item>": {
+                    "value":                  string,
+                    "description":            string,
+                    "attributes": [
+                                              string
+                    ]
+                  }
+                },
+                "cdc_call_management": {
+                  "<item>": {
+                    "value":                  string,
+                    "description":            string,
+                    "attributes": [
+                                              string
+                    ]
+                  }
+                },
+                "cdc_acm": {
+                  "<item>": {
+                    "value":                  string,
+                    "description":            string,
+                    "attributes": [
+                                              string
+                    ]
+                  }
+                },
+                "cdc_union": {
+                  "<item>": {
+                    "value":                  string,
+                    "description":            string,
+                    "attributes": [
+                                              string
+                    ]
+                  }
+                },
+                "endpoint_descriptors": [
+                  {
+                    "<item>": {
+                      "value":                string,
+                      "description":          string,
+                      "attributes": [
+                                              string
+                      ]
+                    }
+                  }
+                ]
+              }
+            ]
+          }
+        },
+        "hub_descriptor": {
+          "<item>": {
+            "value":                          string,
+            "description":                    string,
+            "attributes": [
+                                              string,
+            ]
+          },
+          "hub_port_status": {
+            "<item>": {
+              "value":                        string,
+              "attributes": [
+                                              string
+              ]
+            }
+          }
+        },
+        "device_qualifier": {
+          "<item>": {
+            "value":                          string,
+            "description":                    string
+          }
+        },
+        "device_status": {
+          "value":                            string,
+          "description":                      string
+        }
+      }
+    ]
+
+Examples:
+
+    $ lsusb -v | jc --lsusb -p
+    [
+      {
+        "bus": "002",
+        "device": "001",
+        "id": "1d6b:0001",
+        "description": "Linux Foundation 1.1 root hub",
+        "device_descriptor": {
+          "bLength": {
+            "value": "18"
+          },
+          "bDescriptorType": {
+            "value": "1"
+          },
+          "bcdUSB": {
+            "value": "1.10"
+          },
+          ...
+          "bNumConfigurations": {
+            "value": "1"
+          },
+          "configuration_descriptor": {
+            "bLength": {
+              "value": "9"
+            },
+            ...
+            "iConfiguration": {
+              "value": "0"
+            },
+            "bmAttributes": {
+              "value": "0xe0",
+              "attributes": [
+                "Self Powered",
+                "Remote Wakeup"
+              ]
+            },
+            "MaxPower": {
+              "description": "0mA"
+            },
+            "interface_descriptors": [
+              {
+                "bLength": {
+                  "value": "9"
+                },
+                ...
+                "bInterfaceProtocol": {
+                  "value": "0",
+                  "description": "Full speed (or root) hub"
+                },
+                "iInterface": {
+                  "value": "0"
+                },
+                "endpoint_descriptors": [
+                  {
+                    "bLength": {
+                      "value": "7"
+                    },
+                    ...
+                    "bmAttributes": {
+                      "value": "3",
+                      "attributes": [
+                        "Transfer Type  Interrupt",
+                        "Synch Type  None",
+                        "Usage Type  Data"
+                      ]
+                    },
+                    "wMaxPacketSize": {
+                      "value": "0x0002",
+                      "description": "1x 2 bytes"
+                    },
+                    "bInterval": {
+                      "value": "255"
+                    }
+                  }
+                ]
+              }
+            ]
+          }
+        },
+        "hub_descriptor": {
+          "bLength": {
+            "value": "9"
+          },
+          ...
+          "wHubCharacteristic": {
+            "value": "0x000a",
+            "attributes": [
+              "No power switching (usb 1.0)",
+              "Per-port overcurrent protection"
+            ]
+          },
+          ...
+          "hub_port_status": {
+            "Port 1": {
+              "value": "0000.0103",
+              "attributes": [
+                "power",
+                "enable",
+                "connect"
+              ]
+            },
+            "Port 2": {
+              "value": "0000.0103",
+              "attributes": [
+                "power",
+                "enable",
+                "connect"
+              ]
+            }
+          }
+        },
+        "device_status": {
+          "value": "0x0001",
+          "description": "Self Powered"
+        }
+      }
+    ]
+
+<a id="jc.parsers.lsusb.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/m3u.md

@@ -0,0 +1,90 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.m3u"></a>
+
+# jc.parsers.m3u
+
+jc - JSON Convert M3U and M3U8 file parser
+
+This parser will make a best-effort to parse extended field information. If
+the extended fields cannot be successfully parsed, then an `unparsed_info`
+field will be added to the object. If not using `--quiet`, then a warning
+message also will be printed to `STDERR`.
+
+Usage (cli):
+
+    $ cat playlist.m3u | jc --m3u
+
+Usage (module):
+
+    import jc
+    result = jc.parse('m3u', m3u_file_output)
+
+Schema:
+
+    [
+      {
+        "runtime":              integer,
+        "display":              string,
+        "path":                 string,
+        <extended fields>:      string,  # [0]
+        "unparsed_info":        string,  # [1]
+      }
+    ]
+
+    [0] Field names are pulled directly from the #EXTINF: line
+    [1] Only added if the extended information cannot be parsed
+
+Examples:
+
+    $ cat playlist.m3u | jc --m3u -p
+    [
+      {
+        "runtime": 105,
+        "display": "Example artist - Example title",
+        "path": "C:\\Files\\My Music\\Example.mp3"
+      },
+      {
+        "runtime": 321,
+        "display": "Example Artist2 - Example title2",
+        "path": "C:\\Files\\My Music\\Favorites\\Example2.ogg"
+      }
+    ]
+
+    $ cat playlist.m3u | jc --m3u -p -r
+    [
+      {
+        "runtime": "105",
+        "display": "Example artist - Example title",
+        "path": "C:\\Files\\My Music\\Example.mp3"
+      },
+      {
+        "runtime": "321",
+        "display": "Example Artist2 - Example title2",
+        "path": "C:\\Files\\My Music\\Favorites\\Example2.ogg"
+      }
+    ]
+
+<a id="jc.parsers.m3u.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mdadm.md

@@ -0,0 +1,252 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.mdadm"></a>
+
+# jc.parsers.mdadm
+
+jc - JSON Convert `mdadm` command output parser
+
+Supports the `--query` and `--examine` options in `mdadm`.
+
+Usage (cli):
+
+    $ mdadm --query --detail /dev/md0 | jc --mdadm
+
+or
+
+    $ mdadm --examine -E /dev/sdb1 | jc --mdadm
+
+or
+
+    $ jc mdadm --query --detail /dev/md0
+
+or
+
+    $ jc mdadm --examine -E /dev/sdb1
+
+Usage (module):
+
+    import jc
+    result = jc.parse('mdadm', mdadm_command_output)
+
+Schema:
+
+    {
+      "device":                       string,
+      "magic":                        string,
+      "version":                      string,
+      "feature_map":                  string,
+      "array_uuid":                   string,
+      "name":                         string,
+      "name_val":                     string,
+      "uuid":                         string,
+      "uuid_val":                     string,
+      "homehost":                     string,
+      "container":                    string,
+      "container_dev":                string,
+      "container_member":             integer,
+      "controller_guid":              string,
+      "container_guid":               string,
+      "seq":                          string,
+      "redundant_hdr":                string,
+      "virtual_disks":                integer,
+      "creation_time":                string,
+      "creation_time_epoch":          integer,  # naive timestamp
+      "raid_level":                   string,
+      "array_size":                   string,
+      "array_size_num":               integer,
+      "used_dev_size":                string,
+      "used_dev_size_num":            integer,
+      "raid_devices":                 integer,
+      "avail_dev_size":               string,
+      "avail_dev_size_num":           integer,
+      "data_offset":                  integer,
+      "super_offset":                 integer,
+      "unused_space":                 string,
+      "unused_space_before":          integer,
+      "unused_space_after":           integer,
+      "state":                        string,
+      "state_list": [
+                                      string
+      ],
+      "device_uuid":                  string,
+      "flags":                        string,
+      "flag_list": [
+                                      string
+      ],
+      "update_time":                  string,
+      "update_time_epoch":            integer,  # naive timestamp
+      "bad_block_log":                string,
+      "checksum":                     string,
+      "checksum_val":                 string,
+      "checksum_state":               string,
+      "events":                       string,
+      "events_num":                   integer,
+      "events_maj":                   integer,
+      "events_min":                   integer,
+      "chunk_size":                   string,
+      "chunk_size_num":               integer,
+      "device_role":                  string,
+      "array_state":                  string,
+      "array_state_list": [
+                                      string
+      ],
+      "member_arrays":                string,
+      "member_arrays_list": [
+                                      string
+      ],
+      "consistency_policy":           string,
+      "rebuild_status":               string,
+      "rebuild_status_percent":       integer,
+      "resync_status":                string,
+      "resync_status_percent":        integer,
+      "check_status":                 string,
+      "check_status_percent":         integer,
+      "total_devices":                integer,
+      "preferred_minor":              integer,
+      "persistence":                  string,
+      "active_devices":               integer,
+      "working_devices":              integer,
+      "failed_devices":               integer,
+      "spare_devices":                integer,
+      "physical_disks":               integer,
+      "device_table": [
+        {
+          "number":                   integer/null,
+          "major":                    integer/null,
+          "minor":                    integer/null,
+          "state": [
+                                      string
+          ],
+          "device":                   string,
+          "raid_device":              integer/null
+        }
+      ]
+    }
+
+    Any fields unspecified above will be string type.
+
+Examples:
+
+    $ mdadm --query --detail /dev/md0 | jc --mdadm -p
+    {
+      "device": "/dev/md0",
+      "version": "1.1",
+      "creation_time": "Tue Apr 13 23:22:16 2010",
+      "raid_level": "raid1",
+      "array_size": "5860520828 (5.46 TiB 6.00 TB)",
+      "used_dev_size": "5860520828 (5.46 TiB 6.00 TB)",
+      "raid_devices": 2,
+      "total_devices": 2,
+      "persistence": "Superblock is persistent",
+      "intent_bitmap": "Internal",
+      "update_time": "Tue Jul 26 20:16:31 2022",
+      "state": "clean",
+      "active_devices": 2,
+      "working_devices": 2,
+      "failed_devices": 0,
+      "spare_devices": 0,
+      "consistency_policy": "bitmap",
+      "name": "virttest:0",
+      "uuid": "85c5b164:d58a5ada:14f5fe07:d642e843",
+      "events": 2193679,
+      "device_table": [
+        {
+          "number": 3,
+          "major": 8,
+          "minor": 17,
+          "state": [
+            "active",
+            "sync"
+          ],
+          "device": "/dev/sdb1",
+          "raid_device": 0
+        },
+        {
+          "number": 2,
+          "major": 8,
+          "minor": 33,
+          "state": [
+            "active",
+            "sync"
+          ],
+          "device": "/dev/sdc1",
+          "raid_device": 1
+        }
+      ],
+      "array_size_num": 5860520828,
+      "used_dev_size_num": 5860520828,
+      "name_val": "virttest:0",
+      "uuid_val": "85c5b164:d58a5ada:14f5fe07:d642e843",
+      "state_list": [
+        "clean"
+      ],
+      "creation_time_epoch": 1271226136,
+      "update_time_epoch": 1658891791
+    }
+
+    $ mdadm --query --detail /dev/md0 | jc --mdadm -p -r
+    {
+      "device": "/dev/md0",
+      "version": "1.1",
+      "creation_time": "Tue Apr 13 23:22:16 2010",
+      "raid_level": "raid1",
+      "array_size": "5860520828 (5.46 TiB 6.00 TB)",
+      "used_dev_size": "5860520828 (5.46 TiB 6.00 TB)",
+      "raid_devices": "2",
+      "total_devices": "2",
+      "persistence": "Superblock is persistent",
+      "intent_bitmap": "Internal",
+      "update_time": "Tue Jul 26 20:16:31 2022",
+      "state": "clean",
+      "active_devices": "2",
+      "working_devices": "2",
+      "failed_devices": "0",
+      "spare_devices": "0",
+      "consistency_policy": "bitmap",
+      "name": "virttest:0",
+      "uuid": "85c5b164:d58a5ada:14f5fe07:d642e843",
+      "events": "2193679",
+      "device_table": [
+        {
+          "number": "3",
+          "major": "8",
+          "minor": "17",
+          "state": "active sync",
+          "device": "/dev/sdb1",
+          "raid_device": "0"
+        },
+        {
+          "number": "2",
+          "major": "8",
+          "minor": "33",
+          "state": "active sync",
+          "device": "/dev/sdc1",
+          "raid_device": "1"
+        }
+      ]
+    }
+
+<a id="jc.parsers.mdadm.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mount.md

@@ -1,13 +1,35 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.mount"></a>
+
 # jc.parsers.mount
-jc - JSON CLI output utility mount Parser
 
-Usage:
+jc - JSON Convert `mount` command output parser
 
-    specify --mount as the first argument if the piped input is coming from mount
+Usage (cli):
 
-Compatibility:
+    $ mount | jc --mount
 
-    'linux', 'darwin'
+or
+
+    $ jc mount
+
+Usage (module):
+
+    import jc
+    result = jc.parse('mount', mount_command_output)
+
+Schema:
+
+    [
+      {
+        "filesystem":       string,
+        "mount_point":      string,
+        "type":             string,
+        "access": [
+                            string
+        ]
+      }
+    ]
 
 Example:
 
@@ -53,40 +75,12 @@ Example:
       ...
     ]
 
-## info
+<a id="jc.parsers.mount.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "filesystem":   string,
-        "mount_point":  string,
-        "type":         string,
-        "access": [
-                        string
-        ]
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -94,10 +88,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, freebsd
+
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mpstat.md

@@ -0,0 +1,140 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.mpstat"></a>
+
+# jc.parsers.mpstat
+
+jc - JSON Convert `mpstat` command output parser
+
+> Note: Latest versions of `mpstat` support JSON output (v11.5.1+)
+
+Usage (cli):
+
+    $ mpstat | jc --mpstat
+
+or
+
+    $ jc mpstat
+
+Usage (module):
+
+    import jc
+    result = jc.parse('mpstat', mpstat_command_output)
+
+Schema:
+
+    [
+      {
+        "type":               string,
+        "time":               string,
+        "cpu":                string,
+        "node":               string,
+        "average":            boolean,
+        "percent_usr":        float,
+        "percent_nice":       float,
+        "percent_sys":        float,
+        "percent_iowait":     float,
+        "percent_irq":        float,
+        "percent_soft":       float,
+        "percent_steal":      float,
+        "percent_guest":      float,
+        "percent_gnice":      float,
+        "percent_idle":       float,
+        "intr_s":             float,
+        "<x>_s":              float,      # <x> is an integer
+        "nmi_s":              float,
+        "loc_s":              float,
+        "spu_s":              float,
+        "pmi_s":              float,
+        "iwi_s":              float,
+        "rtr_s":              float,
+        "res_s":              float,
+        "cal_s":              float,
+        "tlb_s":              float,
+        "trm_s":              float,
+        "thr_s":              float,
+        "dfr_s":              float,
+        "mce_s":              float,
+        "mcp_s":              float,
+        "err_s":              float,
+        "mis_s":              float,
+        "pin_s":              float,
+        "npi_s":              float,
+        "piw_s":              float,
+        "hi_s":               float,
+        "timer_s":            float,
+        "net_tx_s":           float,
+        "net_rx_s":           float,
+        "block_s":            float,
+        "irq_poll_s":         float,
+        "block_iopoll_s":     float,
+        "tasklet_s":          float,
+        "sched_s":            float,
+        "hrtimer_s":          float,
+        "rcu_s":              float
+      }
+    ]
+
+Examples:
+
+    $ mpstat | jc --mpstat -p
+    [
+      {
+        "cpu": "all",
+        "percent_usr": 12.94,
+        "percent_nice": 0.0,
+        "percent_sys": 26.42,
+        "percent_iowait": 0.43,
+        "percent_irq": 0.0,
+        "percent_soft": 0.16,
+        "percent_steal": 0.0,
+        "percent_guest": 0.0,
+        "percent_gnice": 0.0,
+        "percent_idle": 60.05,
+        "type": "cpu",
+        "time": "01:58:14 PM"
+      }
+    ]
+
+    $ mpstat | jc --mpstat -p -r
+    [
+      {
+        "cpu": "all",
+        "percent_usr": "12.94",
+        "percent_nice": "0.00",
+        "percent_sys": "26.42",
+        "percent_iowait": "0.43",
+        "percent_irq": "0.00",
+        "percent_soft": "0.16",
+        "percent_steal": "0.00",
+        "percent_guest": "0.00",
+        "percent_gnice": "0.00",
+        "percent_idle": "60.05",
+        "type": "cpu",
+        "time": "01:58:14 PM"
+      }
+    ]
+
+<a id="jc.parsers.mpstat.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/mpstat_s.md

@@ -0,0 +1,128 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.mpstat_s"></a>
+
+# jc.parsers.mpstat\_s
+
+jc - JSON Convert `mpstat` command output streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+> Note: Latest versions of `mpstat` support JSON output (v11.5.1+)
+
+Usage (cli):
+
+    $ mpstat | jc --mpstat-s
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('mpstat_s', mpstat_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "type":               string,
+      "time":               string,
+      "cpu":                string,
+      "node":               string,
+      "average":            boolean,
+      "percent_usr":        float,
+      "percent_nice":       float,
+      "percent_sys":        float,
+      "percent_iowait":     float,
+      "percent_irq":        float,
+      "percent_soft":       float,
+      "percent_steal":      float,
+      "percent_guest":      float,
+      "percent_gnice":      float,
+      "percent_idle":       float,
+      "intr_s":             float,
+      "<x>_s":              float,      # <x> is an integer
+      "nmi_s":              float,
+      "loc_s":              float,
+      "spu_s":              float,
+      "pmi_s":              float,
+      "iwi_s":              float,
+      "rtr_s":              float,
+      "res_s":              float,
+      "cal_s":              float,
+      "tlb_s":              float,
+      "trm_s":              float,
+      "thr_s":              float,
+      "dfr_s":              float,
+      "mce_s":              float,
+      "mcp_s":              float,
+      "err_s":              float,
+      "mis_s":              float,
+      "pin_s":              float,
+      "npi_s":              float,
+      "piw_s":              float,
+      "hi_s":               float,
+      "timer_s":            float,
+      "net_tx_s":           float,
+      "net_rx_s":           float,
+      "block_s":            float,
+      "irq_poll_s":         float,
+      "block_iopoll_s":     float,
+      "tasklet_s":          float,
+      "sched_s":            float,
+      "hrtimer_s":          float,
+      "rcu_s":              float,
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":          boolean,     # false if error parsing
+        "error":            string,      # exists if "success" is false
+        "line":             string       # exists if "success" is false
+      }
+    }
+
+Examples:
+
+    $ mpstat -A | jc --mpstat-s
+    {"cpu":"all","percent_usr":0.22,"percent_nice":0.0,"percent_sys":...}
+    {"cpu":"0","percent_usr":0.22,"percent_nice":0.0,"percent_sys":0....}
+    {"cpu":"all","intr_s":37.61,"type":"interrupts","time":"03:15:06 PM"}
+    ...
+
+    $ mpstat -A | jc --mpstat-s -r
+    {"cpu":"all","percent_usr":"0.22","percent_nice":"0.00","percent_...}
+    {"cpu":"0","percent_usr":"0.22","percent_nice":"0.00","percent_sy...}
+    {"cpu":"all","intr_s":"37.61","type":"interrupts","time":"03:15:06 PM"}
+    ...
+
+<a id="jc.parsers.mpstat_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+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 iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/netstat.md

@@ -1,17 +1,132 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.netstat"></a>
+
 # jc.parsers.netstat
-jc - JSON CLI output utility netstat Parser
 
-Usage:
+jc - JSON Convert `netstat` command output parser
 
-    Specify --netstat as the first argument if the piped input is coming from netstat
+Caveats:
+- Use of multiple `l` options is not supported on OSX (e.g. `netstat -rlll`)
+- Use of the `A` option is not supported on OSX when using the `r` option
+  (e.g. `netstat -rA`)
 
-Compatibility:
+Usage (cli):
 
-    'linux'
+    $ netstat | jc --netstat
+
+or
+
+    $ jc netstat
+
+Usage (module):
+
+    import jc
+    result = jc.parse('netstat', netstat_command_output)
+
+Schema:
+
+    [
+      {
+        "proto":                  string,
+        "recv_q":                 integer,
+        "send_q":                 integer,
+        "transport_protocol"      string,
+        "network_protocol":       string,
+        "local_address":          string,
+        "local_port":             string,
+        "local_port_num":         integer,
+        "foreign_address":        string,
+        "foreign_port":           string,
+        "foreign_port_num":       integer,
+        "state":                  string,
+        "program_name":           string,
+        "pid":                    integer,
+        "user":                   string,
+        "security_context":       string,
+        "refcnt":                 integer,
+        "flags":                  string,
+        "type":                   string,
+        "inode":                  integer,
+        "path":                   string,
+        "kind":                   string,
+        "address":                string,
+        "unix_inode":             string,
+        "conn":                   string,
+        "refs":                   string,
+        "nextref":                string,
+        "name":                   string,
+        "unit":                   integer,
+        "vendor":                 integer,
+        "class":                  integer,
+        "subcla":                 integer,
+        "unix_flags":             integer,
+        "pcbcount":               integer,
+        "rcvbuf":                 integer,
+        "sndbuf":                 integer,
+        "rxbytes":                integer,
+        "txbytes":                integer,
+        "destination":            string,
+        "gateway":                string,
+        "route_flags":            string,
+        "route_flags_pretty": [
+                                  string,
+        ]
+        "route_refs":             integer,
+        "use":                    integer,
+        "mtu":                    integer,
+        "expire":                 string,
+        "genmask":                string,
+        "mss":                    integer,
+        "window":                 integer,
+        "irtt":                   integer,
+        "iface":                  string,
+        "metric":                 integer,
+        "network":                string,
+        "address":                string,
+        "ipkts":                  integer,    # - = null
+        "ierrs":                  integer,    # - = null
+        "idrop":                  integer,    # - = null
+        "opkts":                  integer,    # - = null
+        "oerrs":                  integer,    # - = null
+        "coll":                   integer,    # - = null
+        "rx_ok":                  integer,
+        "rx_err":                 integer,
+        "rx_drp":                 integer,
+        "rx_ovr":                 integer,
+        "tx_ok":                  integer,
+        "tx_err":                 integer,
+        "tx_drp":                 integer,
+        "tx_ovr":                 integer,
+        "flg":                    string,
+        "ibytes":                 integer,
+        "obytes":                 integer,
+        "r_mbuf":                 integer,
+        "s_mbuf":                 integer,
+        "r_clus":                 integer,
+        "s_clus":                 integer,
+        "r_hiwa":                 integer,
+        "s_hiwa":                 integer,
+        "r_lowa":                 integer,
+        "s_lowa":                 integer,
+        "r_bcnt":                 integer,
+        "s_bcnt":                 integer,
+        "r_bmax":                 integer,
+        "s_bmax":                 integer,
+        "rexmit":                 integer,
+        "ooorcv":                 integer,
+        "0_win":                  integer,
+        "rexmt":                  float,
+        "persist":                float,
+        "keep":                   float,
+        "2msl":                   float,
+        "delack":                 float,
+        "rcvtime":                float,
+      }
+    ]
 
 Examples:
 
-    $ sudo netstat -apee | jc --netstat -p
+    # netstat -apee | jc --netstat -p
     [
       {
         "proto": "tcp",
@@ -161,204 +276,91 @@ Examples:
       ...
     ]
 
-    $ sudo netstat -apee | jc --netstat -p -r
+    $ netstat -r | jc --netstat -p
     [
       {
-        "proto": "tcp",
-        "recv_q": "0",
-        "send_q": "0",
-        "local_address": "localhost",
-        "foreign_address": "0.0.0.0",
-        "state": "LISTEN",
-        "user": "systemd-resolve",
-        "inode": "26958",
-        "program_name": "systemd-resolve",
-        "kind": "network",
-        "pid": "887",
-        "local_port": "domain",
-        "foreign_port": "*",
-        "transport_protocol": "tcp",
-        "network_protocol": "ipv4"
+        "destination": "default",
+        "gateway": "gateway",
+        "genmask": "0.0.0.0",
+        "route_flags": "UG",
+        "mss": 0,
+        "window": 0,
+        "irtt": 0,
+        "iface": "ens33",
+        "kind": "route",
+        "route_flags_pretty": [
+          "UP",
+          "GATEWAY"
+        ]
       },
       {
-        "proto": "tcp",
-        "recv_q": "0",
-        "send_q": "0",
-        "local_address": "0.0.0.0",
-        "foreign_address": "0.0.0.0",
-        "state": "LISTEN",
-        "user": "root",
-        "inode": "30499",
-        "program_name": "sshd",
-        "kind": "network",
-        "pid": "1186",
-        "local_port": "ssh",
-        "foreign_port": "*",
-        "transport_protocol": "tcp",
-        "network_protocol": "ipv4"
+        "destination": "172.17.0.0",
+        "gateway": "0.0.0.0",
+        "genmask": "255.255.0.0",
+        "route_flags": "U",
+        "mss": 0,
+        "window": 0,
+        "irtt": 0,
+        "iface": "docker0",
+        "kind": "route",
+        "route_flags_pretty": [
+          "UP"
+        ]
       },
       {
-        "proto": "tcp",
-        "recv_q": "0",
-        "send_q": "0",
-        "local_address": "localhost",
-        "foreign_address": "localhost",
-        "state": "ESTABLISHED",
-        "user": "root",
-        "inode": "46829",
-        "program_name": "sshd: root",
-        "kind": "network",
-        "pid": "2242",
-        "local_port": "ssh",
-        "foreign_port": "52186",
-        "transport_protocol": "tcp",
-        "network_protocol": "ipv4"
-      },
-      {
-        "proto": "tcp",
-        "recv_q": "0",
-        "send_q": "0",
-        "local_address": "localhost",
-        "foreign_address": "localhost",
-        "state": "ESTABLISHED",
-        "user": "root",
-        "inode": "46828",
-        "program_name": "ssh",
-        "kind": "network",
-        "pid": "2241",
-        "local_port": "52186",
-        "foreign_port": "ssh",
-        "transport_protocol": "tcp",
-        "network_protocol": "ipv4"
-      },
-      {
-        "proto": "tcp6",
-        "recv_q": "0",
-        "send_q": "0",
-        "local_address": "[::]",
-        "foreign_address": "[::]",
-        "state": "LISTEN",
-        "user": "root",
-        "inode": "30510",
-        "program_name": "sshd",
-        "kind": "network",
-        "pid": "1186",
-        "local_port": "ssh",
-        "foreign_port": "*",
-        "transport_protocol": "tcp",
-        "network_protocol": "ipv6"
-      },
-      {
-        "proto": "udp",
-        "recv_q": "0",
-        "send_q": "0",
-        "local_address": "localhost",
-        "foreign_address": "0.0.0.0",
-        "state": null,
-        "user": "systemd-resolve",
-        "inode": "26957",
-        "program_name": "systemd-resolve",
-        "kind": "network",
-        "pid": "887",
-        "local_port": "domain",
-        "foreign_port": "*",
-        "transport_protocol": "udp",
-        "network_protocol": "ipv4"
-      },
-      {
-        "proto": "raw6",
-        "recv_q": "0",
-        "send_q": "0",
-        "local_address": "[::]",
-        "foreign_address": "[::]",
-        "state": "7",
-        "user": "systemd-network",
-        "inode": "27001",
-        "program_name": "systemd-network",
-        "kind": "network",
-        "pid": "867",
-        "local_port": "ipv6-icmp",
-        "foreign_port": "*",
-        "transport_protocol": null,
-        "network_protocol": "ipv6"
-      },
-      {
-        "proto": "unix",
-        "refcnt": "2",
-        "flags": null,
-        "type": "DGRAM",
-        "state": null,
-        "inode": "33322",
-        "program_name": "systemd",
-        "path": "/run/user/1000/systemd/notify",
-        "kind": "socket",
-        "pid": " 1607"
-      },
-      {
-        "proto": "unix",
-        "refcnt": "2",
-        "flags": "ACC",
-        "type": "SEQPACKET",
-        "state": "LISTENING",
-        "inode": "20835",
-        "program_name": "init",
-        "path": "/run/udev/control",
-        "kind": "socket",
-        "pid": " 1"
-      },
-      ...
-    ]
-
-## info
-```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "proto":             string,
-        "recv_q":            integer,
-        "send_q":            integer,
-        "transport_protocol" string,
-        "network_protocol":  string,
-        "local_address":     string,
-        "local_port":        string,
-        "local_port_num":    integer,
-        "foreign_address":   string,
-        "foreign_port":      string,
-        "foreign_port_num":  integer,
-        "state":             string,
-        "program_name":      string,
-        "pid":               integer,
-        "user":              string,
-        "security_context":  string,
-        "refcnt":            integer,
-        "flags":             string,
-        "type":              string,
-        "inode":             integer,
-        "path":              string,
-        "kind":              string
+        "destination": "192.168.71.0",
+        "gateway": "0.0.0.0",
+        "genmask": "255.255.255.0",
+        "route_flags": "U",
+        "mss": 0,
+        "window": 0,
+        "irtt": 0,
+        "iface": "ens33",
+        "kind": "route",
+        "route_flags_pretty": [
+          "UP"
+        ]
       }
     ]
 
-## parse
+    $ netstat -i | jc --netstat -p
+    [
+      {
+        "iface": "ens33",
+        "mtu": 1500,
+        "rx_ok": 476,
+        "rx_err": 0,
+        "rx_drp": 0,
+        "rx_ovr": 0,
+        "tx_ok": 312,
+        "tx_err": 0,
+        "tx_drp": 0,
+        "tx_ovr": 0,
+        "flg": "BMRU",
+        "kind": "interface"
+      },
+      {
+        "iface": "lo",
+        "mtu": 65536,
+        "rx_ok": 0,
+        "rx_err": 0,
+        "rx_drp": 0,
+        "rx_ovr": 0,
+        "tx_ok": 0,
+        "tx_err": 0,
+        "tx_drp": 0,
+        "tx_ovr": 0,
+        "flg": "LRU",
+        "kind": "interface"
+      }
+    ]
+
+<a id="jc.parsers.netstat.parse"></a>
+
+### parse
+
 ```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -366,10 +368,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, freebsd
+
+Version 1.13 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/nmcli.md

@@ -0,0 +1,171 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.nmcli"></a>
+
+# jc.parsers.nmcli
+
+jc - JSON Convert `nmcli` command output parser
+
+Supports the following `nmcli` subcommands:
+- `nmcli general`
+- `nmcli general permissions`
+- `nmcli connection`
+- `nmcli connection show <device_name>`
+- `nmcli device`
+- `nmcli device show`
+- `nmcli device show <device_name>`
+
+Usage (cli):
+
+    $ nmcli device show lo | jc --nmcli
+
+or
+
+    $ jc nmcli device show lo
+
+Usage (module):
+
+    import jc
+    result = jc.parse('nmcli', nmcli_command_output)
+
+Schema:
+
+Because there are so many options, the schema is not strictly defined.
+Integer and Float value conversions are attempted and the original
+values are kept if they fail. If you don't want automatic conversion,
+then use the `-r` or `raw=True` option to disable it.
+
+The structure is flat, for the most part, but there are a couple of
+"well-known" keys that are further parsed into objects for convenience.
+These are documented below.
+
+    [
+      {
+        "<key>":                  string/integer/float,   # [0]
+        "dhcp4_option_x": {
+          "name":                 string,
+          "value":                string/integer/float,
+        },
+        "dhcp6_option_x": {
+          "name":                 string,
+          "value":                string/integer/float,
+        },
+        "ip4_route_x": {
+          "dst":                  string,
+          "nh":                   string,
+          "mt":                   integer
+        },
+        "ip6_route_x": {
+          "dst":                  string,
+          "nh":                   string,
+          "mt":                   integer,
+          "table":                integer
+        }
+      }
+    ]
+
+    [0] all values of `---` are converted to null
+
+Examples:
+
+    $ nmcli connection show ens33 | jc --nmcli -p
+    [
+      {
+        "connection_id": "ens33",
+        "connection_uuid": "d92ece08-9e02-47d5-b2d2-92c80e155744",
+        "connection_stable_id": null,
+        "connection_type": "802-3-ethernet",
+        "connection_interface_name": "ens33",
+        "connection_autoconnect": "yes",
+        ...
+        "ip4_address_1": "192.168.71.180/24",
+        "ip4_gateway": "192.168.71.2",
+        "ip4_route_1": {
+          "dst": "0.0.0.0/0",
+          "nh": "192.168.71.2",
+          "mt": 100
+        },
+        "ip4_route_2": {
+          "dst": "192.168.71.0/24",
+          "nh": "0.0.0.0",
+          "mt": 100
+        },
+        "ip4_dns_1": "192.168.71.2",
+        "ip4_domain_1": "localdomain",
+        "dhcp4_option_1": {
+          "name": "broadcast_address",
+          "value": "192.168.71.255"
+        },
+        ...
+        "ip6_address_1": "fe80::c1cb:715d:bc3e:b8a0/64",
+        "ip6_gateway": null,
+        "ip6_route_1": {
+          "dst": "fe80::/64",
+          "nh": "::",
+          "mt": 100
+        }
+      }
+    ]
+
+    $ nmcli connection show ens33 | jc --nmcli -p -r
+    [
+      {
+        "connection_id": "ens33",
+        "connection_uuid": "d92ece08-9e02-47d5-b2d2-92c80e155744",
+        "connection_stable_id": null,
+        "connection_type": "802-3-ethernet",
+        "connection_interface_name": "ens33",
+        "connection_autoconnect": "yes",
+        ...
+        "ip4_address_1": "192.168.71.180/24",
+        "ip4_gateway": "192.168.71.2",
+        "ip4_route_1": {
+          "dst": "0.0.0.0/0",
+          "nh": "192.168.71.2",
+          "mt": "100"
+        },
+        "ip4_route_2": {
+          "dst": "192.168.71.0/24",
+          "nh": "0.0.0.0",
+          "mt": "100"
+        },
+        "ip4_dns_1": "192.168.71.2",
+        "ip4_domain_1": "localdomain",
+        "dhcp4_option_1": {
+          "name": "broadcast_address",
+          "value": "192.168.71.255"
+        },
+        ...
+        "ip6_address_1": "fe80::c1cb:715d:bc3e:b8a0/64",
+        "ip6_gateway": null,
+        "ip6_route_1": {
+          "dst": "fe80::/64",
+          "nh": "::",
+          "mt": "100"
+        }
+      }
+    ]
+
+<a id="jc.parsers.nmcli.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ntpq.md

@@ -1,13 +1,40 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ntpq"></a>
+
 # jc.parsers.ntpq
-jc - JSON CLI output utility ntpq Parser
 
-Usage:
+jc - JSON Convert `ntpq -p` command output parser
 
-    specify --ntpq as the first argument if the piped input is coming from ntpq -p
+Usage (cli):
 
-Compatibility:
+    $ ntpq -p | jc --ntpq
 
-    'linux'
+or
+
+    $ jc ntpq -p
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ntpq', ntpq_command_output)
+
+Schema:
+
+    [
+      {
+        "state":            string,        # space/~ converted to null
+        "remote":           string,
+        "refid":            string,
+        "st":               integer,
+        "t":                string,
+        "when":             integer,       # - converted to null
+        "poll":             integer,
+        "reach":            integer,
+        "delay":            float,
+        "offset":           float,
+        "jitter":           float
+      },
+    ]
 
 Examples:
 
@@ -179,46 +206,12 @@ Examples:
       }
     ]
 
-## info
+<a id="jc.parsers.ntpq.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "state":            string,        # space/~ converted to null
-        "remote":           string,
-        "refid":            string,
-        "st":               integer,
-        "t":                string,
-        "when":             integer,       # - converted to null
-        "poll":             integer,
-        "reach":            integer,
-        "delay":            float,
-        "offset":           float,
-        "jitter":           float
-      },
-    ]
-
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -226,10 +219,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, freebsd
+
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/os_prober.md

@@ -0,0 +1,63 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.os_prober"></a>
+
+# jc.parsers.os\_prober
+
+jc - JSON Convert `os-prober` command output parser
+
+Usage (cli):
+
+    $ os-prober | jc --os-prober
+
+or
+
+    $ jc os-prober
+
+Usage (module):
+
+    import jc
+    result = jc.parse('os_prober', os_prober_command_output)
+
+Schema:
+
+    {
+      'partition':              string,
+      'name':                   string,
+      'short_name':             string,
+      'type':                   string
+    }
+
+Examples:
+
+    $ os-prober | jc --os-prober -p
+    {
+      "partition": "/dev/sda1",
+      "name": "Windows 10",
+      "short_name": "Windows",
+      "type": "chain"
+    }
+
+<a id="jc.parsers.os_prober.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> JSONDictType
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/passwd.md

@@ -1,13 +1,32 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.passwd"></a>
+
 # jc.parsers.passwd
-jc - JSON CLI output utility /etc/passwd file Parser
 
-Usage:
+jc - JSON Convert `/etc/passwd` file Parser
 
-    specify --passwd as the first argument if the piped input is coming from /etc/passwd
+Usage (cli):
 
-Compatibility:
+    $ cat /etc/passwd | jc --passwd
 
-    'linux', 'darwin', 'aix', 'freebsd'
+Usage (module):
+
+    import jc
+    result = jc.parse('passwd', passwd_file_output)
+
+Schema:
+
+    [
+      {
+        "username":     string,
+        "password":     string,
+        "uid":          integer,
+        "gid":          integer,
+        "comment":      string,
+        "home":         string,
+        "shell":        string
+      }
+    ]
 
 Examples:
 
@@ -75,41 +94,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.passwd.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "username":  string,
-        "password":  string,
-        "uid":       integer,
-        "gid":       integer,
-        "comment":   string,
-        "home":      string,
-        "shell":     string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -117,10 +107,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, aix, freebsd
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pci_ids.md

@@ -0,0 +1,99 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pci_ids"></a>
+
+# jc.parsers.pci\_ids
+
+jc - JSON Convert `pci.ids` file parser
+
+This parser converts the pci.ids database file.
+
+https://raw.githubusercontent.com/pciutils/pciids/master/pci.ids
+
+A nested schema allows straightforward queries with tools like `jq`. Hex id
+numbers are prefixed with an underscore (`_`) so bracket notation is not
+necessary when referencing. For example:
+
+    $ cat pci.ids | jc --pci-ids | jq '.vendors._9005._0053._9005._ffff.subsystem_name'
+    "AIC-7896 SCSI Controller mainboard implementation"
+
+Here are the vendor and class mappings:
+
+    jq '.vendors._001c._0001._001c._0005.subsystem_name'
+                  |     |     |     |
+                  |     |     |     subdevice
+                  |     |     subvendor
+                  |     device
+                  vendor
+
+    jq '.classes._0c._03._40'
+                  |   |   |
+                  |   |   prog_if
+                  |   subclass
+                  class
+
+Usage (cli):
+
+    $ cat pci.ids | jc --pci-ids
+
+Usage (module):
+
+    import jc
+    result = jc.parse('pci_ids', pci_ids_file_output)
+
+Schema:
+
+    {
+      "vendors": {
+        "_<vendor_id>": {
+          "vendor_name":                 string,
+          "_<device_id>": {
+            "device_name":               string,
+            "_<subvendor_id>": {
+              "_<subdevice_id":          string
+            }
+          }
+        }
+      },
+      "classes": {
+        "_<class_id>": {
+          "class_name":                  string,
+          "_<subclass_id>": {
+            "subclass_name":             string,
+            "_<prog_if>":                string
+          }
+        }
+      }
+    }
+
+Examples:
+
+    $ cat pci.ids | jc --pci-ids | jq '.vendors._001c._0001._001c._0005.subsystem_name'
+    "2 Channel CAN Bus SJC1000 (Optically Isolated)"
+
+    $ cat pci.ids | jc --pci-ids | jq '.classes._0c._03._40'
+    "USB4 Host Interface"
+
+<a id="jc.parsers.pci_ids.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> JSONDictType
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pidstat.md

@@ -0,0 +1,151 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pidstat"></a>
+
+# jc.parsers.pidstat
+
+jc - JSON Convert `pidstat -H` command output parser
+
+Must use the `-H` (or `-h`, if `-H` is not available) option in `pidstat`.
+All other `pidstat` options are supported in combination with this option.
+
+Usage (cli):
+
+    $ pidstat -H | jc --pidstat
+
+or
+
+    $ jc pidstat -H
+
+Usage (module):
+
+    import jc
+    result = jc.parse('pidstat', pidstat_command_output)
+
+Schema:
+
+    [
+      {
+        "time":             integer,
+        "uid":              integer,
+        "pid":              integer,
+        "percent_usr":      float,
+        "percent_system":   float,
+        "percent_guest":    float,
+        "percent_cpu":      float,
+        "cpu":              integer,
+        "minflt_s":         float,
+        "majflt_s":         float,
+        "vsz":              integer,
+        "rss":              integer,
+        "percent_mem":      float,
+        "stksize":          integer,
+        "stkref":           integer,
+        "kb_rd_s":          float,
+        "kb_wr_s":          float,
+        "kb_ccwr_s":        float,
+        "cswch_s":          float,
+        "nvcswch_s":        float,
+        "command":          string
+      }
+    ]
+
+Examples:
+
+    $ pidstat -Hl | jc --pidstat -p
+    [
+      {
+        "time": 1646859134,
+        "uid": 0,
+        "pid": 1,
+        "percent_usr": 0.0,
+        "percent_system": 0.03,
+        "percent_guest": 0.0,
+        "percent_cpu": 0.03,
+        "cpu": 0,
+        "command": "/usr/lib/systemd/systemd --switched-root --system..."
+      },
+      {
+        "time": 1646859134,
+        "uid": 0,
+        "pid": 6,
+        "percent_usr": 0.0,
+        "percent_system": 0.0,
+        "percent_guest": 0.0,
+        "percent_cpu": 0.0,
+        "cpu": 0,
+        "command": "ksoftirqd/0"
+      },
+      {
+        "time": 1646859134,
+        "uid": 0,
+        "pid": 2263,
+        "percent_usr": 0.0,
+        "percent_system": 0.0,
+        "percent_guest": 0.0,
+        "percent_cpu": 0.0,
+        "cpu": 0,
+        "command": "kworker/0:0"
+      }
+    ]
+
+    $ pidstat -Hl | jc --pidstat -p -r
+    [
+      {
+        "time": "1646859134",
+        "uid": "0",
+        "pid": "1",
+        "percent_usr": "0.00",
+        "percent_system": "0.03",
+        "percent_guest": "0.00",
+        "percent_cpu": "0.03",
+        "cpu": "0",
+        "command": "/usr/lib/systemd/systemd --switched-root --system..."
+      },
+      {
+        "time": "1646859134",
+        "uid": "0",
+        "pid": "6",
+        "percent_usr": "0.00",
+        "percent_system": "0.00",
+        "percent_guest": "0.00",
+        "percent_cpu": "0.00",
+        "cpu": "0",
+        "command": "ksoftirqd/0"
+      },
+      {
+        "time": "1646859134",
+        "uid": "0",
+        "pid": "2263",
+        "percent_usr": "0.00",
+        "percent_system": "0.00",
+        "percent_guest": "0.00",
+        "percent_cpu": "0.00",
+        "cpu": "0",
+        "command": "kworker/0:0"
+      }
+    ]
+
+<a id="jc.parsers.pidstat.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pidstat_s.md

@@ -0,0 +1,110 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pidstat_s"></a>
+
+# jc.parsers.pidstat\_s
+
+jc - JSON Convert `pidstat -H` command output streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+Must use the `-H` (or `-h`, if `-H` is not available) option in `pidstat`.
+All other `pidstat` options are supported in combination with this option.
+
+Usage (cli):
+
+    $ pidstat -H | jc --pidstat-s
+
+> Note: When piping `jc` converted `pidstat` output to other processes it
+> may appear the output is hanging due to the OS pipe buffers. This is
+> because `pidstat` output is too small to quickly fill up the buffer. Use
+> the `-u` option to unbuffer the `jc` output if you would like immediate
+> output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
+> for more information.
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('pidstat_s', pidstat_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "time":             integer,
+      "uid":              integer,
+      "pid":              integer,
+      "percent_usr":      float,
+      "percent_system":   float,
+      "percent_guest":    float,
+      "percent_cpu":      float,
+      "cpu":              integer,
+      "minflt_s":         float,
+      "majflt_s":         float,
+      "vsz":              integer,
+      "rss":              integer,
+      "percent_mem":      float,
+      "stksize":          integer,
+      "stkref":           integer,
+      "kb_rd_s":          float,
+      "kb_wr_s":          float,
+      "kb_ccwr_s":        float,
+      "cswch_s":          float,
+      "nvcswch_s":        float,
+      "command":          string,
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":        boolean,     # false if error parsing
+        "error":          string,      # exists if "success" is false
+        "line":           string       # exists if "success" is false
+      }
+    }
+
+Examples:
+
+    $ pidstat -Hl | jc --pidstat-s
+    {"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_syste...}
+    {"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_syste...}
+    {"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_syste...}
+    ...
+
+    $ pidstat -Hl | jc --pidstat-s -r
+    {"time":"1646859134","uid":"0","pid":"1","percent_usr":"0.00","perc...}
+    {"time":"1646859134","uid":"0","pid":"6","percent_usr":"0.00","perc...}
+    {"time":"1646859134","uid":"0","pid":"9","percent_usr":"0.00","perc...}
+    ...
+
+<a id="jc.parsers.pidstat_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+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 iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ping.md

@@ -0,0 +1,188 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ping"></a>
+
+# jc.parsers.ping
+
+jc - JSON Convert `ping` command output parser
+
+Supports `ping` and `ping6` output.
+
+Usage (cli):
+
+> Note:  Use the ping `-c` (count) option, otherwise data will not be
+> piped to `jc`.
+
+    $ ping -c 3 1.2.3.4 | jc --ping
+
+or
+
+    $ jc ping -c 3 1.2.3.4
+
+Usage (module):
+
+    import jc
+    result = jc.parse('ping', ping_command_output)
+
+Schema:
+
+    {
+      "source_ip":                   string,
+      "destination_ip":              string,
+      "data_bytes":                  integer,
+      "pattern":                     string,        # null if not set
+      "destination":                 string,
+      "packets_transmitted":         integer,
+      "packets_received":            integer,
+      "packet_loss_percent":         float,
+      "duplicates":                  integer,
+      "round_trip_ms_min":           float,
+      "round_trip_ms_avg":           float,
+      "round_trip_ms_max":           float,
+      "round_trip_ms_stddev":        float,
+      "responses": [
+        {
+          "type":                    string,        # [0]
+          "unparsed_line":           string,        # [1]
+          "timestamp":               float,
+          "bytes":                   integer,
+          "response_ip":             string,
+          "icmp_seq":                integer,
+          "ttl":                     integer,
+          "time_ms":                 float,
+          "duplicate":               boolean,
+          "vr":                      integer,       # [2]
+          "hl":                      integer,       # [2]
+          "tos":                     integer,       # [2]
+          "len":                     integer,       # [2]
+          "id":                      integer,       # [2]
+          "flg":                     integer,       # [2]
+          "off":                     integer,       # [2]
+          "pro":                     integer,       # [2]
+          "cks":                     ingeger,       # [2]
+          "src":                     string,
+          "dst":                     string
+        }
+      ]
+    }
+
+    [0] 'reply', 'timeout', 'unparsable_line', etc. See
+        `_error_type.type_map` for all options
+    [1] only if an 'unparsable_line' type
+    [2] hex value converted to decimal
+
+Examples:
+
+    $ ping -c 3 -p ff cnn.com | jc --ping -p
+    {
+      "destination_ip": "151.101.1.67",
+      "data_bytes": 56,
+      "pattern": "0xff",
+      "destination": "cnn.com",
+      "packets_transmitted": 3,
+      "packets_received": 3,
+      "packet_loss_percent": 0.0,
+      "duplicates": 0,
+      "round_trip_ms_min": 28.015,
+      "round_trip_ms_avg": 32.848,
+      "round_trip_ms_max": 39.376,
+      "round_trip_ms_stddev": 4.79,
+      "responses": [
+        {
+          "type": "reply",
+          "bytes": 64,
+          "response_ip": "151.101.1.67",
+          "icmp_seq": 0,
+          "ttl": 59,
+          "time_ms": 28.015,
+          "duplicate": false
+        },
+        {
+          "type": "reply",
+          "bytes": 64,
+          "response_ip": "151.101.1.67",
+          "icmp_seq": 1,
+          "ttl": 59,
+          "time_ms": 39.376,
+          "duplicate": false
+        },
+        {
+          "type": "reply",
+          "bytes": 64,
+          "response_ip": "151.101.1.67",
+          "icmp_seq": 2,
+          "ttl": 59,
+          "time_ms": 31.153,
+          "duplicate": false
+        }
+      ]
+    }
+
+    $ ping -c 3 -p ff cnn.com | jc --ping -p -r
+    {
+      "destination_ip": "151.101.129.67",
+      "data_bytes": "56",
+      "pattern": "0xff",
+      "destination": "cnn.com",
+      "packets_transmitted": "3",
+      "packets_received": "3",
+      "packet_loss_percent": "0.0",
+      "duplicates": "0",
+      "round_trip_ms_min": "25.078",
+      "round_trip_ms_avg": "29.543",
+      "round_trip_ms_max": "32.553",
+      "round_trip_ms_stddev": "3.221",
+      "responses": [
+        {
+          "type": "reply",
+          "bytes": "64",
+          "response_ip": "151.101.129.67",
+          "icmp_seq": "0",
+          "ttl": "59",
+          "time_ms": "25.078",
+          "duplicate": false
+        },
+        {
+          "type": "reply",
+          "bytes": "64",
+          "response_ip": "151.101.129.67",
+          "icmp_seq": "1",
+          "ttl": "59",
+          "time_ms": "30.999",
+          "duplicate": false
+        },
+        {
+          "type": "reply",
+          "bytes": "64",
+          "response_ip": "151.101.129.67",
+          "icmp_seq": "2",
+          "ttl": "59",
+          "time_ms": "32.553",
+          "duplicate": false
+        }
+      ]
+    }
+
+<a id="jc.parsers.ping.parse"></a>
+
+### parse
+
+```python
+def parse(data, raw=False, quiet=False)
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    Dictionary. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, freebsd
+
+Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ping_s.md

@@ -0,0 +1,109 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.ping_s"></a>
+
+# jc.parsers.ping\_s
+
+jc - JSON Convert `ping` command output streaming parser
+
+> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
+> Dictionaries (module)
+
+Supports `ping` and `ping6` output.
+
+Usage (cli):
+
+    $ ping 1.2.3.4 | jc --ping-s
+
+> Note: When piping `jc` converted `ping` output to other processes it may
+> appear the output is hanging due to the OS pipe buffers. This is because
+> `ping` output is too small to quickly fill up the buffer. Use the `-u`
+> option to unbuffer the `jc` output if you would like immediate output.
+> See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output)
+> for more information.
+
+Usage (module):
+
+    import jc
+
+    result = jc.parse('ping_s', ping_command_output.splitlines())
+    for item in result:
+        # do something
+
+Schema:
+
+    {
+      "type":                       string,   # [0]
+      "source_ip":                  string,
+      "destination_ip":             string,
+      "sent_bytes":                 integer,
+      "pattern":                    string,   # (null if not set)
+      "destination":                string,
+      "timestamp":                  float,
+      "response_bytes":             integer,
+      "response_ip":                string,
+      "icmp_seq":                   integer,
+      "ttl":                        integer,
+      "time_ms":                    float,
+      "duplicate":                  boolean,
+      "packets_transmitted":        integer,
+      "packets_received":           integer,
+      "packet_loss_percent":        float,
+      "duplicates":                 integer,
+      "round_trip_ms_min":          float,
+      "round_trip_ms_avg":          float,
+      "round_trip_ms_max":          float,
+      "round_trip_ms_stddev":       float,
+
+      # below object only exists if using -qq or ignore_exceptions=True
+      "_jc_meta": {
+        "success":                  boolean,  # false if error parsing
+        "error":                    string,   # exists if "success" is false
+        "line":                     string    # exists if "success" is false
+      }
+    }
+
+    [0] 'reply', 'timeout', 'summary', etc. See `_error_type.type_map`
+        for all options.
+
+Examples:
+
+    $ ping 1.1.1.1 | jc --ping-s
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"patte...}
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"patte...}
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"patte...}
+    ...
+
+    $ ping 1.1.1.1 | jc --ping-s -r
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","patte...}
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","patte...}
+    {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","patte...}
+    ...
+
+<a id="jc.parsers.ping_s.parse"></a>
+
+### parse
+
+```python
+@add_jc_meta
+def parse(data, raw=False, quiet=False, ignore_exceptions=False)
+```
+
+Main text parsing generator function. Returns an iterable object.
+
+Parameters:
+
+    data:              (iterable)  line-based text data to parse
+                                   (e.g. sys.stdin or str.splitlines())
+
+    raw:               (boolean)   unprocessed output if True
+    quiet:             (boolean)   suppress warning messages if True
+    ignore_exceptions: (boolean)   ignore parsing exceptions if True
+
+Returns:
+
+    Iterable of Dictionaries
+
+### Parser Information
+Compatibility:  linux, darwin, freebsd
+
+Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pip_list.md

@@ -1,13 +1,32 @@
-# jc.parsers.pip_list
-jc - JSON CLI output utility pip-list Parser
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pip_list"></a>
 
-Usage:
+# jc.parsers.pip\_list
 
-    specify --pip-list as the first argument if the piped input is coming from pip list
+jc - JSON Convert `pip-list` command output parser
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+    $ pip list | jc --pip-list
+
+or
+
+    $ jc pip list
+
+Usage (module):
+
+    import jc
+    result = jc.parse('pip_list', pip_list_command_output)
+
+Schema:
+
+    [
+      {
+        "package":     string,
+        "version":     string,
+        "location":    string
+      }
+    ]
 
 Examples:
 
@@ -28,37 +47,12 @@ Examples:
       ...
     ]
 
-## info
+<a id="jc.parsers.pip_list.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "package":     string,
-        "version":     string,
-        "location":    string
-      }
-    ]
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data, raw=False, quiet=False)
 ```
 
 Main text parsing function
@@ -66,10 +60,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/pip_show.md

@@ -1,13 +1,39 @@
-# jc.parsers.pip_show
-jc - JSON CLI output utility pip-show Parser
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.pip_show"></a>
 
-Usage:
+# jc.parsers.pip\_show
 
-    specify --pip-show as the first argument if the piped input is coming from pip show
+jc - JSON Convert `pip-show` command output parser
 
-Compatibility:
+Usage (cli):
 
-    'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'
+    $ pip show | jc --pip-show
+
+or
+
+    $ jc pip show
+
+Usage (module):
+
+    import jc
+    result = jc.parse('pip_show', pip_show_command_output)
+
+Schema:
+
+    [
+      {
+        "name":             string,
+        "version":          string,
+        "summary":          string,
+        "home_page":        string,
+        "author":           string,
+        "author_email":     string,
+        "license":          string,
+        "location":         string,
+        "requires":         string,
+        "required_by":      string
+      }
+    ]
 
 Examples:
 
@@ -39,45 +65,12 @@ Examples:
       }
     ]
 
-## info
+<a id="jc.parsers.pip_show.parse"></a>
+
+### parse
+
 ```python
-info(self, /, *args, **kwargs)
-```
-
-## process
-```python
-process(proc_data)
-```
-
-Final processing to conform to the schema.
-
-Parameters:
-
-    proc_data:   (dictionary) raw structured data to process
-
-Returns:
-
-    List of dictionaries. Structured data with the following schema:
-
-    [
-      {
-        "name":             string,
-        "version":          string,
-        "summary":          string,
-        "home_page":        string,
-        "author":           string,
-        "author_email":     string,
-        "license":          string,
-        "location":         string,
-        "requires":         string,
-        "required_by":      string
-      }
-    ]
-
-
-## parse
-```python
-parse(data, raw=False, quiet=False)
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
 ```
 
 Main text parsing function
@@ -85,10 +78,14 @@ Main text parsing function
 Parameters:
 
     data:        (string)  text data to parse
-    raw:         (boolean) output preprocessed JSON if True
+    raw:         (boolean) unprocessed output if True
     quiet:       (boolean) suppress warning messages if True
 
 Returns:
 
-    List of dictionaries. Raw or processed structured data.
+    List of Dictionaries. Raw or processed structured data.
 
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/plist.md

@@ -0,0 +1,77 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.plist"></a>
+
+# jc.parsers.plist
+
+jc - JSON Convert PLIST file parser
+
+Converts binary and XML PLIST files.
+
+Binary values are converted into an ASCII hex representation.
+
+Datetime objects are converted into Unix epoch timestamps and ISO strings.
+The timestamp and ISO string will maintain the same naive or timezone-aware
+properties as the object in the original PLIST file.
+
+Usage (cli):
+
+    $ cat file.plist | jc --plist
+
+Usage (module):
+
+    import jc
+    result = jc.parse('plist', plist_file_output)
+
+Schema:
+
+    {
+      "<key>":            string/integer/float/boolean/object/array/null
+    }
+
+Examples:
+
+    $ cat info.plist | jc --plist -p
+    {
+      "NSAppleScriptEnabled": true,
+      "LSMultipleInstancesProhibited": true,
+      "CFBundleInfoDictionaryVersion": "6.0",
+      "DTPlatformVersion": "GM",
+      "CFBundleIconFile": "GarageBand.icns",
+      "CFBundleName": "GarageBand",
+      "DTSDKName": "macosx10.13internal",
+      "NSSupportsAutomaticGraphicsSwitching": true,
+      "RevisionDate": "2018-12-03_14:10:56",
+      "UTImportedTypeDeclarations": [
+        {
+          "UTTypeConformsTo": [
+            "public.data",
+            "public.content"
+      ...
+    }
+
+<a id="jc.parsers.plist.parse"></a>
+
+### parse
+
+```python
+def parse(data: Union[str, bytes],
+          raw: bool = False,
+          quiet: bool = False) -> Dict
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/postconf.md

@@ -0,0 +1,115 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.postconf"></a>
+
+# jc.parsers.postconf
+
+jc - JSON Convert `postconf -M` command output parser
+
+Usage (cli):
+
+    $ postconf -M | jc --postconf
+
+or
+
+    $ jc postconf -M
+
+Usage (module):
+
+    import jc
+    result = jc.parse('postconf', postconf_command_output)
+
+Schema:
+
+    [
+      {
+        "service_name":                     string,
+        "service_type":                     string,
+        "private":                          boolean/null,  # [0]
+        "unprivileged":                     boolean/null,  # [0]
+        "chroot":                           boolean/null,  # [0]
+        "wake_up_time":                     integer/null,  # [0]
+        "no_wake_up_before_first_use":      boolean/null,  # [1]
+        "process_limit":                    integer/null,  # [0]
+        "command":                          string
+      }
+    ]
+
+    [0] '-' converted to null/None
+    [1] null/None if `wake_up_time` is null/None
+
+Examples:
+
+    $ postconf -M | jc --postconf -p
+    [
+      {
+        "service_name": "smtp",
+        "service_type": "inet",
+        "private": false,
+        "unprivileged": null,
+        "chroot": true,
+        "wake_up_time": null,
+        "process_limit": null,
+        "command": "smtpd",
+        "no_wake_up_before_first_use": null
+      },
+      {
+        "service_name": "pickup",
+        "service_type": "unix",
+        "private": false,
+        "unprivileged": null,
+        "chroot": true,
+        "wake_up_time": 60,
+        "process_limit": 1,
+        "command": "pickup",
+        "no_wake_up_before_first_use": false
+      }
+    ]
+
+    $ postconf -M | jc --postconf -p -r
+    [
+      {
+        "service_name": "smtp",
+        "service_type": "inet",
+        "private": "n",
+        "unprivileged": "-",
+        "chroot": "y",
+        "wake_up_time": "-",
+        "process_limit": "-",
+        "command": "smtpd"
+      },
+      {
+        "service_name": "pickup",
+        "service_type": "unix",
+        "private": "n",
+        "unprivileged": "-",
+        "chroot": "y",
+        "wake_up_time": "60",
+        "process_limit": "1",
+        "command": "pickup"
+      }
+    ]
+
+<a id="jc.parsers.postconf.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc.md

@@ -0,0 +1,142 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc"></a>
+
+# jc.parsers.proc
+
+jc - JSON Convert Proc file output parser
+
+This parser automatically identifies the Proc file and calls the
+corresponding parser to peform the parsing.
+
+Magic syntax for converting `/proc` files is also supported by running
+`jc /proc/<path to file>`. Any `jc` options must be specified before the
+`/proc` path.
+
+specific Proc file parsers can also be called directly, if desired and have
+a naming convention of `proc-<name>` (cli) or `proc_<name>` (module).
+
+Usage (cli):
+
+    $ cat /proc/meminfo | jc --proc
+
+or
+
+    $ jc /proc/meminfo
+
+or
+
+    $ cat /proc/meminfo | jc --proc-memifno
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_file)
+
+Schema:
+
+See the specific Proc parser for the schema:
+
+    $ jc --help --proc-<name>
+
+For example:
+
+    $ jc --help --proc-meminfo
+
+Specific Proc file parser names can be found with `jc -hh` or `jc -a`.
+
+Schemas can also be found online at:
+
+    https://kellyjonbrazil.github.io/jc/docs/parsers/proc_<name>
+
+For example:
+
+    https://kellyjonbrazil.github.io/jc/docs/parsers/proc_meminfo
+
+Examples:
+
+    $ cat /proc/modules | jc --proc -p
+    [
+      {
+        "module": "binfmt_misc",
+        "size": 24576,
+        "used": 1,
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0ab4000"
+      },
+      {
+        "module": "vsock_loopback",
+        "size": 16384,
+        "used": 0,
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0a14000"
+      },
+      {
+        "module": "vmw_vsock_virtio_transport_common",
+        "size": 36864,
+        "used": 1,
+        "used_by": [
+          "vsock_loopback"
+        ],
+        "status": "Live",
+        "location": "0xffffffffc0a03000"
+      },
+      ...
+    ]
+
+    $ cat /proc/modules | jc --proc-modules -p -r
+    [
+      {
+        "module": "binfmt_misc",
+        "size": "24576",
+        "used": "1",
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0ab4000"
+      },
+      {
+        "module": "vsock_loopback",
+        "size": "16384",
+        "used": "0",
+        "used_by": [],
+        "status": "Live",
+        "location": "0xffffffffc0a14000"
+      },
+      {
+        "module": "vmw_vsock_virtio_transport_common",
+        "size": "36864",
+        "used": "1",
+        "used_by": [
+          "vsock_loopback"
+        ],
+        "status": "Live",
+        "location": "0xffffffffc0a03000"
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_buddyinfo.md

@@ -0,0 +1,128 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_buddyinfo"></a>
+
+# jc.parsers.proc\_buddyinfo
+
+jc - JSON Convert `/proc/buddyinfo` file parser
+
+Usage (cli):
+
+    $ cat /proc/buddyinfo | jc --proc
+
+or
+
+    $ jc /proc/buddyinfo
+
+or
+
+    $ cat /proc/buddyinfo | jc --proc-buddyinfo
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_buddyinfo_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_buddyinfo', proc_buddyinfo_file)
+
+Schema:
+
+All values are integers.
+
+    [
+      {
+        "node":               integer,
+        "zone":               string,
+        "free_chunks": [
+                              integer  # [0]
+        ]
+      }
+    ]
+
+    [0] array index correlates to the Order number.
+        E.g. free_chunks[0] is the value for Order 0
+
+
+Examples:
+
+    $ cat /proc/buddyinfo | jc --proc -p
+    [
+      {
+        "node": 0,
+        "zone": "DMA",
+        "free_chunks": [
+          0,
+          0,
+          0,
+          1,
+          1,
+          1,
+          1,
+          1,
+          0,
+          1,
+          3
+        ]
+      },
+      {
+        "node": 0,
+        "zone": "DMA32",
+        "free_chunks": [
+          78,
+          114,
+          82,
+          52,
+          38,
+          25,
+          13,
+          9,
+          3,
+          4,
+          629
+        ]
+      },
+      {
+        "node": 0,
+        "zone": "Normal",
+        "free_chunks": [
+          0,
+          22,
+          8,
+          10,
+          1,
+          1,
+          2,
+          11,
+          13,
+          0,
+          0
+        ]
+      }
+    ]
+
+<a id="jc.parsers.proc_buddyinfo.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_consoles.md

@@ -0,0 +1,111 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_consoles"></a>
+
+# jc.parsers.proc\_consoles
+
+jc - JSON Convert `/proc/consoles` file parser
+
+Usage (cli):
+
+    $ cat /proc/consoles | jc --proc
+
+or
+
+    $ jc /proc/consoles
+
+or
+
+    $ cat /proc/consoles | jc --proc-consoles
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_consoles_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_consoles', proc_consoles_file)
+
+Schema:
+
+    [
+      {
+        "device":                     string,
+        "operations":                 string,
+        "operations_list": [
+                                      string  # [0]
+        ],
+        "flags":                      string,
+        "flags_list": [
+                                      string  # [1]
+        ],
+        "major":                      integer,
+        "minor":                      integer
+      }
+    ]
+
+    [0] Values: read, write, unblank
+    [1] Values: enabled, preferred, primary boot, prink buffer,
+                braille device, safe when CPU offline
+
+Examples:
+
+    $ cat /proc/consoles | jc --proc -p
+    [
+      {
+        "device": "tty0",
+        "operations": "-WU",
+        "operations_list": [
+          "write",
+          "unblank"
+        ],
+        "flags": "ECp",
+        "flags_list": [
+          "enabled",
+          "preferred",
+          "printk buffer"
+        ],
+        "major": 4,
+        "minor": 7
+      },
+      {
+        "device": "ttyS0",
+        "operations": "-W-",
+        "operations_list": [
+          "write"
+        ],
+        "flags": "Ep",
+        "flags_list": [
+          "enabled",
+          "printk buffer"
+        ],
+        "major": 4,
+        "minor": 64
+      }
+    ]
+
+<a id="jc.parsers.proc_consoles.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/proc_cpuinfo.md

@@ -0,0 +1,247 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_cpuinfo"></a>
+
+# jc.parsers.proc\_cpuinfo
+
+jc - JSON Convert `/proc/cpuinfo` file parser
+
+Usage (cli):
+
+    $ cat /proc/cpuinfo | jc --proc
+
+or
+
+    $ jc /proc/cpuinfo
+
+or
+
+    $ cat /proc/cpuinfo | jc --proc-cpuinfo
+
+Usage (module):
+
+    import jc
+    result = jc.parse('proc', proc_cpuinfo_file)
+
+or
+
+    import jc
+    result = jc.parse('proc_cpuinfo', proc_cpuinfo_file)
+
+Schema:
+
+Integer, float, and boolean ("yes"/"no") conversions are attempted. Blank
+strings are converted to `null`.
+
+"Well-known" keys like `cache size`, `address types`, `bugs`, and `flags`
+are processed into sensible data types. (see below)
+
+If this is not desired, then use the `--raw` (CLI) or `raw=True` (Module)
+option.
+
+    [
+      {
+        "processor":                  integer,
+        "address sizes":              string,
+        "address_size_physical":      integer,  # in bits
+        "address_size_virtual":       integer,  # in bits
+        "cache size":                 string,
+        "cache_size_num":             integer,
+        "cache_size_unit":            string,
+        "flags": [
+                                      string
+        ],
+        "bugs": [
+                                      string
+        ],
+        "bogomips":                   float,
+        <key>:                        string/int/float/boolean/null
+      }
+    ]
+
+Examples:
+
+    $ cat /proc/cpuinfo | jc --proc -p
+    [
+      {
+        "processor": 0,
+        "vendor_id": "GenuineIntel",
+        "cpu family": 6,
+        "model": 142,
+        "model name": "Intel(R) Core(TM) i5-8279U CPU @ 2.40GHz",
+        "stepping": 10,
+        "cpu MHz": 2400.0,
+        "cache size": "6144 KB",
+        "physical id": 0,
+        "siblings": 1,
+        "core id": 0,
+        "cpu cores": 1,
+        "apicid": 0,
+        "initial apicid": 0,
+        "fpu": true,
+        "fpu_exception": true,
+        "cpuid level": 22,
+        "wp": true,
+        "bogomips": 4800.0,
+        "clflush size": 64,
+        "cache_alignment": 64,
+        "address sizes": "45 bits physical, 48 bits virtual",
+        "power management": null,
+        "address_size_physical": 45,
+        "address_size_virtual": 48,
+        "cache_size_num": 6144,
+        "cache_size_unit": "KB",
+        "flags": [
+          "fpu",
+          "vme",
+          "de",
+          "pse",
+          "tsc",
+          "msr",
+          "pae",
+          "mce",
+          "cx8",
+          "apic",
+          "sep",
+          "mtrr",
+          "pge",
+          "mca",
+          "cmov",
+          "pat",
+          "pse36",
+          "clflush",
+          "mmx",
+          "fxsr",
+          "sse",
+          "sse2",
+          "ss",
+          "syscall",
+          "nx",
+          "pdpe1gb",
+          "rdtscp",
+          "lm",
+          "constant_tsc",
+          "arch_perfmon",
+          "nopl",
+          "xtopology",
+          "tsc_reliable",
+          "nonstop_tsc",
+          "cpuid",
+          "pni",
+          "pclmulqdq",
+          "ssse3",
+          "fma",
+          "cx16",
+          "pcid",
+          "sse4_1",
+          "sse4_2",
+          "x2apic",
+          "movbe",
+          "popcnt",
+          "tsc_deadline_timer",
+          "aes",
+          "xsave",
+          "avx",
+          "f16c",
+          "rdrand",
+          "hypervisor",
+          "lahf_lm",
+          "abm",
+          "3dnowprefetch",
+          "cpuid_fault",
+          "invpcid_single",
+          "pti",
+          "ssbd",
+          "ibrs",
+          "ibpb",
+          "stibp",
+          "fsgsbase",
+          "tsc_adjust",
+          "bmi1",
+          "avx2",
+          "smep",
+          "bmi2",
+          "invpcid",
+          "rdseed",
+          "adx",
+          "smap",
+          "clflushopt",
+          "xsaveopt",
+          "xsavec",
+          "xgetbv1",
+          "xsaves",
+          "arat",
+          "md_clear",
+          "flush_l1d",
+          "arch_capabilities"
+        ],
+        "bugs": [
+          "cpu_meltdown",
+          "spectre_v1",
+          "spectre_v2",
+          "spec_store_bypass",
+          "l1tf",
+          "mds",
+          "swapgs",
+          "itlb_multihit",
+          "srbds"
+        ]
+      },
+      ...
+    ]
+
+    $ cat /proc/cpuinfo | jc --proc_cpuinfo -p -r
+    [
+      {
+        "processor": "0",
+        "vendor_id": "GenuineIntel",
+        "cpu family": "6",
+        "model": "142",
+        "model name": "Intel(R) Core(TM) i5-8279U CPU @ 2.40GHz",
+        "stepping": "10",
+        "cpu MHz": "2400.000",
+        "cache size": "6144 KB",
+        "physical id": "0",
+        "siblings": "1",
+        "core id": "0",
+        "cpu cores": "1",
+        "apicid": "0",
+        "initial apicid": "0",
+        "fpu": "yes",
+        "fpu_exception": "yes",
+        "cpuid level": "22",
+        "wp": "yes",
+        "flags": "fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge ...",
+        "bugs": "cpu_meltdown spectre_v1 spectre_v2 spec_store_bypass ...",
+        "bogomips": "4800.00",
+        "clflush size": "64",
+        "cache_alignment": "64",
+        "address sizes": "45 bits physical, 48 bits virtual",
+        "power management": ""
+      },
+      ...
+    ]
+
+<a id="jc.parsers.proc_cpuinfo.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)