#153 - Save point, cleanup

senzing-garage · Jan 23, 2025 · c2cf7fd · c2cf7fd
1 parent 1552952
commit c2cf7fd
Show file tree

Hide file tree

Showing 153 changed files with 171 additions and 5,615 deletions.
diff --git a/.github/workflows/create-sphinx-documentation.yaml b/.github/workflows/create-sphinx-documentation.yaml
@@ -29,7 +29,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install sphinx sphinx_rtd_theme myst_parser autodocsumm sphinx-toolbox
+          python -m pip install sphinx sphinx_rtd_theme myst_parser autodocsumm sphinx-toolbox sphinxext-remoteliteralinclude
 
       - name: Sphinx build
         run: |

diff --git a/development-requirements.txt b/development-requirements.txt
@@ -15,6 +15,7 @@ sphinx-autodoc-typehints==3.0.0
 sphinx-gallery==0.18.0
 sphinx-jinja2-compat==0.3.0
 sphinx-prompt==1.9.0
+sphinxext-remoteliteralinclude==0.5.0
 sphinx-rtd-theme==3.0.2
 sphinx-tabs==3.4.7
 sphinx-toolbox==3.8.0

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -10,7 +10,7 @@
 import sys
 
 project = "sz-sdk-python"
-copyright = "2024, Senzing"
+copyright = "2025, Senzing"
 author = "senzing"
 
 # -- General configuration ---------------------------------------------------
@@ -41,6 +41,7 @@
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",  # to read Google-style or Numpy-style docstrings
+    "sphinxext.remoteliteralinclude",  # extends literalinclude to be able to pull files from URLs
     "sphinx.ext.viewcode",  # to allow vieing the source code in the web page
 ]
 

diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,16 @@
+# Examples
+
+Examples are available at the following locations. Senzing SDK V4 is still in beta, these locations and links may change!
+
+- [V4 Beta] on docs.senzing.com
+
+- [Core implementation] on GitHub
+
+- [gRPC implementation] on GitHub
+
+- [Sphinx documentation]
+
+[Core implementation]: https://github.com/senzing-garage/sz-sdk-python-core/tree/main/examples
+[V4 Beta]: https://senzing.com/docs/4_beta/python/index.html
+[gRPC implementation]: https://github.com/senzing-garage/sz-sdk-python-grpc/tree/main/examples
+[Sphinx documentation]: https://garage.senzing.com/sz-sdk-python/
diff --git a/examples/extras/szdiagnostic/szdiagnostic_initialize_with_debug.py b/examples/extras/szdiagnostic/szdiagnostic_initialize_with_debug.py
diff --git a/examples/extras/szengine/add_record_with_info.py b/examples/extras/szengine/add_record_with_info.py
diff --git a/examples/extras/szengine/add_record_with_info.txt b/examples/extras/szengine/add_record_with_info.txt
diff --git a/examples/extras/szengine/delete_record_with_info.py b/examples/extras/szengine/delete_record_with_info.py
diff --git a/examples/extras/szengine/delete_record_with_info.txt b/examples/extras/szengine/delete_record_with_info.txt
diff --git a/examples/extras/szengine/export_csv_entity_report.py b/examples/extras/szengine/export_csv_entity_report.py
diff --git a/examples/extras/szengine/export_json_entity_report.py b/examples/extras/szengine/export_json_entity_report.py
diff --git a/examples/extras/szengine/fetch_next.py b/examples/extras/szengine/fetch_next.py
diff --git a/examples/extras/szengine/find_path_by_entity_id_with_exclusions.py b/examples/extras/szengine/find_path_by_entity_id_with_exclusions.py
diff --git a/examples/extras/szengine/find_path_by_entity_id_with_exclusions_and_required_data_sources.py b/examples/extras/szengine/find_path_by_entity_id_with_exclusions_and_required_data_sources.py
diff --git a/examples/extras/szengine/find_path_by_entity_id_with_required_data_sources.py b/examples/extras/szengine/find_path_by_entity_id_with_required_data_sources.py
diff --git a/examples/extras/szengine/find_path_by_record_id_with_exclusions.py b/examples/extras/szengine/find_path_by_record_id_with_exclusions.py
diff --git a/examples/extras/szengine/find_path_by_record_id_with_exclusions_and_required_data_sources.py b/examples/extras/szengine/find_path_by_record_id_with_exclusions_and_required_data_sources.py
diff --git a/examples/extras/szengine/find_path_by_record_id_with_required_data_sources.py b/examples/extras/szengine/find_path_by_record_id_with_required_data_sources.py
diff --git a/examples/extras/szengine/g2engine_initialize_with_config_id.py b/examples/extras/szengine/g2engine_initialize_with_config_id.py
diff --git a/examples/extras/szengine/reevaluate_entity_with_info.py b/examples/extras/szengine/reevaluate_entity_with_info.py
diff --git a/examples/extras/szengine/reevaluate_entity_with_info.txt b/examples/extras/szengine/reevaluate_entity_with_info.txt
diff --git a/examples/extras/szengine/reevaluate_record_with_info.py b/examples/extras/szengine/reevaluate_record_with_info.py
diff --git a/examples/extras/szengine/reevaluate_record_with_info.txt b/examples/extras/szengine/reevaluate_record_with_info.txt
diff --git a/examples/extras/szengine/szengine_initialize_constructor.py b/examples/extras/szengine/szengine_initialize_constructor.py
diff --git a/examples/misc/a_header_misc.py b/examples/misc/a_header_misc.py
diff --git a/examples/misc/add_truthset_data.py b/examples/misc/add_truthset_data.py
diff --git a/examples/misc/add_truthset_datasources.py b/examples/misc/add_truthset_datasources.py
diff --git a/examples/misc/engine_flags_combine_flags.py b/examples/misc/engine_flags_combine_flags.py
diff --git a/examples/misc/engine_flags_combine_flags.txt b/examples/misc/engine_flags_combine_flags.txt
diff --git a/examples/szabstractfactory/a_header_szabstractfactory.py b/examples/szabstractfactory/a_header_szabstractfactory.py
diff --git a/examples/szabstractfactory/create_config.py b/examples/szabstractfactory/create_config.py
diff --git a/examples/szabstractfactory/create_config.txt b/examples/szabstractfactory/create_config.txt
diff --git a/examples/szabstractfactory/create_configmanager.py b/examples/szabstractfactory/create_configmanager.py
diff --git a/examples/szabstractfactory/create_configmanager.txt b/examples/szabstractfactory/create_configmanager.txt
diff --git a/examples/szabstractfactory/create_diagnostic.py b/examples/szabstractfactory/create_diagnostic.py
diff --git a/examples/szabstractfactory/create_diagnostic.txt b/examples/szabstractfactory/create_diagnostic.txt
diff --git a/examples/szabstractfactory/create_engine.py b/examples/szabstractfactory/create_engine.py
diff --git a/examples/szabstractfactory/create_engine.txt b/examples/szabstractfactory/create_engine.txt
diff --git a/examples/szabstractfactory/create_product.py b/examples/szabstractfactory/create_product.py
diff --git a/examples/szabstractfactory/create_product.txt b/examples/szabstractfactory/create_product.txt
diff --git a/examples/szabstractfactory/initialize_with_config_id.py b/examples/szabstractfactory/initialize_with_config_id.py
diff --git a/examples/szabstractfactory/initialize_with_debug.py b/examples/szabstractfactory/initialize_with_debug.py
diff --git a/examples/szabstractfactory/reinitialize.py b/examples/szabstractfactory/reinitialize.py
diff --git a/examples/szconfig/a_header_szconfig.py b/examples/szconfig/a_header_szconfig.py
diff --git a/examples/szconfig/add_data_source.py b/examples/szconfig/add_data_source.py
diff --git a/examples/szconfig/add_data_source.txt b/examples/szconfig/add_data_source.txt
diff --git a/examples/szconfig/create_and_close.py b/examples/szconfig/create_and_close.py
diff --git a/examples/szconfig/create_export_import_close.py b/examples/szconfig/create_export_import_close.py