#153 - Test workflow

.github/workflows/create-sphinx-documentation.yaml

@@ -13,7 +13,6 @@ on: [push]
 permissions:
   contents: write
 
-# TODO - testing with adding senzing to install dependencies
 jobs:
   docs:
     runs-on: ubuntu-latest
@@ -34,7 +33,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install senzing==0.2.1 sphinx sphinx_rtd_theme myst_parser autodocsumm sphinx-toolbox sphinxext-remoteliteralinclude
+          python -m pip install documentation-requirements.txt
 
       - name: Sphinx build
         run: |

.github/workflows/pytest-linux.yaml

@@ -66,19 +66,6 @@ jobs:
           source ./venv/bin/activate
           pytest tests/ --verbose --capture=no --cov=src --cov-append
 
-      # TODO
-      # - name: Run unittest on examples
-      #   run: |
-      #     source ./venv/bin/activate
-      #     python3 -m unittest \
-      #       examples/szconfig/*.py \
-      #       examples/szconfigmanager/*.py \
-      #       examples/szdiagnostic/*.py \
-      #       examples/szengine/*.py \
-      #       examples/szproduct/*.py \
-      #       examples/misc/*.py \
-      #       || true
-
       # Use pytest to check examples, there are no "test" classes/functions, pytest imports
       # the .py files. If there is a Python error in the examples, an exit code of 1
       # is returned. If there are no Python errors but pytest didn't think it found any

Makefile

@@ -4,6 +4,11 @@
 
 include makefiles/osdetect.mk
 
+# Define newline for use
+define \n
+
+endef
+
 # -----------------------------------------------------------------------------
 # Variables
 # -----------------------------------------------------------------------------
@@ -60,13 +65,18 @@ hello-world: hello-world-osarch-specific
 .PHONY: venv
 venv: venv-osarch-specific
 
-# TODO Add for docs
 .PHONY: dependencies-for-development
 dependencies-for-development: venv dependencies-for-development-osarch-specific
 	$(activate-venv); \
 		python3 -m pip install --upgrade pip; \
 		python3 -m pip install --requirement development-requirements.txt
 
+.PHONY: dependencies-for-documentation
+dependencies-for-documentation: venv dependencies-for-documentation-osarch-specific
+	$(activate-venv); \
+		python3 -m pip install --upgrade pip; \
+		python3 -m pip install --requirement documentation-requirements.txt
+
 
 .PHONY: dependencies
 dependencies: venv
@@ -171,63 +181,74 @@ print-make-variables:
 
 .PHONY: bandit
 bandit:
+	$(info ${\n})
 	$(info --- bandit ---------------------------------------------------------------------)
 	@$(activate-venv); bandit -c pyproject.toml $(shell git ls-files '*.py' ':!:docs/source/*')
 
 
 .PHONY: black
 black:
+	$(info ${\n})
 	$(info --- black ----------------------------------------------------------------------)
 	@$(activate-venv); black $(shell git ls-files '*.py' ':!:docs/source/*')
 
 
 .PHONY: flake8
 flake8:
+	$(info ${\n})
 	$(info --- flake8 ---------------------------------------------------------------------)
 	@$(activate-venv); flake8 $(shell git ls-files '*.py' ':!:docs/source/*')
 
 
 .PHONY: isort
 isort:
+	$(info ${\n})
 	$(info --- isort ----------------------------------------------------------------------)
 	@$(activate-venv); isort $(shell git ls-files '*.py' ':!:docs/source/*')
 
 
 .PHONY: mypy
 mypy:
+	$(info ${\n})
 	$(info --- mypy -----------------------------------------------------------------------)
 	@$(activate-venv); mypy --strict $(shell git ls-files '*.py' ':!:docs/source/*')
 
 
 .PHONY: pydoc
 pydoc:
+	$(info ${\n})
 	$(info --- pydoc ----------------------------------------------------------------------)
 	@$(activate-venv); python3 -m pydoc
 
 
 .PHONY: pydoc-web
 pydoc-web:
+	$(info ${\n})
 	$(info --- pydoc-web ------------------------------------------------------------------)
 	@$(activate-venv); python3 -m pydoc -p 8885
 
 
 .PHONY: pylint
 pylint:
