python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-12-24 00:31:11 +02:00
Code Issues Releases Activity

add new docs

Browse Source
This commit is contained in:
Kelly Brazil
2021-04-09 15:10:38 -07:00
parent 5d8f8365e2
commit 605353fdce
70 changed files with 1710 additions and 2656 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
docs/parsers/dmidecode.md
View File

@@ -1,3 +1,4 @@
[Home](https://kellyjonbrazil.github.io/jc/)
# jc.parsers.dmidecode
jc - JSON CLI output utility `dmidecode` command output parser
@@ -15,9 +16,22 @@ Usage (module):
import jc.parsers.dmidecode
result = jc.parsers.dmidecode.parse(dmidecode_command_output)
Compatibility:
Schema:
'linux'
[
{
"handle": string,
"type": integer,
"bytes": integer,
"description": string,
"values": { (null if empty)
"lowercase_no_spaces_keys": string,
"multiline_key_values": [
string,
]
}
}
]
Examples:
@@ -114,38 +128,7 @@ Examples:
```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:
[
{
"handle": string,
"type": integer,
"bytes": integer,
"description": string,
"values": { (null if empty)
"lowercase_no_spaces_keys": string,
"multiline_key_values": [
string,
]
}
}
]
Provides parser metadata (version, author, etc.)
## parse
```python
@@ -164,3 +147,7 @@ Returns:
List of Dictionaries. Raw or processed structured data.
## Parser Information
Compatibility: linux
Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)