jc/docs/parsers/pip_list.md

jc.parsers.pip_list

jc - JSON CLI output utility pip-list command output parser

Usage (cli):

$ pip list | jc --pip-list

or

$ jc pip list

Usage (module):

import jc.parsers.pip_list
result = jc.parsers.pip_list.parse(pip_list_command_output)

Compatibility:

'linux', 'darwin', 'cygwin', 'win32', 'aix', 'freebsd'

Examples:

$ pip list | jc --pip-list -p
[
  {
    "package": "ansible",
    "version": "2.8.5"
  },
  {
    "package": "antlr4-python3-runtime",
    "version": "4.7.2"
  },
  {
    "package": "asn1crypto",
    "version": "0.24.0"
  },
  ...
]

info

info()

process

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:

[
  {
    "package":     string,
    "version":     string,
    "location":    string
  }
]

parse

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.