From c3b68903cbd898f80438af342195eec7575aafd3 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 5 May 2021 09:17:11 -0700 Subject: [PATCH 1/4] add use cases section --- templates/readme_template | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/templates/readme_template b/templates/readme_template index 1159b930..733c4c7d 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -64,12 +64,10 @@ Two representations of the data are possible. The default representation uses a To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` function parameter in `parse()`. -Schemas for each parser can be found at the documentation link beside each parser below. +Schemas for each parser can be found at the documentation link beside each [**Parser**](#parsers) below. Release notes can be found [here](https://blog.kellybrazil.com/category/jc-news/). -For Bash use case examples, see my blog post on [Practical JSON at the Command Line](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/). - ## Why Would Anyone Do This!? For more information on the motivations for this project, please see my [blog post](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/). @@ -78,6 +76,12 @@ See also: - [powershell](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-7) - [blog: linux apps should have a json flag](https://thomashunter.name/posts/2012-06-06-linux-cli-apps-should-have-a-json-flag) +### Use Cases +- [Bash Scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/) +- [Ansible command output parsing](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) +- [Saltstack command output parsing](https://blog.kellybrazil.com/2020/09/15/parsing-command-output-in-saltstack-with-jc/) +- [Nornir command output parsing](https://blog.kellybrazil.com/2020/12/09/parsing-command-output-in-nornir-with-jc/) + ## Installation There are several ways to get `jc`. You can install via `pip`; other OS package repositories like `apt-get`, `dnf`, `zypper`, `pacman`, `nix-env`, `guix`, `brew`, or `portsnap`; via DEB/RPM packaged binaries; or by downloading the correct binary for your architecture and running it anywhere on your filesystem. From 5ee88e7b679bc163a1916d560be6ff29f51699e8 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 5 May 2021 09:18:45 -0700 Subject: [PATCH 2/4] add use cases section --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 32c4662c..89ebdd66 100644 --- a/README.md +++ b/README.md @@ -64,12 +64,10 @@ Two representations of the data are possible. The default representation uses a To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` function parameter in `parse()`. -Schemas for each parser can be found at the documentation link beside each parser below. +Schemas for each parser can be found at the documentation link beside each [**Parser**](#parsers) below. Release notes can be found [here](https://blog.kellybrazil.com/category/jc-news/). -For Bash use case examples, see my blog post on [Practical JSON at the Command Line](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/). - ## Why Would Anyone Do This!? For more information on the motivations for this project, please see my [blog post](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/). @@ -78,6 +76,12 @@ See also: - [powershell](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-7) - [blog: linux apps should have a json flag](https://thomashunter.name/posts/2012-06-06-linux-cli-apps-should-have-a-json-flag) +### Use Cases +- [Bash Scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/) +- [Ansible command output parsing](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) +- [Saltstack command output parsing](https://blog.kellybrazil.com/2020/09/15/parsing-command-output-in-saltstack-with-jc/) +- [Nornir command output parsing](https://blog.kellybrazil.com/2020/12/09/parsing-command-output-in-nornir-with-jc/) + ## Installation There are several ways to get `jc`. You can install via `pip`; other OS package repositories like `apt-get`, `dnf`, `zypper`, `pacman`, `nix-env`, `guix`, `brew`, or `portsnap`; via DEB/RPM packaged binaries; or by downloading the correct binary for your architecture and running it anywhere on your filesystem. From 4e6ae66bacc014e49c4a9229d10dcc8e95de436c Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 5 May 2021 09:20:47 -0700 Subject: [PATCH 3/4] formatting --- README.md | 2 +- templates/readme_template | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 89ebdd66..4bc93c84 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ See also: - [powershell](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-7) - [blog: linux apps should have a json flag](https://thomashunter.name/posts/2012-06-06-linux-cli-apps-should-have-a-json-flag) -### Use Cases +Use Cases: - [Bash Scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/) - [Ansible command output parsing](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) - [Saltstack command output parsing](https://blog.kellybrazil.com/2020/09/15/parsing-command-output-in-saltstack-with-jc/) diff --git a/templates/readme_template b/templates/readme_template index 733c4c7d..3acf2058 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -76,7 +76,7 @@ See also: - [powershell](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-7) - [blog: linux apps should have a json flag](https://thomashunter.name/posts/2012-06-06-linux-cli-apps-should-have-a-json-flag) -### Use Cases +Use Cases: - [Bash Scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/) - [Ansible command output parsing](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) - [Saltstack command output parsing](https://blog.kellybrazil.com/2020/09/15/parsing-command-output-in-saltstack-with-jc/) From efb1d3e6b2db920423511a9dcf4c5e5fd9d6af43 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 5 May 2021 09:23:21 -0700 Subject: [PATCH 4/4] add blog title and minor formatting --- README.md | 4 ++-- templates/readme_template | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4bc93c84..42724901 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Schemas for each parser can be found at the documentation link beside each [**Pa Release notes can be found [here](https://blog.kellybrazil.com/category/jc-news/). ## Why Would Anyone Do This!? -For more information on the motivations for this project, please see my [blog post](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/). +For more information on the motivations for this project, please see my blog post on [Bringing the Unix Philosophy to the 21st Century](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/). See also: - [libxo on FreeBSD](http://juniper.github.io/libxo/libxo-manual.html) @@ -77,7 +77,7 @@ See also: - [blog: linux apps should have a json flag](https://thomashunter.name/posts/2012-06-06-linux-cli-apps-should-have-a-json-flag) Use Cases: -- [Bash Scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/) +- [Bash scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/) - [Ansible command output parsing](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) - [Saltstack command output parsing](https://blog.kellybrazil.com/2020/09/15/parsing-command-output-in-saltstack-with-jc/) - [Nornir command output parsing](https://blog.kellybrazil.com/2020/12/09/parsing-command-output-in-nornir-with-jc/) diff --git a/templates/readme_template b/templates/readme_template index 3acf2058..b9758e8b 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -69,7 +69,7 @@ Schemas for each parser can be found at the documentation link beside each [**Pa Release notes can be found [here](https://blog.kellybrazil.com/category/jc-news/). ## Why Would Anyone Do This!? -For more information on the motivations for this project, please see my [blog post](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/). +For more information on the motivations for this project, please see my blog post on [Bringing the Unix Philosophy to the 21st Century](https://blog.kellybrazil.com/2019/11/26/bringing-the-unix-philosophy-to-the-21st-century/). See also: - [libxo on FreeBSD](http://juniper.github.io/libxo/libxo-manual.html) @@ -77,7 +77,7 @@ See also: - [blog: linux apps should have a json flag](https://thomashunter.name/posts/2012-06-06-linux-cli-apps-should-have-a-json-flag) Use Cases: -- [Bash Scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/) +- [Bash scripting](https://blog.kellybrazil.com/2021/04/12/practical-json-at-the-command-line/) - [Ansible command output parsing](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) - [Saltstack command output parsing](https://blog.kellybrazil.com/2020/09/15/parsing-command-output-in-saltstack-with-jc/) - [Nornir command output parsing](https://blog.kellybrazil.com/2020/12/09/parsing-command-output-in-nornir-with-jc/)