#96 Add destroy() and reinitialize() to SzAbstractFactory (#97)

* #96 Refactor to template

* #96 Refactor to template

* #96 Savepoint

* #96 Fix documentation

* #96 Fix workflow issues - 1

* #96 Bump version

* #96 Prepare for versioned release

* #96 Prepare for versioned release

* #96 Prepare for versioned release

* #96 Prepare for versioned release

.github/linters/.jscpd.json

@@ -1 +1 @@
-{}
+{}

.github/linters/README.md

@@ -1,5 +1,20 @@
 # Linters
 
+## .jscpd.json
+
+- [.jscpd.json]
+- Used by [lint-workflows.yaml]
+- [jscpd]
+  - [jscpd configuration]
+  - Example:
+
+    ```json
+    {
+      "ignore": ["**/*.go,**/go-test*.yaml"],
+      "threshold": 10
+    }
+    ```
+
 ## .yaml-lint.yml
 
 - [.yaml-lint.yml]

.github/workflows/README.md

@@ -6,23 +6,23 @@ When issues are opened,
 this action adds appropriate labels to the issue.
 (e.g. "triage", "customer-submission")
 
-- [Add Labels Standardized GitHub action]
+- [Add Labels Standardized GitHub Action]
   - Uses: [senzing-factory/build-resources/.../add-labels-to-issue.yaml]
 
 ## add-to-project-garage-dependabot.yaml
 
 When a Dependabot Pull Request (PR) is made against `main` branch,
 this action adds the PR to the "Garage" project board as "In Progress".
 
-- [Add to Project Garage Dependabot GitHub action]
+- [Add to Project Garage Dependabot GitHub Action]
   - Uses: [senzing-factory/build-resources/.../add-to-project-dependabot.yaml]
 
 ## add-to-project-garage.yaml
 
 When an issue is created,
 this action adds the issue to the "Garage" board as "Backlog".
 
-- [Add to Project Garage GitHub action]
+- [Add to Project Garage GitHub Action]
   - Uses: [senzing-factory/build-resources/.../add-to-project.yaml]
 
 ## bandit.yaml
@@ -46,7 +46,7 @@ When a Dependabot Pull Request (PR) is made against the `main` branch,
 this action determines if it should be automatically approved and merged into the `main` branch.
 Once this action occurs [move-pr-to-done-dependabot.yaml] moves the PR on the "Garage" project board to "Done".
 
-- [Dependabot Approve and Merge GitHub action]
+- [Dependabot Approve and Merge GitHub Action]
   - Uses: [senzing-factory/build-resources/.../dependabot-approve-and-merge.yaml]
 
 ## dependency-scan.yaml
@@ -64,17 +64,17 @@ this action runs [Fast Python Vulnerability Scanner] and [pip-audit].
 When a Pull Request is made against the `main` branch,
 this action verifies that the `Dockerfile` can be successfully built.
 
-*Note:* The Docker image is **not** pushed to [DockerHub].
+_Note:_ The Docker image is **not** pushed to [DockerHub].
 
-- [Docker Build Container GitHub action]
+- [Docker Build Container GitHub Action]
   - Uses: [senzing-factory/github-action-docker-buildx-build]
 
 ## docker-push-containers-to-dockerhub.yaml
 
 After a [Semantic Version] release is created,
 this action builds Docker images on multiple architectures and pushes the Docker images to [DockerHub].
 
-- [Docker Push Containers to DockerHub GitHub action]
+- [Docker Push Containers to DockerHub GitHub Action]
   - Uses: [senzing-factory/github-action-docker-buildx-build]
 
 ## flake8.yaml
@@ -98,7 +98,7 @@ this action runs [isort] to sort the Python import statements
 When a change is committed to GitHub or a Pull Request is made against the `main` branch,
 this action runs [super-linter] to run multiple linters against the code.
 
-- [Lint Workflows GitHub action]
+- [Lint Workflows GitHub Action]
   - Configuration:
     - [.checkov.yaml]
     - [.jscpd.json]
@@ -110,7 +110,7 @@ this action runs [super-linter] to run multiple linters against the code.
 When a Pull Request is merged into the `main` branch,
 this action moves the PR on the "Garage" project board to "Done".
 
-- [Move PR to Done Dependabot GitHub action]
+- [Move PR to Done Dependabot GitHub Action]
   - Uses: [senzing-factory/build-resources/.../move-pr-to-done-dependabot.yaml]
 
 ## mypy.yaml
