CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The changelog format is based on Keep a Changelog and CommonMark. This project adheres to Semantic Versioning.

[Unreleased]

Changed in Unreleased

[4.1.1] - 2026-04-14

Added in 4.1.1

• Updated szerror.py and szengineflags.py

[4.1.0] - 2025-12-22

Added in 4.1.0

• Support for Python 3.13

Removed in 4.1.0

• Support for Python 3.9

[4.0.4] - 2025-10-02

Changed in 4.0.4

• Documentation updates

[4.0.3] - 2025-09-11

Changed in 4.0.3

• Documentation updates

[4.0.2] - 2025-08-11

Changed in 4.0.2

• Documentation updates
• Removed typing-extensions dependency

[4.0.1] - 2025-08-07

Added in 4.0.1

• Additional errors in szerror.py

[4.0.0] - 2025-08-05

Changed in 4.0.0

• For use with Senzing v4

[0.2.20] - 2025-07-19

Changed in 0.2.20

• szerror.py updated

[0.2.19] - 2025-07-16

Added in 0.2.19

• Added SzAbstractFactory.Destroy()

[0.2.18] - 2025-07-14

Added in 0.2.18

• SZ_REDO_DEFAULT_FLAGS

[0.2.17] - 2025-07-08

Changed in 0.2.17

• Change SzConfig.add_data_source to SzConfig.register_data_source
• Change SzConfig.delete_data_source to SzConfig.unregister_data_source
• Change SzConfig.get_data_sources to SzConfig.get_data_source_registry
• Change SzDiagnostic.check_datastore_performance to SzDiagnostic.check_repository_performance
• Change SzDiagnostic.get_datastore_info to SzDiagnostic.get_repository_info
• Change SzEngine.close_export to SzEngine.close_export_report
• Change SzEngine.preprocess_record to ``SzEngine.get_record_preview`

[0.2.16] - 2025-06-18

Changed in 0.2.16

• szconfigmanager.get_configs changed to szconfigmanager.get_config_registry

Fixed in 0.2.16

• Example output for preprocess_record updated

[0.2.15] - 2025-06-12

Fixed in 0.2.15

• Example for preprocess_record had incorrect flag

[0.2.14] - 2025-06-12

Added in 0.2.14

• New flags in szengineflags.py

Changed in 0.2.14

• Use new flags as flag defaults in method signatures instead of an integer in szengine.py

Removed in 0.2.14

• SZ_NO_FLAGS from constants.py, now in szengineflags.py

[0.2.13] - 2025-05-21

Added in 0.2.13

• New tests for szconfig

Changed in 0.2.13

• Examples cleanup

[0.2.12] - 2025-05-08

Changed in 0.2.12

• SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS back to SZ_ENTITY_INCLUDE_RECORD_FEATURES

Removed in 0.2.12

• flags_by_name class method in szengineflags
• flags_by_value class method in szengineflags
• Associated tests and examples for the above

[0.2.11] - 2025-05-05

Changed in 0.2.11

• Fixed incorrect flag defaults in szengine.py
• Fixed incorrect flag defaults in szengine.py in doc strings
• Spelling corrections

[0.2.10] - 2025-04-30

Changed in 0.2.10

• Added SZ_WHY_SEARCH_DEFAULT_FLAGS to szengineflags.py
• Changed default why_search() flag to SZ_WHY_SEARCH_DEFAULT_FLAGS

[0.2.9] - 2025-04-24

Changed in 0.2.9

• Update szerror.py

[0.2.8] - 2025-04-21

Changed in 0.2.8

• Simplify and clean up examples

[0.2.7] - 2025-04-18

Changed in 0.2.7

• Case on example variables

Removed in 0.2.7

• Documentation on early adaptor methods
• Empty example files for early adaptor methods

[0.2.6] - 2025-04-16

Added in 0.2.6

• SzEngine.why_search

[0.2.5] - 2025-03-11

Changed in 0.2.5

• Restructured SzConfigManager and SzConfig

[0.2.4] - 2025-02-14

Changed in 0.2.4

• Updated documentation

[0.2.3] - 2025-02-10

Fixed in 0.2.3

• Added SzDatabaseTransientError & SzSdkError to __init__.py for importing

[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

• Added typing-extensions dependency for Python versions < 3.11

[0.2.0] - 2024-12-04

Changed in 0.2.0

• Changed repository from sz-sdk-python-abstract to sz-sdk-python

[0.1.12] - 2024-11-27

Removed in 0.1.12

• Removed kwargs from all method definitions

Fixed in 0.1.12

• Typo and spelling errors

Added in 0.1.12

• Additional docstring documentation where missing

[0.1.11] - 2024-11-26

Changed in 0.1.11

• In SzAbstractFactory, changed create_sz_* to create_*

[0.1.10] - 2024-11-01

Changed in 0.1.10

• Synchronized szengineflags with latest V4 stage build

[0.1.9] - 2024-10-31

Changed in 0.1.9

• Modified signatures for process_redo_record to include default flag

[0.1.8] - 2024-10-29

Changed in 0.1.8

• Modified signatures for preprocess_record to include default flag
• Removed exception_map and moved into szerror.py

[0.1.7] - 2024-10-28

Changed in 0.1.7

• Modified signatures for find_network_by_entity_id and find_network_by_record_id

[0.1.6] - 2024-10-28

Removed in 0.1.6

• SzAbstractFactory.destroy()

[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

• sz_engine.preprocess_record()
• Engine flags:
  • SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS
  • SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS
  • SZ_ENTITY_INCLUDE_RECORD_FEATURES

Deleted in 0.1.4

• Engine flags:
  • SZ_ENTITY_INCLUDE_FEATURE_ELEMENTS
  • SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS

[0.1.3] - 2024-09-25

Added in 0.1.3

• Added help() method

[0.1.2] - 2024-09-24

Changed in 0.1.2

• Added abstract_factory

[0.1.1] - 2024-07-30

Changed in 0.1.1

• Update to current sz-sdk-python
• Update to current template-python

[0.1.0] - 2024-05-06

Changed in 0.1.0

• Migrated from "g2" to "sz"

[0.0.4] - 2023-12-21

Changed in 0.0.4

• Add help()

[0.0.3] - 2023-12-18

Changed in 0.0.3

• Add truthset

[0.0.2] - 2023-12-15

Changed in 0.0.2

• Improving GitHub actions

[0.0.1] - 2023-12-15

Added to 0.0.1

• Initial work