+	$(info ${\n})
 	$(info --- pylint ---------------------------------------------------------------------)
 	@$(activate-venv); pylint $(shell git ls-files '*.py' ':!:docs/source/*')
 
 
 .PHONY: pytest
 pytest:
+	$(info ${\n})
 	$(info --- pytest ---------------------------------------------------------------------)
 	@$(activate-venv); pytest $(shell git ls-files '*.py' ':!:docs/source/*')
 
 
 .PHONY: sphinx
 sphinx: sphinx-osarch-specific
+	$(info ${\n})
 	$(info --- sphinx ---------------------------------------------------------------------)
 
 
 .PHONY: view-sphinx
 view-sphinx: view-sphinx-osarch-specific
+	$(info ${\n})
 	$(info --- view-sphinx ----------------------------------------------------------------)

documentation-requirements.txt

@@ -0,0 +1,9 @@
+autodocsumm==0.2.14
+myst_parser==4.0.0
+senzing==0.2.1
+sphinx-autodoc-typehints==3.0.0
+sphinx-prompt==1.9.0
+sphinxext-remoteliteralinclude==0.5.0
+sphinx-rtd-theme==3.0.2
+sphinx-toolbox==3.8.0
+sphinx==8.1.3

examples/extras/abstract_factory_parameters.py

@@ -18,4 +18,4 @@
 try:
     sz_abstract_factory = SzAbstractFactoryCore(**FACTORY_PARAMETERS)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/extras/using_abstract_1.py

@@ -20,4 +20,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(**FACTORY_PARAMETERS)
     try_using_abstract(sz_abstract_factory)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/extras/using_abstract_2.py

@@ -13,7 +13,7 @@ def get_stats(sz_engine: SzEngine) -> None:
         stats = sz_engine.get_stats()
         print(f"Stats: {stats}")
     except SzError as err:
-        print(f"\nError: {err}\n")
+        print(f"\nERROR: {err}\n")
 
 
 def try_using_abstract(sz_abstract_factory: SzAbstractFactoryCore) -> None:
@@ -25,4 +25,4 @@ def try_using_abstract(sz_abstract_factory: SzAbstractFactoryCore) -> None:
         sz_engine = sz_abstract_factory.create_engine()
         get_stats(sz_engine)
     except SzError as err:
-        print(f"\nError: {err}\n")
+        print(f"\nERROR: {err}\n")

examples/misc/add_truthset_data.py

@@ -36,4 +36,4 @@
                 SZ_WITHOUT_INFO,
             )
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/misc/add_truthset_datasources.py

@@ -32,4 +32,4 @@
     sz_configmanager.replace_default_config_id(current_default_config_id, new_default_config_id)
     sz_abstract_factory.reinitialize(new_default_config_id)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/misc/individual_classes.py

@@ -69,4 +69,4 @@ def try_sz_product(sz_product_local: SzProduct) -> None:
     try_sz_product(sz_product)
 
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szabstractfactory/create_config.py

@@ -18,4 +18,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS)
     sz_config = sz_abstract_factory.create_config()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szabstractfactory/create_configmanager.py

@@ -18,4 +18,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS)
     sz_configmanager = sz_abstract_factory.create_configmanager()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szabstractfactory/create_diagnostic.py

@@ -18,4 +18,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS)
     sz_diagnostic = sz_abstract_factory.create_diagnostic()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szabstractfactory/create_engine.py

@@ -18,4 +18,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS)
     sz_engine = sz_abstract_factory.create_engine()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szabstractfactory/create_product.py

@@ -18,4 +18,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS)
     sz_product = sz_abstract_factory.create_product()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szabstractfactory/initialize_with_config_id.py

@@ -19,4 +19,4 @@
 try:
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS, CONFIG_ID)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szabstractfactory/initialize_with_debug.py

@@ -19,4 +19,4 @@
     # Create an engine to show debug output
     sz_abstract_factory.create_engine()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szabstractfactory/reinitialize.py

@@ -21,4 +21,4 @@
     config_id = sz_engine.get_active_config_id()
     sz_abstract_factory.reinitialize(config_id)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfig/add_data_source.py

