diff --git a/docs/parsers/os_release.md b/docs/parsers/os_release.md new file mode 100644 index 00000000..8cb9d8b7 --- /dev/null +++ b/docs/parsers/os_release.md @@ -0,0 +1,86 @@ +[Home](https://kellyjonbrazil.github.io/jc/) + + +# jc.parsers.os\_release + +jc - JSON Convert `/etc/os-release` file parser + +This parser is an alias to the Key/Value parser (`--kv`). + +Usage (cli): + + $ cat /etc/os-release | jc --os-release + +Usage (module): + + import jc + result = jc.parse('os_release', os_release_command_output) + +Schema: + + { + "": string + } + +Examples: + + $ cat /etc/os-release | jc --os-release -p + { + "NAME": "CentOS Linux", + "VERSION": "7 (Core)", + "ID": "centos", + "ID_LIKE": "rhel fedora", + "VERSION_ID": "7", + "PRETTY_NAME": "CentOS Linux 7 (Core)", + "ANSI_COLOR": "0;31", + "CPE_NAME": "cpe:/o:centos:centos:7", + "HOME_URL": "https://www.centos.org/", + "BUG_REPORT_URL": "https://bugs.centos.org/", + "CENTOS_MANTISBT_PROJECT": "CentOS-7", + "CENTOS_MANTISBT_PROJECT_VERSION": "7", + "REDHAT_SUPPORT_PRODUCT": "centos", + "REDHAT_SUPPORT_PRODUCT_VERSION": "7" + } + + $ cat /etc/os-release | jc --os-release -p -r + { + "NAME": "\\"CentOS Linux\\"", + "VERSION": "\\"7 (Core)\\"", + "ID": "\\"centos\\"", + "ID_LIKE": "\\"rhel fedora\\"", + "VERSION_ID": "\\"7\\"", + "PRETTY_NAME": "\\"CentOS Linux 7 (Core)\\"", + "ANSI_COLOR": "\\"0;31\\"", + "CPE_NAME": "\\"cpe:/o:centos:centos:7\\"", + "HOME_URL": "\\"https://www.centos.org/\\"", + "BUG_REPORT_URL": "\\"https://bugs.centos.org/\\"", + "CENTOS_MANTISBT_PROJECT": "\\"CentOS-7\\"", + "CENTOS_MANTISBT_PROJECT_VERSION": "\\"7\\"", + "REDHAT_SUPPORT_PRODUCT": "\\"centos\\"", + "REDHAT_SUPPORT_PRODUCT_VERSION": "\\"7\\"" + } + + + +### 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)