#367 - Modify documentation for exportJsonEntityReport and exportCsvEntityReport() (#369)

Author: antaenc

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [4.0.3] - 2025-09-11
+
+### Changed in 4.0.3
+
+- Documentation updates
+
 ## [4.0.2] - 2025-08-11
 
 ### Changed in 4.0.2

development-requirements.txt

@@ -10,7 +10,7 @@ mypy
 myst-parser
 orjson==3.11.3
 psutil==7.0.0
-pylint-per-file-ignores==1.4.0
+pylint-per-file-ignores==2.0.3
 pylint==3.3.8
 pytest-cov==7.0.0
 pytest-schema==0.1.2

pyproject.toml

@@ -1,8 +1,5 @@
 [build-system]
-requires = [
-    "setuptools>=42",
-    "wheel"
-]
+requires = ["setuptools>=42", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [dependency-groups]
@@ -39,28 +36,19 @@ module = ["grpc", "senzing_grpc", "insecure_channel"]
 follow_untyped_imports = true
 
 [tool.pylint]
-load-plugins = [
-    "pylint_per_file_ignores",
-]
+load-plugins = ["pylint_per_file_ignores"]
 disable = [
     "duplicate-code",
     "line-too-long",
     "missing-module-docstring",
     "too-many-arguments",
     "too-many-positional-arguments",
     "too-many-public-methods",
-    "wrong-import-order"
-]
-ignore = [
-    "__init__.py",
-    "docs/source/conf.py",
-]
-notes = [
-    "FIXME"
+    "wrong-import-order",
 ]
+ignore = ["__init__.py", "docs/source/conf.py"]
+notes = ["FIXME"]
 # NOTE - Ignore invalid-name only in examples for simplified code without pylint complaining variables in global scope
-#        aren't uppercase.
-# NOTE - Paths are regular expressions
-per-file-ignores = """
-    /examples/:invalid-name
-"""
+#        aren't uppercase. 
+# NOTE - Uses globs since version 2.0.0, previously was regular expressions
+per-file-ignores = ["examples/**:invalid-name"]

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = senzing
-version = 4.0.2
+version = 4.0.3
 author = senzing
 author_email = support@senzing.com
 description = Python SDK method definitions

src/senzing/szengine.py

@@ -175,7 +175,7 @@ def export_csv_entity_report(
 
         Subsequent fetch_next() calls return exported entity data in CSV format.
 
-        Use with large repositories is not advised.
+        WARNING: This method should only be used on systems containing less than a few million records. For larger systems, see https://www.senzing.com/docs/tutorials/advanced_replication/
 
         Args:
             csv_column_list (str): A comma-separated list of column names for the CSV export.
@@ -209,7 +209,7 @@ def export_json_entity_report(self, flags: int = SzEngineFlags.SZ_EXPORT_DEFAULT
 
         Each fetch_next() call returns exported entity data as a JSON object.
 
-        Use with large repositories is not advised.
+        WARNING: This method should only be used on systems containing less than a few million records. For larger systems, see https://www.senzing.com/docs/tutorials/advanced_replication/
 
         Args:
             flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.