85 dockter 1

.github/linters/.checkov.yaml

@@ -0,0 +1,3 @@
+quiet: true
+skip-check:
+  - CKV_DOCKER_7

CHANGELOG.md

@@ -8,12 +8,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.2.0] - 2024-08-05
+## [0.2.0] - 2024-09-25
+
+### Added in 0.2.0
+
+- Added `szabstractfactory`
 
 ### Changed in 0.2.0
 
 - Update to `template-python`
 - Update dependencies
+- Update to latest gRPC Proto definitions
 
 ## [0.1.3] - 2024-07-29
 

Makefile

@@ -144,8 +144,7 @@ documentation: documentation-osarch-specific
 # -----------------------------------------------------------------------------
 
 .PHONY: package
-package: clean
-	@python3 -m build
+package: clean package-osarch-specific
 
 # -----------------------------------------------------------------------------
 # Publish

README.md

@@ -79,9 +79,11 @@ and access it using the `senzing_grpc` Python package.
 
     ```python
     import grpc
-    from senzing_grpc import SzProduct
-    sz_product = SzProduct(grpc_channel=grpc.insecure_channel("localhost:8261"))
-    print(sz_product.version())
+    from senzing_grpc import SzAbstractFactory
+    sz_abstract_factory = SzAbstractFactory(grpc_channel=grpc.insecure_channel("localhost:8261"))
+    sz_product = sz_abstract_factory.create_sz_product()
+    print(sz_product.get_version())
+
     ```
 
 More can be seen in [Examples].

docs/development.md

@@ -64,7 +64,7 @@ Since the Senzing library is a prerequisite, it must be installed first.
 
 ## Working with grpc and Protobuffer files
 
-After copying files from [sz-sdk-proto/go],
+After copying files from [sz-sdk-proto/example_generated_source_code/python],
 an `import` statement must be modified in each of:
 
 - [szconfig_pb2_grpc.py]
@@ -240,10 +240,10 @@ Create a code coverage map.
 [pytest]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/pytest.md
 [Python]: https://www.python.org/
 [sphinx]: https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/sphinx.md
-[sz-sdk-proto/go]: https://github.com/senzing-garage/sz-sdk-proto/tree/main/go
 [szconfig_pb2_grpc.py]: ../src/senzing_grpc/pb2_grpc/szconfig_pb2_grpc.py
 [szconfigmanager_pb2_grpc.py]: ../src/senzing_grpc/pb2_grpc/szconfigmanager_pb2_grpc.py
 [szdiagnostic_pb2_grpc.py]: ../src/senzing_grpc/pb2_grpc/szdiagnostic_pb2_grpc.py
 [szengine_pb2_grpc.py]: ../src/senzing_grpc/pb2_grpc/szengine_pb2_grpc.py
 [szproduct_pb2_grpc.py]: ../src/senzing_grpc/pb2_grpc/szproduct_pb2_grpc.py
+[sz-sdk-proto/example_generated_source_code/python]: https://github.com/senzing-garage/sz-sdk-proto/tree/main/example_generated_source_code/python
 [Test PyPi]: https://test.pypi.org/

docs/source/senzing_grpc.rst

@@ -4,6 +4,14 @@ senzing package
 Submodules
 ----------
 
+senzing\_grpc.szabstractfactory module
+--------------------------------------
+
+.. automodule:: senzing_grpc.szabstractfactory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 senzing\_grpc.szconfig module
 -----------------------------
 

examples/szabstractfactory/a_header_szabstractfactory.py

@@ -0,0 +1,7 @@
+#! /usr/bin/env python3
+
+"""
+Simply a header used in development.
+"""
+
+print("\n---- szabstractfactory -----------------------------------------------\n")

examples/szabstractfactory/create_sz_config.py

@@ -0,0 +1,13 @@
+#! /usr/bin/env python3
+
+import grpc
+
+from senzing_grpc import SzAbstractFactory, SzError
+
+try:
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
+except SzError as err:
+    print(f"\nError:\n{err}\n")

