Issue 8.ant.1 (#9)

* Issue #8 - docs & new api examples

* Update README.md

#8

* Update CHANGELOG.md

#8

Author: antaenc

CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 [markdownlint](https://dlaa.me/markdownlint/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2023-01-18
+
+### Added to 1.0.1
+
+- Add additional API redo examples
+- Update documentation
+
 ## [1.0.0] - 2022-12-22
 
 ### Added to 1.0.0

Python/APIs/G2Engine/Redo/getRedoRecord.py

@@ -13,7 +13,7 @@
     g2_engine.getRedoRecord(redo_record)
 
     if redo_record:
-        print(redo_record.decode())
+        g2_engine.process(redo_record.decode())
     else:
         print('No redo records currently available.')
 

Python/APIs/G2Engine/Redo/process.py

@@ -0,0 +1,23 @@
+#! /usr/bin/env python3
+
+import os
+import sys
+from senzing import G2BadInputException, G2Engine, G2Exception, G2RetryableException, G2UnrecoverableException
+
+engine_config_json = os.getenv('SENZING_ENGINE_CONFIGURATION_JSON', None)
+redo_record = bytearray()
+
+try:
+    g2_engine = G2Engine()
+    g2_engine.init('G2Engine', engine_config_json, False)
+    g2_engine.getRedoRecord(redo_record)
+
+    if redo_record:
+        g2_engine.process(redo_record.decode())
+    else:
+        print('No redo records currently available.')
+
+    g2_engine.destroy()
+except (G2BadInputException, G2RetryableException, G2UnrecoverableException, G2Exception) as ex:
+    print(ex)
+    sys.exit(-1)

Python/APIs/G2Engine/Redo/processWithInfo.py

@@ -0,0 +1,25 @@
+#! /usr/bin/env python3
+
+import os
+import sys
+from senzing import G2BadInputException, G2Engine, G2Exception, G2RetryableException, G2UnrecoverableException
+
+engine_config_json = os.getenv('SENZING_ENGINE_CONFIGURATION_JSON', None)
+redo_record = bytearray()
+with_info = bytearray()
+
+try:
+    g2_engine = G2Engine()
+    g2_engine.init('G2Engine', engine_config_json, False)
+    g2_engine.getRedoRecord(redo_record)
+
+    if redo_record:
+        g2_engine.processWithInfo(redo_record.decode(), with_info)
+        print(with_info.decode())
+    else:
+        print('No redo records currently available.')
+
+    g2_engine.destroy()
+except (G2BadInputException, G2RetryableException, G2UnrecoverableException, G2Exception) as ex:
+    print(ex)
+    sys.exit(-1)

Python/Tasks/Redo/README.md

@@ -18,7 +18,9 @@ When an entity requires additional work a record is automatically created in the
     * Collect the response from the [with info](../../../README.md#with-info) version of the API and write it to a file
 
 ## API Calls
-* [processRedoRecord](../../../Python/APIs/G2Engine/Redo/processRedoRecord.py)
-  * Retrieve and process a single redo record.
-* [processRedoRecordWithInfo](../../../Python/APIs/G2Engine/Redo/processRedoRecordWithInfo.py)
+* [getRedoRecord](../../../Python/APIs/G2Engine/Redo/getRedoRecord.py)
+  * Retrieve a single redo record for processing
+* [process](../../../Python/APIs/G2Engine/Redo/process.py)
+    * Process a single redo record
+* [processWithInfo](../../../Python/APIs/G2Engine/Redo/processWithInfo.py)
     * Process a single redo record and returns information outlining any entities affected by the processing of the record. For further information see [With Info](../../../README.md#with-info)