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

fix wiki language

Browse Source
This commit is contained in:
Kelly Brazil
2022-05-20 07:58:19 -07:00
parent 557e68225c
commit 8a122cd9e1
2 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -451,11 +451,11 @@ For example, the following is possible in [NGS](https://ngs-lang.org/)
```bash ```bash
myvar = ``jc dig www.google.com``[0].answer[0].data myvar = ``jc dig www.google.com``[0].answer[0].data
``` ```
This allows direct assignment of a JSON value to a variable in a single line This runs `jc`, parses the output JSON, and assigs the resulting data structure
of code. to a variable in a single line of code.
For more examples of how to use `jc` in other shells, see this For more examples of how to use `jc` in other shells, see this
[WIKI article](https://github.com/kellyjonbrazil/jc/wiki/Using-jc-With-Different-Shells). [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Using-jc-With-Different-Shells).
## Compatibility ## Compatibility
Some parsers like `dig`, `xml`, `csv`, etc. will work on any platform. Other Some parsers like `dig`, `xml`, `csv`, etc. will work on any platform. Other
@ -463,9 +463,9 @@ parsers that convert platform-specific output will generate a warning message if
they are run on an unsupported platform. To see all parser information, they are run on an unsupported platform. To see all parser information,
including compatibility, run `jc -ap`. including compatibility, run `jc -ap`.
You may still use a parser on an unsupported platform - for example, you may want You may still use a parser on an unsupported platform - for example, you may
to parse a file with linux `lsof` output on an macOS or Windows laptop. In that want to parse a file with linux `lsof` output on an macOS or Windows laptop. In
case you can suppress the warning message with the `-q` cli option or the that case you can suppress the warning message with the `-q` cli option or the
`quiet=True` function parameter in `parse()`: `quiet=True` function parameter in `parse()`:
macOS: macOS:
@ -494,7 +494,8 @@ Tested on:
## Contributions ## Contributions
Feel free to add/improve code or parsers! You can use the Feel free to add/improve code or parsers! You can use the
[`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py)
or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parsers as a template and submit your parser with a pull request. or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parsers as a template and submit your parser with a pull
request.
Please see the [Contributing Guidelines](https://github.com/kellyjonbrazil/jc/blob/master/CONTRIBUTING.md) for more information. Please see the [Contributing Guidelines](https://github.com/kellyjonbrazil/jc/blob/master/CONTRIBUTING.md) for more information.

15
templates/readme_template
View File

@ -352,11 +352,11 @@ For example, the following is possible in [NGS](https://ngs-lang.org/)
```bash ```bash
myvar = ``jc dig www.google.com``[0].answer[0].data myvar = ``jc dig www.google.com``[0].answer[0].data
``` ```
This allows direct assignment of a JSON value to a variable in a single line This runs `jc`, parses the output JSON, and assigs the resulting data structure
of code. to a variable in a single line of code.
For more examples of how to use `jc` in other shells, see this For more examples of how to use `jc` in other shells, see this
[WIKI article](https://github.com/kellyjonbrazil/jc/wiki/Using-jc-With-Different-Shells). [wiki page](https://github.com/kellyjonbrazil/jc/wiki/Using-jc-With-Different-Shells).
## Compatibility ## Compatibility
Some parsers like `dig`, `xml`, `csv`, etc. will work on any platform. Other Some parsers like `dig`, `xml`, `csv`, etc. will work on any platform. Other
@ -364,9 +364,9 @@ parsers that convert platform-specific output will generate a warning message if
they are run on an unsupported platform. To see all parser information, they are run on an unsupported platform. To see all parser information,
including compatibility, run `jc -ap`. including compatibility, run `jc -ap`.
You may still use a parser on an unsupported platform - for example, you may want You may still use a parser on an unsupported platform - for example, you may
to parse a file with linux `lsof` output on an macOS or Windows laptop. In that want to parse a file with linux `lsof` output on an macOS or Windows laptop. In
case you can suppress the warning message with the `-q` cli option or the that case you can suppress the warning message with the `-q` cli option or the
`quiet=True` function parameter in `parse()`: `quiet=True` function parameter in `parse()`:
macOS: macOS:
@ -395,7 +395,8 @@ Tested on:
## Contributions ## Contributions
Feel free to add/improve code or parsers! You can use the Feel free to add/improve code or parsers! You can use the
[`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py)
or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parsers as a template and submit your parser with a pull request. or [`jc/parsers/foo_s.py (streaming)`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo_s.py) parsers as a template and submit your parser with a pull
request.
Please see the [Contributing Guidelines](https://github.com/kellyjonbrazil/jc/blob/master/CONTRIBUTING.md) for more information. Please see the [Contributing Guidelines](https://github.com/kellyjonbrazil/jc/blob/master/CONTRIBUTING.md) for more information.