GRASS GSoC 2024 Add JSON output - Revision history

Wenzeslaus: Grass -> GRASS

2024-08-22T20:31:05Z

Grass -> GRASS

← Older revision		Revision as of 20:31, 22 August 2024
Line 13:		Line 13:

	;Abstract		;Abstract
	::At the moment, most of the tools in ~~Grass~~ have custom human readable outputs in plain text. Some of these modules could benefit from storing their output in a portable and commonly used data format. The aim of my project is to use the parson library in various tools so that they can produce JSON outputs. The addition of JSON as an output format will be accompanied with addition of Python test cases to verify the output works as intended and to avoid regressions in future. An option to specify the desired output format (plain or JSON) will also be added to each of the tools updated. The layout of the JSON format will be discussed with mentors prior to implementation and will be optimized towards easy ingestion with Pandas.		::At the moment, most of the tools in GRASS have custom human readable outputs in plain text. Some of these modules could benefit from storing their output in a portable and commonly used data format. The aim of my project is to use the parson library in various tools so that they can produce JSON outputs. The addition of JSON as an output format will be accompanied with addition of Python test cases to verify the output works as intended and to avoid regressions in future. An option to specify the desired output format (plain or JSON) will also be added to each of the tools updated. The layout of the JSON format will be discussed with mentors prior to implementation and will be optimized towards easy ingestion with Pandas.

	__TOC__		__TOC__

Wenzeslaus: /* Examples */ Add more examples

2024-08-22T20:29:37Z

Examples: Add more examples

@@ Line 94: / Line 94: @@
 == Examples ==
-=== Using r.category JSON output with python ===
+=== Using r.category JSON output with Python ===
 <source lang="python">
 import grass.script as gs
@@ Line 135: / Line 135: @@
 </pre>
-=== Using r.profile JSON output with pandas and matplotlib ===
+=== Using r.profile JSON output with pandas and Matplotlib ===
 <source lang="python">
 import grass.script as gs
@@ Line 182: / Line 182: @@
 [[File:Distance Elevation Color Coded.png]]
-=== Using r.info JSON output with jq ===
+=== Using r.info with pandas with session setup ===
 <source lang="bash">
 r.info lakes format=json | jq '.title'
@@ Line 188: / Line 226: @@
 <pre>
 "South-West Wake county: Wake county lakes"
 </pre>

Juno: /* Examples */

2024-08-22T20:00:12Z

Examples

← Older revision		Revision as of 20:00, 22 August 2024
Line 182:		Line 182:
	[[File:Distance Elevation Color Coded.png]]		[[File:Distance Elevation Color Coded.png]]

			=== Using r.info JSON output with jq ===
	<source lang="bash">		<source lang="bash">
	r.info lakes format=json \| jq '.title'		r.info lakes format=json \| jq '.title'

Juno: Add examples

2024-08-22T19:59:22Z

Add examples

@@ Line 94: / Line 94: @@
 == Examples ==
 <source lang="python">
-# Python example with dictionary
+import grass.script as gs
 </source>
 <source lang="python">
-# Python example with Pandas
+import grass.script as gs
 </source>
 <source lang="bash">
-# Bash example with jq
+r.info lakes format=json | jq '.title'
 </source>

Juno at 19:25, 22 August 2024

2024-08-22T19:25:56Z

@@ Line 80: / Line 80: @@
 Final: https://discourse.osgeo.org/t/gsoc-2024-final-report-add-json-output-to-different-tools-in-c/49784
 {{GSoC}}
 == Examples ==

Juno: update pull request

2024-08-22T19:15:50Z

update pull request

← Older revision		Revision as of 19:15, 22 August 2024
Line 18:		Line 18:

	== Pull Requests ==		== Pull Requests ==
	* https://github.com/OSGeo/grass/pull/3704/		{\| class="wikitable"
	* https://github.com/OSGeo/grass/pull/3744/		\|+
	* https://github.com/OSGeo/grass/pull/3755/		\|-
	* https://github.com/OSGeo/grass/pull/3783/		! Module !! PR Title !! PR Link !! Status at end of GSoC Period
	* https://github.com/OSGeo/grass/pull/3784/		\|-
	* https://github.com/OSGeo/grass/pull/3872/		\| lib \|\| add standard parser option for JSON formatting \|\| https://github.com/OSGeo/grass/pull/3704/ \|\| merged
	* https://github.com/OSGeo/grass/pull/3884/		\|-
	* https://github.com/OSGeo/grass/pull/3935/		\| r.info \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3744/ \|\| merged
	* https://github.com/OSGeo/grass/pull/3941/		\|-
	* https://github.com/OSGeo/grass/pull/3942/		\| v.info \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3755/ \|\| merged
	* https://github.com/OSGeo/grass/pull/4018/		\|-
	* https://github.com/OSGeo/grass/pull/4020/		\| r.univar \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3783/ \|\| merged
	* https://github.com/OSGeo/grass/pull/4021/		\|-
	* https://github.com/OSGeo/grass/pull/4036/		\| v.univar \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3784/ \|\| merged
	* https://github.com/OSGeo/grass/pull/4104/		\|-
	* https://github.com/OSGeo/grass/pull/4105/		\| r.profile \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3872/ \|\| merged
	* https://github.com/OSGeo/grass/pull/4167/		\|-
	* https://github.com/OSGeo/grass/pull/4202/		\| r.stats \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3884/ \|\| open
			\|-
			\| r.report \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3935/ \|\| merged
			\|-
			\| g.region \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3941/ \|\| merged
			\|-
			\| v.distance \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/3942/ \|\| open
			\|-
			\| r.category \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/4018/ \|\| merged
			\|-
			\| v.category \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/4020/ \|\| open
			\|-
			\| db.describe \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/4021/ \|\| merged
			\|-
			\| v.to.db \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/4036/ \|\| open
			\|-
			\| g.proj \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/4104/ \|\| open
			\|-
			\| r.object.geometry \|\| add JSON output \|\| https://github.com/OSGeo/grass/pull/4105/ \|\| merged
			\|-
			\| g.region \|\| fix ruff lint error in tests \|\| https://github.com/OSGeo/grass/pull/4167/ \|\| merged
			\|-
			\| db.describe \|\| fix illegal memory access report \|\| https://github.com/OSGeo/grass/pull/4202/ \|\| merged
			\|}

	== Reports ==		== Reports ==