examples/szabstractfactory/create_sz_configmanager.py

@@ -0,0 +1,13 @@
+#! /usr/bin/env python3
+
+import grpc
+
+from senzing_grpc import SzAbstractFactory, SzError
+
+try:
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_configmanager = sz_abstract_factory.create_sz_configmanager()
+except SzError as err:
+    print(f"\nError:\n{err}\n")

examples/szabstractfactory/create_sz_diagnostic.py

@@ -0,0 +1,13 @@
+#! /usr/bin/env python3
+
+import grpc
+
+from senzing_grpc import SzAbstractFactory, SzError
+
+try:
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_diagnostic = sz_abstract_factory.create_sz_diagnostic()
+except SzError as err:
+    print(f"\nError:\n{err}\n")

examples/szabstractfactory/create_sz_engine.py

@@ -0,0 +1,13 @@
+#! /usr/bin/env python3
+
+import grpc
+
+from senzing_grpc import SzAbstractFactory, SzError
+
+try:
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_engine = sz_abstract_factory.create_sz_engine()
+except SzError as err:
+    print(f"\nError:\n{err}\n")

examples/szabstractfactory/create_sz_product.py

@@ -0,0 +1,13 @@
+#! /usr/bin/env python3
+
+import grpc
+
+from senzing_grpc import SzAbstractFactory, SzError
+
+try:
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_product = sz_abstract_factory.create_sz_product()
+except SzError as err:
+    print(f"\nError:\n{err}\n")

examples/szconfig/add_data_source.py

@@ -2,14 +2,15 @@
 
 import grpc
 
-from senzing_grpc import SzConfig, SzError
+from senzing_grpc import SzAbstractFactory, SzError
 
 DATA_SOURCE_CODE = "NAME_OF_DATASOURCE"
