python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-21 00:19:42 +02:00
Code Issues Releases Activity

New doc generation script

Browse Source
This commit is contained in:
Kelly Brazil
2024-03-14 21:44:37 -07:00
parent 401b7b31b8
commit 37061227d9
13 changed files with 502 additions and 530 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/parsers/apt_get_sqq.md
View File

@ -1,7 +1,7 @@
[Home](https://kellyjonbrazil.github.io/jc/)
<a id="jc.parsers.apt_get_sqq"></a>
# jc.parsers.apt\_get\_sqq
# jc.parsers.apt_get_sqq
jc - JSON Convert `apt-get -sqq` command output parser
@ -28,7 +28,7 @@ Schema:
"package": string,
"broken": string/null,
"proposed_pkg_ver": string,
"existing_src": string/null,
"existing_pkg_ver": string/null,
"architecture": string
}
]
@ -42,7 +42,7 @@ Examples:
"package": "dpkg",
"broken": "1.19.7",
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -50,7 +50,7 @@ Examples:
"package": "dpkg",
"broken": null,
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -58,7 +58,7 @@ Examples:
"package": "dpkg",
"broken": "1.19.7",
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -66,7 +66,7 @@ Examples:
"package": "dpkg",
"broken": "1.19.7",
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -74,7 +74,7 @@ Examples:
"package": "base-files",
"broken": "10.3+deb10u4",
"proposed_pkg_ver": "10.3+deb10u13 Debian:10.13/oldstable",
"existing_src": null,
"existing_pkg_ver": null,
"architecture": "amd64"
},
{
@ -82,7 +82,7 @@ Examples:
"package": "base-files",
"broken": null,
"proposed_pkg_ver": "10.3+deb10u13 Debian:10.13/oldstable",
"existing_src": null,
"existing_pkg_ver": null,
"architecture": "amd64"
},
{
@ -90,7 +90,7 @@ Examples:
"package": "dpkg",
"broken": "1.19.7",
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -98,7 +98,7 @@ Examples:
"package": "dpkg",
"broken": null,
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
}
]
@ -110,7 +110,7 @@ Examples:
"package": "dpkg",
"broken": "1.19.7",
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -118,7 +118,7 @@ Examples:
"package": "dpkg",
"broken": null,
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -126,7 +126,7 @@ Examples:
"package": "dpkg",
"broken": "1.19.7",
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -134,7 +134,7 @@ Examples:
"package": "dpkg",
"broken": "1.19.7",
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -142,7 +142,7 @@ Examples:
"package": "base-files",
"broken": "10.3+deb10u4",
"proposed_pkg_ver": "10.3+deb10u13 Debian:10.13/oldstable",
"existing_src": null,
"existing_pkg_ver": null,
"architecture": "amd64"
},
{
@ -150,7 +150,7 @@ Examples:
"package": "base-files",
"broken": null,
"proposed_pkg_ver": "10.3+deb10u13 Debian:10.13/oldstable",
"existing_src": null,
"existing_pkg_ver": null,
"architecture": "amd64"
},
{
@ -158,7 +158,7 @@ Examples:
"package": "dpkg",
"broken": "1.19.7",
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
},
{
@ -166,11 +166,12 @@ Examples:
"package": "dpkg",
"broken": null,
"proposed_pkg_ver": "1.19.8 Debian:10.13/oldstable",
"existing_src": "Debian-Security:10/oldstable",
"existing_pkg_ver": "Debian-Security:10/oldstable",
"architecture": "amd64"
}
]
<a id="jc.parsers.apt_get_sqq.parse"></a>
### parse
@ -178,7 +179,7 @@ Examples:
```python
def parse(data: str,
raw: bool = False,
quiet: bool = False) -> List[JSONDictType]
quiet: bool = False) -> List[Dict[str, Any]]
```
Main text parsing function
@ -193,9 +194,11 @@ Returns:
List of Dictionaries. Raw or processed structured data.
### Parser Information
Compatibility: linux
Compatibility: linux
Source: [`jc/parsers/apt_get_sqq.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/apt_get_sqq.py)
Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

5
docs/parsers/dir.md
View File

@ -120,6 +120,7 @@ Examples:
...
]
<a id="jc.parsers.dir.parse"></a>
### parse
@ -140,9 +141,11 @@ Returns:
List of Dictionaries. Raw or processed structured data.
### Parser Information
Compatibility: win32
Compatibility: win32
Source: [`jc/parsers/dir.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/dir.py)
Version 1.6 by Rasheed Elsaleh (rasheed@rebelliondefense.com)

7
docs/parsers/ethtool.md
View File

@ -166,12 +166,13 @@ Examples:
"br_margin_min": "0%"
}
<a id="jc.parsers.ethtool.parse"></a>
### parse
```python
def parse(data: str, raw: bool = False, quiet: bool = False) -> JSONDictType
def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict[str, Any]
```
Main text parsing function
@ -186,9 +187,11 @@ Returns:
List of Dictionaries. Raw or processed structured data.
### Parser Information
Compatibility: linux
Compatibility: linux
Source: [`jc/parsers/ethtool.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/ethtool.py)
Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)

20
docs/parsers/universal.md
View File

@ -1,18 +1,19 @@
# Table of Contents
* [jc.parsers.universal](#jc.parsers.universal)
* [simple\_table\_parse](#jc.parsers.universal.simple_table_parse)
* [sparse\_table\_parse](#jc.parsers.universal.sparse_table_parse)
[Home](https://kellyjonbrazil.github.io/jc/)
<a id="jc.parsers.universal"></a>
# jc.parsers.universal
# Table of Contents
*[jc.parsers.universal](#jc.parsers.universal)
*[simple_table_parse](#jc.parsers.universal.simple_table_parse)
*[sparse_table_parse](#jc.parsers.universal.sparse_table_parse)
jc - JSON Convert universal parsers
<a id="jc.parsers.universal.simple_table_parse"></a>
### simple\_table\_parse
### simple_table_parse
```python
def simple_table_parse(data: Iterable[str]) -> List[Dict]
@ -50,7 +51,7 @@ Returns:
<a id="jc.parsers.universal.sparse_table_parse"></a>
### sparse\_table\_parse
### sparse_table_parse
```python
def sparse_table_parse(data: Iterable[str],
@ -86,7 +87,7 @@ Parameters:
Also, ensure there are no blank line items.
delim: (string) Delimiter to use. By default `u\\2063`
delim: (string) Delimiter to use. By default `u\2063`
(invisible separator) is used since it is unlikely
to ever be seen in terminal output. You can change
this for troubleshooting purposes or if there is a
@ -96,3 +97,4 @@ Returns:
List of Dictionaries

9
docs/parsers/ver.md
View File

@ -86,12 +86,13 @@ Examples:
"strict": false
}
<a id="jc.parsers.ver.parse"></a>
### parse
```python
def parse(data: str, raw: bool = False, quiet: bool = False) -> JSONDictType
def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict[str, Any]
```
Main text parsing function
@ -106,11 +107,13 @@ Returns:
List of Dictionaries. Raw or processed structured data.
### Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd
Compatibility: linux, darwin, cygwin, win32, aix, freebsd
Source: [`jc/parsers/ver.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/ver.py)
This parser can be used with the `--slurp` command-line option.
Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)