1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-19 00:17:51 +02:00

documentation update

This commit is contained in:
Kelly Brazil
2019-10-30 12:50:05 -07:00
parent d58a6e1d1d
commit 83ab10d628

View File

@ -7,43 +7,53 @@ output.
CLI Example: CLI Example:
$ ls -l /bin | jc --ls -p $ ls -l /usr/bin | jc --ls -p
[ [
{ {
"filename": "bash", "filename": "apropos",
"flags": "-r-xr-xr-x", "link_to": "whatis",
"links": 1, "flags": "lrwxrwxrwx.",
"links": "1",
"owner": "root", "owner": "root",
"group": "wheel", "group": "root",
"bytes": 618416, "size": "6",
"date": "May 3 22:26" "date": "Aug 15 10:53"
}, },
{ {
"filename": "cat", "filename": "arch",
"flags": "-rwxr-xr-x", "flags": "-rwxr-xr-x.",
"links": 1, "links": "1",
"owner": "root", "owner": "root",
"group": "wheel", "group": "root",
"bytes": 23648, "size": "33080",
"date": "May 3 22:26" "date": "Aug 19 23:25"
}, },
{ {
"filename": "chmod", "filename": "awk",
"flags": "-rwxr-xr-x", "link_to": "gawk",
"links": 1, "flags": "lrwxrwxrwx.",
"links": "1",
"owner": "root", "owner": "root",
"group": "wheel", "group": "root",
"bytes": 30016, "size": "4",
"date": "May 3 22:26" "date": "Aug 15 10:53"
},
{
"filename": "base64",
"flags": "-rwxr-xr-x.",
"links": "1",
"owner": "root",
"group": "root",
"size": "37360",
"date": "Aug 19 23:25"
}, },
... ...
] ]
Module Example: Module Example:
>>> import jc.parsers.ls >>> import jc.parsers.ls
>>> >>>
>>> data='''-rwxr-xr-x 1 root wheel 23648 May 3 22:26 cat >>> data='''-rwxr-xr-x 1 root wheel 23648 May 3 22:26 cat
... -rwxr-xr-x 1 root wheel 30016 May 3 22:26 chmod ... -rwxr-xr-x 1 root wheel 30016 May 3 22:26 chmod
... -rwxr-xr-x 1 root wheel 29024 May 3 22:26 cp ... -rwxr-xr-x 1 root wheel 29024 May 3 22:26 cp
@ -52,20 +62,20 @@ Module Example:
... -rwxr-xr-x 1 root wheel 32000 May 3 22:26 dd ... -rwxr-xr-x 1 root wheel 32000 May 3 22:26 dd
... -rwxr-xr-x 1 root wheel 23392 May 3 22:26 df ... -rwxr-xr-x 1 root wheel 23392 May 3 22:26 df
... -rwxr-xr-x 1 root wheel 18128 May 3 22:26 echo''' ... -rwxr-xr-x 1 root wheel 18128 May 3 22:26 echo'''
>>> >>>
>>> jc.parsers.ls.parse(data) >>> jc.parsers.ls.parse(data)
[{'filename': 'cat', 'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'group': 'wheel', [{'filename': 'cat', 'flags': '-rwxr-xr-x', 'links': '1', 'owner': 'root', 'group': 'wheel',
'bytes': 23648, 'date': 'May 3 22:26'}, {'filename': 'chmod', 'flags': '-rwxr-xr-x', 'links': 1, 'size': '23648', 'date': 'May 3 22:26'}, {'filename': 'chmod', 'flags': '-rwxr-xr-x',
'owner': 'root', 'group': 'wheel', 'bytes': 30016, 'date': 'May 3 22:26'}, {'filename': 'cp', 'links': '1', 'owner': 'root', 'group': 'wheel', 'size': '30016', 'date': 'May 3 22:26'},
'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'group': 'wheel', 'bytes': 29024, {'filename': 'cp', 'flags': '-rwxr-xr-x', 'links': '1', 'owner': 'root', 'group': 'wheel',
'date': 'May 3 22:26'}, {'filename': 'csh', 'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'size': '29024', 'date': 'May 3 22:26'}, {'filename': 'csh', 'flags': '-rwxr-xr-x', 'links': '1',
'group': 'wheel', 'bytes': 375824, 'date': 'May 3 22:26'}, {'filename': 'date', 'owner': 'root', 'group': 'wheel', 'size': '375824', 'date': 'May 3 22:26'}, {'filename': 'date',
'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'group': 'wheel', 'bytes': 28608, 'flags': '-rwxr-xr-x', 'links': '1', 'owner': 'root', 'group': 'wheel', 'size': '28608',
'date': 'May 3 22:26'}, {'filename': 'dd', 'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'date': 'May 3 22:26'}, {'filename': 'dd', 'flags': '-rwxr-xr-x', 'links': '1', 'owner': 'root',
'group': 'wheel', 'bytes': 32000, 'date': 'May 3 22:26'}, {'filename': 'df', 'flags': '-rwxr-xr-x', 'group': 'wheel', 'size': '32000', 'date': 'May 3 22:26'}, {'filename': 'df', 'flags': '-rwxr-xr-x',
'links': 1, 'owner': 'root', 'group': 'wheel', 'bytes': 23392, 'date': 'May 3 22:26'}, 'links': '1', 'owner': 'root', 'group': 'wheel', 'size': '23392', 'date': 'May 3 22:26'},
{'filename': 'echo', 'flags': '-rwxr-xr-x', 'links': 1, 'owner': 'root', 'group': 'wheel', {'filename': 'echo', 'flags': '-rwxr-xr-x', 'links': '1', 'owner': 'root', 'group': 'wheel',
'bytes': 18128, 'date': 'May 3 22:26'}] 'size': '18128', 'date': 'May 3 22:26'}]
""" """
name = 'jc' name = 'jc'