-GRPC_URL = "localhost:8261"
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_config = SzConfig(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
     config_handle = sz_config.create_config()
     RESULT = sz_config.add_data_source(config_handle, DATA_SOURCE_CODE)
     sz_config.close_config(config_handle)

examples/szconfig/create_and_close.py

@@ -2,13 +2,13 @@
 
 import grpc
 
-from senzing_grpc import SzConfig, SzError
-
-GRPC_URL = "localhost:8261"
+from senzing_grpc import SzAbstractFactory, SzError
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_config = SzConfig(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
     config_handle = sz_config.create_config()
 
     # Do work.

examples/szconfig/create_export_import_close.py

@@ -2,13 +2,13 @@
 
 import grpc
 
-from senzing_grpc import SzConfig, SzError
-
-GRPC_URL = "localhost:8261"
+from senzing_grpc import SzAbstractFactory, SzError
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_config = SzConfig(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
     config_handle_1 = sz_config.create_config()  # Create first in-memory.
     CONFIG_DEFINITION = sz_config.export_config(
         config_handle_1

examples/szconfig/delete_data_source.py

@@ -2,14 +2,15 @@
 
 import grpc
 
-from senzing_grpc import SzConfig, SzError
+from senzing_grpc import SzAbstractFactory, SzError
 
 DATA_SOURCE_CODE = "TEST"
-GRPC_URL = "localhost:8261"
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_config = SzConfig(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
     config_handle = sz_config.create_config()
     sz_config.delete_data_source(config_handle, DATA_SOURCE_CODE)
     sz_config.close_config(config_handle)

examples/szconfig/export_config.py

@@ -2,13 +2,13 @@
 
 import grpc
 
-from senzing_grpc import SzConfig, SzError
-
-GRPC_URL = "localhost:8261"
+from senzing_grpc import SzAbstractFactory, SzError
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_config = SzConfig(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
     config_handle = sz_config.create_config()  # Create first in-memory.
     CONFIG_DEFINITION = sz_config.export_config(
         config_handle

examples/szconfig/get_data_sources.py

@@ -2,13 +2,13 @@
 
 import grpc
 
-from senzing_grpc import SzConfig, SzError
-
-GRPC_URL = "localhost:8261"
+from senzing_grpc import SzAbstractFactory, SzError
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_config = SzConfig(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
     config_handle = sz_config.create_config()
     RESULT = sz_config.get_data_sources(config_handle)
     sz_config.close_config(config_handle)

examples/szconfig/import_config.py

@@ -1,23 +1,22 @@
 #! /usr/bin/env python3
 
-
 import grpc
 
-from senzing_grpc import SzConfig, SzConfigManager, SzError
-
-GRPC_URL = "localhost:8261"
+from senzing_grpc import SzAbstractFactory, SzError
 
 try:
     # For this example, get default configuration.
 
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_configmanager = SzConfigManager(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
+    sz_configmanager = sz_abstract_factory.create_sz_configmanager()
     config_id = sz_configmanager.get_default_config_id()
     CONFIG_DEFINITION = sz_configmanager.get_config(config_id)
 
     # Import the configuration.
 
-    sz_config = SzConfig(grpc_channel=grpc_channel)
     config_handle = sz_config.import_config(CONFIG_DEFINITION)
 except SzError as err:
     print(f"\nError:\n{err}\n")

examples/szconfigmanager/add_config.py

@@ -2,15 +2,16 @@
 
 import grpc
 
-from senzing_grpc import SzConfig, SzConfigManager, SzError
+from senzing_grpc import SzAbstractFactory, SzError
 
 CONFIG_COMMENT = "Just an empty example"
-GRPC_URL = "localhost:8261"
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_config = SzConfig(grpc_channel=grpc_channel)
-    sz_configmanager = SzConfigManager(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_config = sz_abstract_factory.create_sz_config()
+    sz_configmanager = sz_abstract_factory.create_sz_configmanager()
     config_handle = sz_config.create_config()
     CONFIG_DEFINITION = sz_config.export_config(config_handle)
     config_id = sz_configmanager.add_config(CONFIG_DEFINITION, CONFIG_COMMENT)

examples/szconfigmanager/get_config.py

@@ -2,13 +2,13 @@
 
 import grpc
 
-from senzing_grpc import SzConfigManager, SzError
-
-GRPC_URL = "localhost:8261"
+from senzing_grpc import SzAbstractFactory, SzError
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_configmanager = SzConfigManager(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_configmanager = sz_abstract_factory.create_sz_configmanager()
     config_id = sz_configmanager.get_default_config_id()
     CONFIG_DEFINITION = sz_configmanager.get_config(config_id)
     print(CONFIG_DEFINITION[:66], "...")

examples/szconfigmanager/get_configs.py

@@ -2,13 +2,13 @@
 
 import grpc
 
-from senzing_grpc import SzConfigManager, SzError
-
-GRPC_URL = "localhost:8261"
+from senzing_grpc import SzAbstractFactory, SzError
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_configmanager = SzConfigManager(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_configmanager = sz_abstract_factory.create_sz_configmanager()
     CONFIG_LIST = sz_configmanager.get_configs()
     print(CONFIG_LIST[:66], "...")
 except SzError as err:

examples/szconfigmanager/get_default_config_id.py

@@ -2,13 +2,13 @@
 
 import grpc
 
-from senzing_grpc import SzConfigManager, SzError
-
-GRPC_URL = "localhost:8261"
+from senzing_grpc import SzAbstractFactory, SzError
 
 try:
-    grpc_channel = grpc.insecure_channel(GRPC_URL)
-    sz_configmanager = SzConfigManager(grpc_channel=grpc_channel)
+    sz_abstract_factory = SzAbstractFactory(
+        grpc_channel=grpc.insecure_channel("localhost:8261")
+    )
+    sz_configmanager = sz_abstract_factory.create_sz_configmanager()
     config_id = sz_configmanager.get_default_config_id()
 except SzError as err:
     print(f"\nError:\n{err}\n")