Add Parse JSON Notices Section #2669
Conversation
Vidushi-GitHub
requested review from
lpsinger,
jracusin,
dakota002 and
tylerbarna
Vidushi-GitHub
assigned Vidushi-GitHub and tylerbarna and unassigned tylerbarna and Vidushi-GitHub
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2669 +/- ##
=====================================
Coverage 6.21% 6.21%
=====================================
Files 167 167
Lines 4231 4231
Branches 467 467
=====================================
Hits 263 263
Misses 3966 3966
Partials 2 2 ☔ View full report in Codecov by Sentry. |
|
|
||
| ## Parsing JSON | ||
|
|
||
| Read the JSON data from [sample.schema.json](https://gcn.nasa.gov/docs/notices/schema) and [sample.example.json](https://gcn.nasa.gov/docs/notices/schema), which parses it into Python dictionaries. |
There was a problem hiding this comment.
The code sample below does not refer to a file called sample.schema.json.
|
|
||
| ## Encoding and Decoding of Embedded Data | ||
|
|
||
| The following code sample shows how to encode/decode a file in Python. The [`base64`](https://docs.python.org/3/library/base64.html#base64.b64encode) package includes the methods `b64decode` and `b64encode` to make this task simple. |
There was a problem hiding this comment.
The following code sample shows how to encode/decode a file in Python.
It doesn't show how to encode/decode any file in Python; only how to encode/decode bytes to base64 for transfer over an ASCII medium.
| } | ||
| ``` | ||
|
|
||
| In your data production pipeline, you can use the encoding steps to convert your file to a bytestring and set the value of the property to this bytestring. See [non-JSON data](https://json-schema.org/understanding-json-schema/reference/non_json_data.html) for more information. |
There was a problem hiding this comment.
Great sample code, but not enough context here to understand what these instructions are for.
|
This encoding information needs to also be referenced somewhere in the creating JSON notices documentation. |
|
Add example of pulling message off the network and getting bytes out. |
This document includes how to parse, encode, decode the JSON Schema files.
Resolves: #2149
Previous branch (#2506) had 100+ commits behind, rebase was messy and touched many files.
Feedbacks need to be included:
-Provide hyperlinks to these Python methods.
-Please provide sample code for parsing Kafka records in a message consuming loop