#134 Change sz-sdk-python to sz-sdk-python-core

.github/workflows/pytest-darwin.yaml

@@ -5,7 +5,7 @@ on: [pull_request, workflow_dispatch]
 env:
   DYLD_LIBRARY_PATH: /opt/senzing/er/lib:/opt/senzing/er/lib/macos
   LD_LIBRARY_PATH: /opt/senzing/er/lib:/opt/senzing/er/lib/macos
-  PYTHONPATH: /Users/runner/work/sz-sdk-python/sz-sdk-python/src
+  PYTHONPATH: /Users/runner/work/sz-sdk-python-core/sz-sdk-python-core/src
   SENZING_TOOLS_DATABASE_URL: sqlite3://na:na@nowhere/tmp/sqlite/G2C.db
 
 permissions:

.github/workflows/pytest-linux.yaml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 env:
   LD_LIBRARY_PATH: /opt/senzing/er/lib
-  PYTHONPATH: /home/runner/work/sz-sdk-python/sz-sdk-python/src
+  PYTHONPATH: /home/runner/work/sz-sdk-python-core/sz-sdk-python-core/src
   SENZING_TOOLS_DATABASE_URL: sqlite3://na:na@nowhere/tmp/sqlite/G2C.db
 
 permissions:

.github/workflows/pytest-windows.yaml

@@ -4,7 +4,7 @@ on: [pull_request, workflow_dispatch]
 
 env:
   LD_LIBRARY_PATH: 'C:\Program Files\Senzing\er\lib'
-  PYTHONPATH: 'D:\a\sz-sdk-python\sz-sdk-python\src'
+  PYTHONPATH: 'D:\a\sz-sdk-python-core\sz-sdk-python-core\src'
   SENZING_TOOLS_DATABASE_URL: 'sqlite3://na:na@nowhere/C:\Temp\sqlite\G2C.db'
 
 permissions:

CONTRIBUTING.md

@@ -80,7 +80,7 @@ The variables are used throughout the installation procedure.
 
 ```console
 export GIT_ACCOUNT=senzing-garage
-export GIT_REPOSITORY=sz-sdk-python
+export GIT_REPOSITORY=sz-sdk-python-core
 ```
 
 Synthesize environment variables.

README.md

@@ -1,4 +1,4 @@
-# sz-sdk-python
+# sz-sdk-python-core
 
 If you are beginning your journey with [Senzing],
 please start with [Senzing Quick Start guides].
@@ -8,15 +8,15 @@ Although this GitHub repository may help you understand an approach to using Sen
 it's not considered to be "production ready" and is not considered to be part of the Senzing product.
 Heck, it may not even be appropriate for your application of Senzing!
 
-## :warning: WARNING: sz-sdk-python is still in development :warning: _
+## :warning: WARNING: sz-sdk-python-core is still in development :warning: _
 
 At the moment, this is "work-in-progress" with Semantic Versions of `0.n.x`.
 Although it can be reviewed and commented on,
 the recommendation is not to use it yet.
 
 ## Synopsis
 
-The Senzing sz-sdk-python packages provide a [Python]
+The Senzing sz-sdk-python-core packages provide a [Python]
 language Software Development Kit that wraps the Senzing C SDK APIs.
 
 [![Python 3.11 Badge]][Python 3.11]
@@ -28,7 +28,7 @@ language Software Development Kit that wraps the Senzing C SDK APIs.
 
 ## Overview
 
-The Senzing `sz-sdk-python` packages enable Python programs to call Senzing library functions.
+The Senzing `sz-sdk-python-core` packages enable Python programs to call Senzing library functions.
 Under the covers, Python makes calls to the functions in the Senzing C libraries.
 
 ## Use
@@ -43,20 +43,20 @@ Under the covers, Python makes calls to the functions in the Senzing C libraries
 1. Related artifacts:
     1. [DockerHub]
 
-[Coverage badge]: https://img.shields.io/badge/dynamic/json?color=brightgreen&label=coverage&query=%24.message&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsenzing-garage%2Fsz-sdk-python%2Fpython-coverage-comment-action-data%2Fendpoint.json
-[Coverage]: https://htmlpreview.github.io/?https://github.com/senzing-garage/sz-sdk-python/blob/python-coverage-comment-action-data/htmlcov/index.html
+[Coverage badge]: https://img.shields.io/badge/dynamic/json?color=brightgreen&label=coverage&query=%24.message&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsenzing-garage%2Fsz-sdk-python-core%2Fpython-coverage-comment-action-data%2Fendpoint.json
+[Coverage]: https://htmlpreview.github.io/?https://github.com/senzing-garage/sz-sdk-python-core/blob/python-coverage-comment-action-data/htmlcov/index.html
 [Development]: docs/development.md