@@ -166,33 +166,33 @@ this action runs [pytest] on the Windows platform to perform unit tests and code
     - [pytest]
     - [actions/upload-artifact]
 
-[.checkov.yaml]:  ../linters/README.md#checkovyaml
+[.checkov.yaml]: ../linters/README.md#checkovyaml
 [.jscpd.json]: ../linters/README.md#jscpdjson
 [.yaml-lint.yml]: ../linters/README.md#yaml-lintyml
 [actions/checkout]: https://github.com/actions/checkout
 [actions/setup-python]: https://github.com/actions/setup-python
 [actions/upload-artifact]: https://github.com/actions/upload-artifact
-[Add Labels Standardized GitHub action]: add-labels-standardized.yaml
-[Add to Project Garage Dependabot GitHub action]: add-to-project-garage-dependabot.yaml
-[Add to Project Garage GitHub action]: add-to-project-garage.yaml
+[Add Labels Standardized GitHub Action]: add-labels-standardized.yaml
+[Add to Project Garage Dependabot GitHub Action]: add-to-project-garage-dependabot.yaml
+[Add to Project Garage GitHub Action]: add-to-project-garage.yaml
 [bandit.yaml]: bandit.yaml
 [Bandit]: https://bandit.readthedocs.io/en/latest/
 [black.yaml]: black.yaml
 [Black]: https://github.com/psf/black
-[Dependabot Approve and Merge GitHub action]: dependabot-approve-and-merge.yaml
+[Dependabot Approve and Merge GitHub Action]: dependabot-approve-and-merge.yaml
 [dependency-scan.yaml]: dependency-scan.yaml
-[Docker Build Container GitHub action]: docker-build-container.yaml
-[Docker Push Containers to DockerHub GitHub action]: docker-push-containers-to-dockerhub.yaml
-[DockerHub]: <https://hub.docker.com/>
+[Docker Build Container GitHub Action]: docker-build-container.yaml
+[Docker Push Containers to DockerHub GitHub Action]: docker-push-containers-to-dockerhub.yaml
+[DockerHub]: https://hub.docker.com/
 [Fast Python Vulnerability Scanner]: https://github.com/vanschelven/fpvs/
 [flake8.yaml]: flake8.yaml
 [flake8]: https://flake8.pycqa.org/en/latest/
 [isort.yaml]: isort.yaml
 [isort]: https://pycqa.github.io/isort/
 [isort/isort-action]: https://github.com/isort/isort-action
-[Lint Workflows GitHub action]: lint-workflows.yaml
+[Lint Workflows GitHub Action]: lint-workflows.yaml
 [lukehinds/bandit-action]: https://github.com/lukehinds/bandit-action
-[Move PR to Done Dependabot GitHub action]: move-pr-to-done-dependabot.yaml
+[Move PR to Done Dependabot GitHub Action]: move-pr-to-done-dependabot.yaml
 [move-pr-to-done-dependabot.yaml]: move-pr-to-done-dependabotyaml
 [mypy.yaml]: mypy.yaml
 [mypy]: https://mypy-lang.org/

.github/workflows/pytest-darwin.yaml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-13]
+        os: [macos-latest]
         # 3.8 and 3.9 are unsupported on the darwin runner
         python-version: ["3.10", "3.11"]
 

.gitignore

@@ -155,3 +155,5 @@ cython_debug/
 # VSCode
 .vscode/
 .history
+
+.settings

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.1.5] - 2024-10-25
+
+### Added in 0.1.5
+
+- `SzAbstractFactory.destroy()`
+- `SzAbstractFactory.reinitialize()`
+
+### Deleted in 0.1.5
+
+- `SzEngine.reinitialize()`
+- `SzDiagnostic.reinitialize()`
+
 ## [0.1.4] - 2024-10-04
 
 ### Added in 0.1.4

CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <support@senzing.com>. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@senzing.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 

CONTRIBUTING.md

@@ -16,7 +16,7 @@ There are a number of ways you can contribute:
 
 If your contribution modifies the git repository, the following agreements must be established.
 
-*Note:*  License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository.
+_Note:_ License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository.
 In simple terms, license agreements are needed before pull requests can be accepted.
 A license agreement is not needed for submitting feature request, bug reporting, or other project management.