diff --git a/docs/parsers/rpm_qai.md b/docs/parsers/rpm_qai.md deleted file mode 100644 index cae74bf5..00000000 --- a/docs/parsers/rpm_qai.md +++ /dev/null @@ -1,191 +0,0 @@ - -# jc.parsers.rpm_qai -jc - JSON CLI output utility `rpm -qai` command output parser - -Works with `rpm -qi [package]` or `rpm -qai`. - -The `build_epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on) - -The `build_epoch_utc` calculated timestamp field is timezone-aware and is only available if the timezone field is UTC. - -Usage (cli): - - $ rpm -qai | jc --rpm_qai - - or - - $ jc rpm -qai - -Usage (module): - - import jc.parsers.rpm_qai - result = jc.parsers.rpm_qai.parse(rpm_qai_command_output) - -Compatibility: - - 'linux' - -Examples: - - $ rpm_qai | jc --rpm_qai -p - [ - { - "name": "make", - "epoch": 1, - "version": "3.82", - "release": "24.el7", - "architecture": "x86_64", - "install_date": "Wed 16 Oct 2019 09:21:42 AM PDT", - "group": "Development/Tools", - "size": 1160660, - "license": "GPLv2+", - "signature": "RSA/SHA256, Thu 22 Aug 2019 02:34:59 PM PDT, Key ID 24c6a8a7f4a80eb5", - "source_rpm": "make-3.82-24.el7.src.rpm", - "build_date": "Thu 08 Aug 2019 05:47:25 PM PDT", - "build_host": "x86-01.bsys.centos.org", - "relocations": "(not relocatable)", - "packager": "CentOS BuildSystem ", - "vendor": "CentOS", - "url": "http://www.gnu.org/software/make/", - "summary": "A GNU tool which simplifies the build process for users", - "description": "A GNU tool for controlling the generation of executables and other non-source...", - "build_epoch": 1565311645, - "build_epoch_utc": null - }, - { - "name": "kbd-legacy", - "version": "1.15.5", - "release": "15.el7", - "architecture": "noarch", - "install_date": "Thu 15 Aug 2019 10:53:08 AM PDT", - "group": "System Environment/Base", - "size": 503608, - "license": "GPLv2+", - "signature": "RSA/SHA256, Mon 12 Nov 2018 07:17:49 AM PST, Key ID 24c6a8a7f4a80eb5", - "source_rpm": "kbd-1.15.5-15.el7.src.rpm", - "build_date": "Tue 30 Oct 2018 03:40:00 PM PDT", - "build_host": "x86-01.bsys.centos.org", - "relocations": "(not relocatable)", - "packager": "CentOS BuildSystem ", - "vendor": "CentOS", - "url": "http://ftp.altlinux.org/pub/people/legion/kbd", - "summary": "Legacy data for kbd package", - "description": "The kbd-legacy package contains original keymaps for kbd package. Please note...", - "build_epoch": 1540939200, - "build_epoch_utc": null - }, - ... - ] - - $ rpm -qai | jc --rpm_qai -p -r - [ - { - "name": "make", - "epoch": "1", - "version": "3.82", - "release": "24.el7", - "architecture": "x86_64", - "install_date": "Wed 16 Oct 2019 09:21:42 AM PDT", - "group": "Development/Tools", - "size": "1160660", - "license": "GPLv2+", - "signature": "RSA/SHA256, Thu 22 Aug 2019 02:34:59 PM PDT, Key ID 24c6a8a7f4a80eb5", - "source_rpm": "make-3.82-24.el7.src.rpm", - "build_date": "Thu 08 Aug 2019 05:47:25 PM PDT", - "build_host": "x86-01.bsys.centos.org", - "relocations": "(not relocatable)", - "packager": "CentOS BuildSystem ", - "vendor": "CentOS", - "url": "http://www.gnu.org/software/make/", - "summary": "A GNU tool which simplifies the build process for users", - "description": "A GNU tool for controlling the generation of executables and other..." - }, - { - "name": "kbd-legacy", - "version": "1.15.5", - "release": "15.el7", - "architecture": "noarch", - "install_date": "Thu 15 Aug 2019 10:53:08 AM PDT", - "group": "System Environment/Base", - "size": "503608", - "license": "GPLv2+", - "signature": "RSA/SHA256, Mon 12 Nov 2018 07:17:49 AM PST, Key ID 24c6a8a7f4a80eb5", - "source_rpm": "kbd-1.15.5-15.el7.src.rpm", - "build_date": "Tue 30 Oct 2018 03:40:00 PM PDT", - "build_host": "x86-01.bsys.centos.org", - "relocations": "(not relocatable)", - "packager": "CentOS BuildSystem ", - "vendor": "CentOS", - "url": "http://ftp.altlinux.org/pub/people/legion/kbd", - "summary": "Legacy data for kbd package", - "description": "The kbd-legacy package contains original keymaps for kbd package..." - }, - ... - ] - - -## info -```python -info() -``` - - -## process -```python -process(proc_data) -``` - -Final processing to conform to the schema. - -Parameters: - - proc_data: (List of Dictionaries) raw structured data to process - -Returns: - - List of Dictionaries. Structured data with the following schema: - - [ - { - "name": string, - "epoch": integer, - "version": string, - "release": string, - "architecture": string, - "install_date": string, - "group": string, - "size": integer, - "license": string, - "signature": string, - "source_rpm": string, - "build_date": string, - "build_epoch": integer, # naive timestamp - "build_epoch_utc": integer, # Aware timestamp if timezone is UTC - "build_host": string, - "relocations": string, - "packager": string, - "vendor": string, - "url": string, - "summary": string, - "description": string - } - ] - - -## parse -```python -parse(data, raw=False, quiet=False) -``` - -Main text parsing function - -Parameters: - - data: (string) text data to parse - raw: (boolean) output preprocessed JSON if True - quiet: (boolean) suppress warning messages if True - -Returns: - - List of Dictionaries. Raw or processed structured data. -