-[DockerHub]: https://hub.docker.com/r/senzing/sz-sdk-python
-[Downloads Badge]: https://static.pepy.tech/badge/sz-sdk-python
-[Downloads]: https://pepy.tech/project/sz-sdk-python
+[DockerHub]: https://hub.docker.com/r/senzing/sz-sdk-python-core
+[Downloads Badge]: https://static.pepy.tech/badge/sz-sdk-python-core
+[Downloads]: https://pepy.tech/project/sz-sdk-python-core
 [Errors]: docs/errors.md
 [Examples]: docs/examples.md
 [License Badge]: https://img.shields.io/badge/License-Apache2-brightgreen.svg
-[License]: https://github.com/senzing-garage/sz-sdk-python/blob/main/LICENSE
+[License]: https://github.com/senzing-garage/sz-sdk-python-core/blob/main/LICENSE
 [PEP8 Badge]: https://img.shields.io/badge/code%20style-pep8-orange.svg
 [PEP8]: https://www.python.org/dev/peps/pep-0008/
-[PyPI version Badge]: https://badge.fury.io/py/sz-sdk-python.svg
-[PyPi version]: https://badge.fury.io/py/sz-sdk-python
+[PyPI version Badge]: https://badge.fury.io/py/sz-sdk-python-core.svg
+[PyPi version]: https://badge.fury.io/py/sz-sdk-python-core
 [Python 3.11 Badge]: https://img.shields.io/badge/python-3.11-blue.svg
 [Python 3.11]: https://www.python.org/downloads/release/python-3110/
 [Python]: https://www.python.org/

docs/development.md

@@ -1,4 +1,4 @@
-# sz-sdk-python development
+# sz-sdk-python-core development
 
 The following instructions are useful during development.
 
@@ -34,7 +34,7 @@ Since the Senzing library is a prerequisite, it must be installed first.
 
    ```console
    export GIT_ACCOUNT=senzing-garage
-   export GIT_REPOSITORY=sz-sdk-python
+   export GIT_REPOSITORY=sz-sdk-python-core
    export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
    export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
 
@@ -173,7 +173,7 @@ Create a code coverage map.
 
    Example return:
 
-   > senzing @ file:///home/senzing/senzing-garage.git/sz-sdk-python-/dist/senzing-0.0.1-py3-none-any.whl#sha256=2a4e5218d66d5be60ee31bfad5943e6611fc921f28a4326d9594ceceae7e0ac1
+   > senzing @ file:///home/senzing/senzing-garage.git/sz-sdk-python-core/dist/senzing-0.0.1-py3-none-any.whl#sha256=2a4e5218d66d5be60ee31bfad5943e6611fc921f28a4326d9594ceceae7e0ac1
 
 1. Uninstall the `senzing` python package.
    Example:

docs/source/conf.py

@@ -9,7 +9,7 @@
 import os
 import sys
 
-project = "sz-sdk-python"
+project = "sz-sdk-python-core"
 copyright = "2024, Senzing"
 author = "senzing"
 

docs/source/index.rst

@@ -1,10 +1,10 @@
-.. sz-sdk-python documentation master file, created by
+.. sz-sdk-python-core documentation master file, created by
    sphinx-quickstart on Thu Oct 19 16:35:58 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-sz-sdk-python
-=============
+sz-sdk-python-core
+==================
 
 .. toctree::
    :maxdepth: 2

setup.cfg

@@ -7,9 +7,9 @@ description = Python SDK for Senzing API
 license = Apache 2
 long_description = file: README.md
 long_description_content_type = text/markdown
-url = https://github.com/senzing-garage/sz-sdk-python
+url = https://github.com/senzing-garage/sz-sdk-python-core
 project_urls =
-    Bug Tracker = https://github.com/senzing-garage/sz-sdk-python/issues
+    Bug Tracker = https://github.com/senzing-garage/sz-sdk-python-core/issues
 classifiers =
     Programming Language :: Python :: 3
     License :: OSI Approved :: Apache Software License

src/senzing_core/szconfig.py

@@ -2,7 +2,7 @@
 The `szconfig` package is used to modify the in-memory representation of a Senzing configuration.
 It is a wrapper over Senzing's SzConfig C binding.
 It conforms to the interface specified in
-`szconfig_abstract.py <https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing_abstract/szconfig_abstract.py>`_
+`szconfig_abstract.py <https://github.com/senzing-garage/sz-sdk-python-core/blob/main/src/senzing_abstract/szconfig_abstract.py>`_
 
 To use szconfig,
 the **LD_LIBRARY_PATH** environment variable must include a path to Senzing's libraries.

