1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/parsers/pip_list.md

74 lines
1.2 KiB
Markdown
Raw Normal View History

[Home](https://kellyjonbrazil.github.io/jc/)
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.pip_list"></a>
# jc.parsers.pip\_list
2020-07-30 16:20:24 -07:00
2022-03-04 13:27:39 -08:00
jc - JSON Convert `pip-list` command output parser
2019-12-16 18:36:13 -08:00
2020-08-05 13:32:59 -07:00
Usage (cli):
2019-12-16 18:36:13 -08:00
2022-01-25 18:03:34 -08:00
$ pip list | jc --pip-list
2020-08-05 16:51:58 -07:00
2022-01-25 18:03:34 -08:00
or
2020-08-05 16:51:58 -07:00
2022-01-25 18:03:34 -08:00
$ jc pip list
2019-12-16 18:36:13 -08:00
2020-08-05 13:32:59 -07:00
Usage (module):
2022-01-25 18:03:34 -08:00
import jc
result = jc.parse('pip_list', pip_list_command_output)
2022-01-18 15:38:03 -08:00
2021-04-08 15:52:49 -07:00
Schema:
2022-01-25 18:03:34 -08:00
[
{
"package": string,
"version": string,
"location": string
}
]
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"
},
...
]
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.pip_list.parse"></a>
2022-03-05 12:15:14 -08:00
### parse
2022-01-25 17:07:47 -08:00
2019-12-16 18:36:13 -08:00
```python
2022-01-25 17:07:47 -08:00
def parse(data, raw=False, quiet=False)
2019-12-16 18:36:13 -08:00
```
Main text parsing function
2022-01-25 18:03:34 -08:00
Parameters:
2019-12-16 18:36:13 -08:00
2022-01-25 18:03:34 -08:00
data: (string) text data to parse
raw: (boolean) unprocessed output if True
quiet: (boolean) suppress warning messages if True
2019-12-16 18:36:13 -08:00
2022-01-25 18:03:34 -08:00
Returns:
2019-12-16 18:36:13 -08:00
2022-01-25 18:03:34 -08:00
List of Dictionaries. Raw or processed structured data.
2019-12-16 18:36:13 -08:00
2022-01-25 19:18:54 -08:00
### Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd
2021-12-01 16:12:51 -08:00
Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)