python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2021-09-20 13:21:20 -07:00
parent d64c4cb390
commit 3f221f4714
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/parsers/ping_s.md
View File

@ -3,10 +3,14 @@
# jc.parsers.ping_s # jc.parsers.ping_s
jc - JSON CLI output utility `ping` command output streaming parser jc - JSON CLI output utility `ping` command output streaming parser
Supports `ping` and `ping6` output.
Usage (cli): Usage (cli):
$ ping | jc --ping-s $ ping | jc --ping-s
> Note: When piping `jc` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information.
Usage (module): Usage (module):
import jc.parsers.ping_s import jc.parsers.ping_s
@ -14,8 +18,6 @@ Usage (module):
for item in result: for item in result:
# do something # do something
> Note: When piping `jc` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information.
Schema: Schema:
{ {

6
jc/parsers/ping_s.py
View File

@ -1,9 +1,13 @@
"""jc - JSON CLI output utility `ping` command output streaming parser """jc - JSON CLI output utility `ping` command output streaming parser
Supports `ping` and `ping6` output.
Usage (cli): Usage (cli):
$ ping | jc --ping-s $ ping | jc --ping-s
> Note: When piping `jc` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information.
Usage (module): Usage (module):
import jc.parsers.ping_s import jc.parsers.ping_s
@ -11,8 +15,6 @@ Usage (module):
for item in result: for item in result:
# do something # do something
> Note: When piping `jc` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information.
Schema: Schema:
{ {