src/senzing_core/szconfigmanager.py

@@ -2,7 +2,7 @@
 The `szconfigmanager` package is used to modify Senzing configurations in the Senzing database.
 It is a wrapper over Senzing's SzConfigMgr C binding.
 It conforms to the interface specified in
-`szconfigmanager_abstract.py <https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing_abstract/szconfigmanager_abstract.py>`_
+`szconfigmanager_abstract.py <https://github.com/senzing-garage/sz-sdk-python-core/blob/main/src/senzing_abstract/szconfigmanager_abstract.py>`_
 
 To use szconfigmanager,
 the **LD_LIBRARY_PATH** environment variable must include a path to Senzing's libraries.

src/senzing_core/szdiagnostic.py

@@ -2,7 +2,7 @@
 The `szdiagnostic` package is used to inspect the Senzing environment.
 It is a wrapper over Senzing's SzDiagnostic C binding.
 It conforms to the interface specified in
-`szdiagnostic_abstract.py <https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing_abstract/szdiagnostic_abstract.py>`_
+`szdiagnostic_abstract.py <https://github.com/senzing-garage/sz-sdk-python-core/blob/main/src/senzing_abstract/szdiagnostic_abstract.py>`_
 
 To use szdiagnostic,
 the **LD_LIBRARY_PATH** environment variable must include a path to Senzing's libraries.

src/senzing_core/szengine.py

@@ -2,7 +2,7 @@
 The szengine package is used to insert, update, delete and query records and entities in the Senzing product.
 It is a wrapper over Senzing's SzEngine C binding.
 It conforms to the interface specified in
-`szengine_abstract.py <https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing_abstract/szengine_abstract.py>`_
+`szengine_abstract.py <https://github.com/senzing-garage/sz-sdk-python-core/blob/main/src/senzing_abstract/szengine_abstract.py>`_
 
 To use szengine,
 the **LD_LIBRARY_PATH** environment variable must include a path to Senzing's libraries.

src/senzing_core/szproduct.py

@@ -2,7 +2,7 @@
 The `szproduct` package is used to inspect the Senzing product.
 It is a wrapper over Senzing's SzProduct C binding.
 It conforms to the interface specified in
-`szproduct_abstract.py <https://github.com/senzing-garage/sz-sdk-python/blob/main/src/senzing_abstract/szproduct_abstract.py>`_
+`szproduct_abstract.py <https://github.com/senzing-garage/sz-sdk-python-core/blob/main/src/senzing_abstract/szproduct_abstract.py>`_
 
 To use szproduct,
 the **LD_LIBRARY_PATH** environment variable must include a path to Senzing's libraries.

tests/szabstractfactory_test.py

@@ -29,31 +29,31 @@
 # -----------------------------------------------------------------------------
 
 
-def test_create_sz_config(sz_abstract_factory: SzAbstractFactory) -> None:
+def test_create_config(sz_abstract_factory: SzAbstractFactory) -> None:
     """Create SzConfig."""
     actual = sz_abstract_factory.create_config()
     assert isinstance(actual, SzConfig)
 
 
-def test_create_sz_configmanager(sz_abstract_factory: SzAbstractFactory) -> None:
+def test_create_configmanager(sz_abstract_factory: SzAbstractFactory) -> None:
     """Create SzConfigManager."""
     actual = sz_abstract_factory.create_configmanager()
     assert isinstance(actual, SzConfigManager)
 
 
-def test_create_sz_diagnostic(sz_abstract_factory: SzAbstractFactory) -> None:
+def test_create_diagnostic(sz_abstract_factory: SzAbstractFactory) -> None:
     """Create SzDiagnostic."""
     actual = sz_abstract_factory.create_diagnostic()
     assert isinstance(actual, SzDiagnostic)
 
 
-def test_create_sz_engine(sz_abstract_factory: SzAbstractFactory) -> None:
+def test_create_engine(sz_abstract_factory: SzAbstractFactory) -> None:
     """Create SzEngine."""
     actual = sz_abstract_factory.create_engine()
     assert isinstance(actual, SzEngine)
 
 
-def test_create_sz_product(sz_abstract_factory: SzAbstractFactory) -> None:
+def test_create_product(sz_abstract_factory: SzAbstractFactory) -> None:
     """Create SzProduct."""
     actual = sz_abstract_factory.create_product()
     assert isinstance(actual, SzProduct)