Wenzeslaus: Add examples section (to be filled)

2024-08-22T18:00:33Z

Add examples section (to be filled)

← Older revision		Revision as of 18:00, 22 August 2024
Line 57:		Line 57:
	Final: https://discourse.osgeo.org/t/gsoc-2024-final-report-add-json-output-to-different-tools-in-c/49784		Final: https://discourse.osgeo.org/t/gsoc-2024-final-report-add-json-output-to-different-tools-in-c/49784
	{{GSoC}}		{{GSoC}}

			== Examples ==

			<source lang="python">
			# Python example with dictionary
			</source>

			<source lang="python">
			# Python example with Pandas
			</source>

			<source lang="bash">
			# Bash example with jq
			</source>

Juno: /* Reports */

2024-08-21T20:57:22Z

Reports

← Older revision		Revision as of 20:57, 21 August 2024
Line 54:		Line 54:
	# Week 10: https://discourse.osgeo.org/t/gsoc-2024-week-10-report-add-json-support-to-grass-modules/49643		# Week 10: https://discourse.osgeo.org/t/gsoc-2024-week-10-report-add-json-support-to-grass-modules/49643
	# Week 12: https://discourse.osgeo.org/t/gsoc-2024-week-12-report-add-json-support-to-grass-modules/49735		# Week 12: https://discourse.osgeo.org/t/gsoc-2024-week-12-report-add-json-support-to-grass-modules/49735

			Final: https://discourse.osgeo.org/t/gsoc-2024-final-report-add-json-output-to-different-tools-in-c/49784
	{{GSoC}}		{{GSoC}}

Juno: Add missing reports and and PRs

2024-08-21T18:37:59Z

Add missing reports and and PRs

← Older revision		Revision as of 18:37, 21 August 2024
Line 32:		Line 32:
	* https://github.com/OSGeo/grass/pull/4021/		* https://github.com/OSGeo/grass/pull/4021/
	* https://github.com/OSGeo/grass/pull/4036/		* https://github.com/OSGeo/grass/pull/4036/
			* https://github.com/OSGeo/grass/pull/4104/
			* https://github.com/OSGeo/grass/pull/4105/
			* https://github.com/OSGeo/grass/pull/4167/
			* https://github.com/OSGeo/grass/pull/4202/

	== Reports ==		== Reports ==
Line 47:		Line 51:
	# Week 7: https://discourse.osgeo.org/t/gsoc-2024-week-7-report-add-json-support-to-grass-modules/30946		# Week 7: https://discourse.osgeo.org/t/gsoc-2024-week-7-report-add-json-support-to-grass-modules/30946
	# Week 8: https://discourse.osgeo.org/t/gsoc-2024-week-8-report-add-json-support-to-grass-modules/30993		# Week 8: https://discourse.osgeo.org/t/gsoc-2024-week-8-report-add-json-support-to-grass-modules/30993
			# Week 9: https://discourse.osgeo.org/t/gsoc-2024-week-9-report-add-json-support-to-grass-modules/31007
			# Week 10: https://discourse.osgeo.org/t/gsoc-2024-week-10-report-add-json-support-to-grass-modules/49643
			# Week 12: https://discourse.osgeo.org/t/gsoc-2024-week-12-report-add-json-support-to-grass-modules/49735
	{{GSoC}}		{{GSoC}}

Juno: /* Reports */

2024-07-22T20:38:22Z

Reports

← Older revision		Revision as of 20:38, 22 July 2024
Line 46:		Line 46:
	# Week 6: https://discourse.osgeo.org/t/gsoc-2024-week-6-report-add-json-support-to-grass-modules/30906		# Week 6: https://discourse.osgeo.org/t/gsoc-2024-week-6-report-add-json-support-to-grass-modules/30906
	# Week 7: https://discourse.osgeo.org/t/gsoc-2024-week-7-report-add-json-support-to-grass-modules/30946		# Week 7: https://discourse.osgeo.org/t/gsoc-2024-week-7-report-add-json-support-to-grass-modules/30946
			# Week 8: https://discourse.osgeo.org/t/gsoc-2024-week-8-report-add-json-support-to-grass-modules/30993
	{{GSoC}}		{{GSoC}}