153 ant 1 (#167)

* #153 - Save point, cleanup * #153 - Save point * #153 - Save point * # 152 - Save point * # 153 - Save point * #153 - Save point * #153 #164 #162 * #153 #164 #162 * Pull main commits into 153-ant-1 (#166) * Bump bandit from 1.8.0 to 1.8.2 (#154) Bumps [bandit](https://github.com/PyCQA/bandit) from 1.8.0 to 1.8.2. - [Release notes](https://github.com/PyCQA/bandit/releases) - [Commits](PyCQA/bandit@1.8.0...1.8.2) --- updated-dependencies: - dependency-name: bandit dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump virtualenv from 20.28.1 to 20.29.0 (#155) Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.28.1 to 20.29.0. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.28.1...20.29.0) --- updated-dependencies: - dependency-name: virtualenv dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump sphinx-autodoc-typehints from 3.0.0 to 3.0.1 (#157) Bumps [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) from 3.0.0 to 3.0.1. - [Release notes](https://github.com/tox-dev/sphinx-autodoc-typehints/releases) - [Commits](tox-dev/sphinx-autodoc-typehints@3.0.0...3.0.1) --- updated-dependencies: - dependency-name: sphinx-autodoc-typehints dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump virtualenv from 20.29.0 to 20.29.1 (#158) Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.29.0 to 20.29.1. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.29.0...20.29.1) --- updated-dependencies: - dependency-name: virtualenv dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump twine from 6.0.1 to 6.1.0 (#161) Bumps [twine](https://github.com/pypa/twine) from 6.0.1 to 6.1.0. - [Release notes](https://github.com/pypa/twine/releases) - [Changelog](https://github.com/pypa/twine/blob/main/docs/changelog.rst) - [Commits](pypa/twine@6.0.1...6.1.0) --- updated-dependencies: - dependency-name: twine dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * #153 #164 #162 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
senzing-garage · Jan 28, 2025 · 6497daa · 6497daa
1 parent 41d2245
commit 6497daa
Show file tree

Hide file tree

Showing 165 changed files with 1,320 additions and 6,057 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 --requirement documentation-requirements.txt
 
       - name: Sphinx build
         run: |

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.2.2] - 2025-01-28
+
+### Added in 0.2.2
+
+- Simpler class methods for szengineflags to build upon in a future release
+- documentation-requirements.txt 
+
+### Changed in 0.2.2
+
+- Switched Git workflows and make files to pytest
+- Modified Sphinx documentation to pull examples from core and gRPC repositories
+- General documentation updates
+
+### Removed in 0.2.2
+
+- Class methods for szengineflags, only required one moved to sz-python-tools helpers
+- Examples, now referenced in core and gRPC when building docs
+
+### Fixed in 0.2.2
+
+- Fixed error from building Sphinx doc for html_static_path = ["_static"]
+
 ## [0.2.1] - 2025-01-09
 
 ### Changed in 0.2.1

diff --git a/Makefile b/Makefile
@@ -4,6 +4,11 @@
 
 include makefiles/osdetect.mk
 
+# Define newline for use
+define \n
+
+endef
+
 # -----------------------------------------------------------------------------
 # Variables
 # -----------------------------------------------------------------------------
@@ -70,6 +75,12 @@ dependencies-for-development: venv dependencies-for-development-osarch-specific
 		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
@@ -113,15 +124,15 @@ test-tests:
 	@$(activate-venv); pytest tests --verbose --capture=no --cov=src/senzing --cov-report xml:coverage.xml
 
 
-.PHONY: test-examples
-test-examples:
-	$(info --- Test examples --------------------------------------------------------------)
-	@$(activate-venv); python3 -m unittest \
-		examples/szconfig/*.py \
-		examples/szconfigmanager/*.py \
-		examples/szdiagnostic/*.py \
-		examples/szengine/*.py \
-		examples/szproduct/*.py
+# .PHONY: test-examples
+# test-examples:
+# 	$(info --- Test examples --------------------------------------------------------------)
+# 	@$(activate-venv); python3 -m unittest \
+# 		examples/szconfig/*.py \
+# 		examples/szconfigmanager/*.py \
+# 		examples/szdiagnostic/*.py \
+# 		examples/szengine/*.py \
+# 		examples/szproduct/*.py
 
 
 .PHONY: docker-test
@@ -187,63 +198,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/*' ':!:examples/*')
 
 
 .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 ----------------------------------------------------------------)
diff --git a/development-requirements.txt b/development-requirements.txt
@@ -15,6 +15,7 @@ sphinx-autodoc-typehints==3.0.1
 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/development.md b/docs/development.md
@@ -63,6 +63,15 @@ Since the Senzing library is a prerequisite, it must be installed first.
 
    ```
 
+1. Install dependencies needed for documentation.
+   Example:
+
+   ```console
+   cd ${GIT_REPOSITORY_DIR}
+   make dependencies-for-documentation
+
+   ```
+
 ## Lint
 
 1. Run linting.

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/documentation-requirements.txt b/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
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