@@ -23,4 +23,4 @@
     sz_config.close_config(config_handle)
     print(f"\n{RESULT}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfig/create_and_close.py

@@ -23,4 +23,4 @@
 
     sz_config.close_config(config_handle)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfig/create_export_import_close.py

@@ -23,4 +23,4 @@
     sz_config.close_config(config_handle_1)
     sz_config.close_config(config_handle_2)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfig/delete_data_source.py

@@ -22,4 +22,4 @@
     sz_config.delete_data_source(config_handle, DATA_SOURCE_CODE)
     sz_config.close_config(config_handle)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfig/export_config.py

@@ -22,4 +22,4 @@
     sz_config.close_config(config_handle)
     print(f"\n{CONFIG_DEFINITION}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfig/get_data_sources.py

@@ -22,4 +22,4 @@
     sz_config.close_config(config_handle)
     print(f"\n{RESULT}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfig/import_config.py

@@ -22,4 +22,4 @@
     CONFIG_DEFINITION = sz_configmanager.get_config(config_id)
     config_handle = sz_config.import_config(CONFIG_DEFINITION)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfig/szconfig_constructor.py

@@ -18,4 +18,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS)
     sz_config = sz_abstract_factory.create_config()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfigmanager/add_config.py

@@ -23,4 +23,4 @@
     CONFIG_DEFINITION = sz_config.export_config(config_handle)
     config_id = sz_configmanager.add_config(CONFIG_DEFINITION, CONFIG_COMMENT)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfigmanager/get_config.py

@@ -21,4 +21,4 @@
     CONFIG_DEFINITION = sz_configmanager.get_config(config_id)
     print(f"\n{CONFIG_DEFINITION}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfigmanager/get_configs.py

@@ -20,4 +20,4 @@
     CONFIG_LIST = sz_configmanager.get_configs()
     print(f"\n{CONFIG_LIST}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfigmanager/get_default_config_id.py

@@ -20,4 +20,4 @@
     CONFIG_ID = sz_configmanager.get_default_config_id()
     print(f"\n{CONFIG_ID}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfigmanager/replace_default_config_id.py

@@ -36,4 +36,4 @@
 
     sz_configmanager.replace_default_config_id(current_default_config_id, new_default_config_id)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfigmanager/set_default_config_id.py

@@ -36,4 +36,4 @@
 
     sz_configmanager.set_default_config_id(config_id)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szconfigmanager/szconfigmanager_constructor.py

@@ -17,4 +17,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS)
     sz_configmanager = sz_abstract_factory.create_configmanager()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szdiagnostic/check_datastore_performance.py

@@ -22,4 +22,4 @@
     RESULT = sz_diagnostic.check_datastore_performance(SECONDS_TO_RUN)
     print(f"\n{RESULT}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szdiagnostic/get_datastore_info.py

@@ -20,4 +20,4 @@
     RESULT = sz_diagnostic.get_datastore_info()
     print(f"\n{RESULT}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szdiagnostic/get_feature.py

@@ -20,4 +20,4 @@
     RESULT = sz_diagnostic.get_feature(1)
     print(f"\n{RESULT}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szdiagnostic/purge_repository.py

@@ -24,4 +24,4 @@
 
     # sz_diagnostic.purge_repository()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szdiagnostic/szdiagnostic_constructor.py

@@ -18,4 +18,4 @@
     sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS)
     sz_diagnostic = sz_abstract_factory.create_diagnostic()
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szengine/add_record.py

@@ -39,4 +39,4 @@
     RESULT = sz_engine.add_record(DATA_SOURCE_CODE, RECORD_ID, RECORD_DEFINITION, FLAGS)
     print(f"\n{RESULT}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szengine/count_redo_records.py

@@ -20,4 +20,4 @@
     RESULT = sz_engine.count_redo_records()
     print(f"\n{RESULT}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szengine/delete_record.py

@@ -23,4 +23,4 @@
     RESULT = sz_engine.delete_record(DATA_SOURCE_CODE, RECORD_ID, FLAGS)
     print(f"\n{RESULT}\n")
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szengine/export_csv_fetch_close.py

@@ -29,4 +29,4 @@
         print(fragment, end="")
     sz_engine.close_export(export_handle)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")

examples/szengine/export_json_fetch_close.py

@@ -25,4 +25,4 @@
         print(fragment, end="")
     sz_engine.close_export(export_handle)
 except SzError as err:
-    print(f"\nError: {err}\n")
+    print(f"\nERROR: {err}\n")