folio-migration-tools 1.9.10__tar.gz → 1.10.0__tar.gz

{folio_migration_tools-1.9.10 → folio_migration_tools-1.10.0}/PKG-INFO

@@ -1,33 +1,25 @@
 Metadata-Version: 2.4
-Name: folio_migration_tools
-Version: 1.9.10
+Name: folio-migration-tools
+Version: 1.10.0
 Summary: A tool allowing you to migrate data from legacy ILS:s (Library systems) into FOLIO LSP
-License-Expression: MIT
-License-File: LICENSE
 Keywords: FOLIO,ILS,LSP,Library Systems,MARC21,Library data
-Author: Theodor Tolstoy
-Author-email: github.teddes@tolstoy.se
-Requires-Python: >=3.10,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Provides-Extra: docs
-Requires-Dist: argparse-prompt (>=0.0.5,<0.0.6)
-Requires-Dist: art (>=6.5,<7.0)
-Requires-Dist: deepdiff (>=6.2.3,<7.0.0)
-Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
-Requires-Dist: folio-data-import (>=0.4.1)
-Requires-Dist: folio-uuid (>=1.0.0,<2.0.0)
-Requires-Dist: folioclient (>=0.70.1,<0.71.0)
-Requires-Dist: pyaml (>=21.10.1,<22.0.0)
-Requires-Dist: pydantic (>=1.10.2,<2.0.0)
-Requires-Dist: pyhumps (>=3.7.3,<4.0.0)
-Requires-Dist: pymarc (>=5.2.3,<6.0.0)
-Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
-Requires-Dist: python-i18n (>=0.3.9,<0.4.0)
+Author: Theodor Tolstoy, Lisa Sjögren, Brooks Travis, Jeremy Nelson, Clinton Bradford
+Author-email: Theodor Tolstoy <github.teddes@tolstoy.se>, Brooks Travis <brooks.travis@gmail.com>
+License-Expression: MIT
+Requires-Dist: folioclient>=1.0.4
+Requires-Dist: pyhumps>=3.7.3,<4.0.0
+Requires-Dist: defusedxml>=0.7.1,<1.0.0
+Requires-Dist: python-dateutil>=2.8.2,<3.0.0
+Requires-Dist: folio-uuid>=1.0.0,<2.0.0
+Requires-Dist: pymarc>=5.2.3,<6.0.0
+Requires-Dist: pydantic>=2.12.3,<3.0.0
+Requires-Dist: argparse-prompt>=0.0.5,<1.0.0
+Requires-Dist: deepdiff>=6.2.3,<7.0.0
+Requires-Dist: pyaml>=21.10.1,<22.0.0
+Requires-Dist: python-i18n>=0.3.9,<1.0.0
+Requires-Dist: art>=6.5,<7.0
+Requires-Dist: folio-data-import>=0.5.0,<0.6.0
+Requires-Python: >=3.10, <4.0
 Project-URL: Documentation, https://folio-migration-tools.readthedocs.io/en/latest/
 Project-URL: Homepage, https://github.com/folio-fse/folio_migration_tools
 Project-URL: Repository, https://github.com/FOLIO-FSE/folio_migration_tools
@@ -166,4 +158,3 @@ Translate all new strings, which begin with `TRANSLATE`, then commit.
 # Running the scripts
 For information on syntax, what files are needed and produced by the toolkit, refer to the documentation and example files in the [template repository](https://github.com/FOLIO-FSE/migration_repo_template). We are building out the docs section in this repository as well:[Documentation](https://folio-migration-tools.readthedocs.io/en/latest/)
 ¨
-

folio_migration_tools-1.10.0/pyproject.toml

@@ -0,0 +1,146 @@
+[project]
+name = "folio_migration_tools"
+version = "1.10.0"
+description =  "A tool allowing you to migrate data from legacy ILS:s (Library systems) into FOLIO LSP"
+authors = [
+	{name = "Theodor Tolstoy", email = "github.teddes@tolstoy.se"},
+	{name = "Lisa Sjögren"},
+	{name = "Brooks Travis", email = "brooks.travis@gmail.com"},
+	{name = "Jeremy Nelson"},
+	{name = "Clinton Bradford"}
+]
+license = "MIT"
+readme = "README.md"
+keywords = ["FOLIO", "ILS", "LSP", "Library Systems", "MARC21", "Library data"]
+requires-python = ">=3.10,<4.0"
+dependencies = [
+    "folioclient>=1.0.4",
+    "pyhumps>=3.7.3,<4.0.0",
+    "defusedxml>=0.7.1,<1.0.0",
+    "python-dateutil>=2.8.2,<3.0.0",
+    "folio-uuid>=1.0.0,<2.0.0",
+    "pymarc>=5.2.3,<6.0.0",
+    "pydantic>=2.12.3,<3.0.0",
+    "argparse-prompt>=0.0.5,<1.0.0",
+    "deepdiff>=6.2.3,<7.0.0",
+    "pyaml>=21.10.1,<22.0.0",
+    "python-i18n>=0.3.9,<1.0.0",
+    "art>=6.5,<7.0",
+    "folio-data-import>=0.5.0,<0.6.0",
+]
+
+[dependency-groups]
+dev = [
+	"pytest>=7.1.3,<8.0.0",
+	"coverage[toml]>=6.5.0,<7.0.0",
+	"pytest-cov>=4.0.0,<5.0.0",
+	"black>=22.10.0,<23.0.0",
+	"flake8>=7.3.0,<8.0.0",
+	"mypy>=0.982,<1.0.0",
+	"flake8-black>=0.3.6,<1.0.0",
+	"flake8-bugbear>=24.12.12,<25.0.0",
+	"flake8-bandit>=4.1.1,<5.0.0",
+	"flake8-isort>=6.1.2,<7.0.0",
+	"flake8-docstrings>=1.6.0,<2.0.0",
+	"darglint>=1.8.1,<2.0.0",
+	"types-requests>=2.28.11.17,<3.0.0",
+	"types-python-dateutil>=2.8.19.11,<3.0.0",
+	"ipykernel>=6.29.5,<7.0.0",
+	"pytest-asyncio>=0.23.0,<0.24.0",
+	"lxml>=6.0.2",
+	"pyrefly>=0.43.1",
+	"ruff>=0.14.13",
+]
+docs = [
+	"m2r>=0.2.1,<0.3.0",
+	"myst-parser>=0.18.1,<4.0.0",
+	"sphinx>=6.0.0,<7.0.0",
+	"sphinx-autodoc-typehints>=1.17.0,<2.0.0",
+	"sphinx-rtd-theme>=1.0.0,<2.0.0",
+	"toml>=0.10.2,<0.11.0",
+	"sphinx-book-theme>=1.1.4,<2.0.0",
+	"sphinx-autobuild>=2024.10.3,<2025.0.0"
+]
+[project.urls]
+Documentation = "https://folio-migration-tools.readthedocs.io/en/latest/"
+Homepage = "https://github.com/folio-fse/folio_migration_tools"
+Repository = "https://github.com/FOLIO-FSE/folio_migration_tools"
+
+[project.scripts]
+folio-migration-tools = "folio_migration_tools.__main__:main"
+
+[tool.coverage.report]
+show_missing = false
+fail_under = 10
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+
+[tool.coverage.run]
+branch = true
+source = ["folio_migration_tools"]
+
+[build-system]
+requires = ["uv_build>=0.8.6,<0.9.0"]
+build-backend = "uv_build"
+
+# Linting
+[tool.ruff]
+line-length = 99
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "build",
+    "dist",
+    "site-packages",
+    "venv",
+    "**/tests/*.py",
+    "integration_test.py"
+]
+
+indent-width = 4
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["B", "B9", "C", "E", "F", "S", "W"]
+ignore = ["E741", "S113"]
+
+fixable = ["ALL"]
+unfixable = []
+
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402", "F401"]
+"**/{tests,docs,tools}/*" = ["E402"]
+"**/test_*.py" = ["S101"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+docstring-code-format = false
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15

{folio_migration_tools-1.9.10 → folio_migration_tools-1.10.0}/src/folio_migration_tools/__init__.py

@@ -3,9 +3,8 @@ from typing import Protocol
 
 __version__ = importlib.metadata.version("folio_migration_tools")
 
+
 class StrCoercible(Protocol):
-    def __repr__(self) -> str:
-        ...
+    def __repr__(self) -> str: ...
 
-    def __str__(self) -> str:
-        ...
+    def __str__(self) -> str: ...

{folio_migration_tools-1.9.10 → folio_migration_tools-1.10.0}/src/folio_migration_tools/__main__.py

@@ -4,6 +4,7 @@ import logging
 import sys
 from os import environ
 from pathlib import Path
+from warnings import warn
 
 import httpx
 import humps
@@ -33,23 +34,25 @@ def parse_args(args):
 
     parser.add_argument(
         "task_name",
-        help=("Task name. Use one of: " f"{tasks_string}"),
+        help=(f"Task name. Use one of: {tasks_string}"),
         nargs="?" if "FOLIO_MIGRATION_TOOLS_TASK_NAME" in environ else None,
         prompt="FOLIO_MIGRATION_TOOLS_TASK_NAME" not in environ,
         default=environ.get("FOLIO_MIGRATION_TOOLS_TASK_NAME"),
     )
     parser.add_argument(
-        "--folio_password", "--okapi_password",
+        "--folio_password",
+        "--okapi_password",
         help="password for the tenant in the configuration file",
         prompt="FOLIO_MIGRATION_TOOLS_OKAPI_PASSWORD" not in environ,
-        default=environ.get("FOLIO_MIGRATION_TOOLS_OKAPI_PASSWORD"),
+        default=environ.get(
+            "FOLIO_MIGRATION_TOOLS_FOLIO_PASSWORD",
+            environ.get("FOLIO_MIGRATION_TOOLS_OKAPI_PASSWORD"),
+        ),
         secure=True,
     )
     parser.add_argument(
         "--base_folder_path",
-        help=(
-            "path to the base folder for this library. Built on migration_repo_template"
-        ),
+        help=("path to the base folder for this library. Built on migration_repo_template"),
         prompt="FOLIO_MIGRATION_TOOLS_BASE_FOLDER_PATH" not in environ,
         default=environ.get("FOLIO_MIGRATION_TOOLS_BASE_FOLDER_PATH"),
     )
@@ -62,34 +65,43 @@ def parse_args(args):
         prompt=False,
     )
     parser.add_argument(
-        "--version", "-V",
+        "--version",
+        "-V",
         help="Show the version of the FOLIO Migration Tools",
         action="store_true",
         prompt=False,
     )
     return parser.parse_args(args)
 
+
 def prep_library_config(args):
-        config_file_humped = merge_load(args.configuration_path)
-        config_file_humped["libraryInformation"]["okapiPassword"] = args.folio_password
-        config_file_humped["libraryInformation"]["baseFolder"] = args.base_folder_path
-        config_file = humps.decamelize(config_file_humped)
-        library_config = LibraryConfiguration(**config_file["library_information"])
-        if library_config.ecs_tenant_id:
-            library_config.is_ecs = True
-        if library_config.ecs_tenant_id and not library_config.ecs_central_iteration_identifier:
-            print(
-                "ECS tenant ID is set, but no central iteration identifier is provided. "
-                "Please provide the central iteration identifier in the configuration file."
-            )
-            sys.exit("ECS Central Iteration Identifier Not Found")
-        return config_file, library_config
+    config_file_humped = merge_load(args.configuration_path)
 
-def print_version(args):
-    if "-V" in args or "--version" in args:
+    # Only set folioPassword if neither folioPassword nor okapiPassword exist in config
+    # The Pydantic validator will handle backward compatibility for existing okapiPassword
+    if (
+        "folioPassword" not in config_file_humped["libraryInformation"]
+        and "okapiPassword" not in config_file_humped["libraryInformation"]
+    ):
+        config_file_humped["libraryInformation"]["folioPassword"] = args.folio_password
+
+    config_file_humped["libraryInformation"]["baseFolder"] = args.base_folder_path
+    config_file = humps.decamelize(config_file_humped)
+    library_config = LibraryConfiguration(**config_file["library_information"])
+    if library_config.ecs_tenant_id:
+        library_config.is_ecs = True
+    if library_config.ecs_tenant_id and not library_config.ecs_central_iteration_identifier:
         print(
-            f"FOLIO Migration Tools: {metadata.version('folio_migration_tools')}"
+            "ECS tenant ID is set, but no central iteration identifier is provided. "
+            "Please provide the central iteration identifier in the configuration file."
         )
+        sys.exit("ECS Central Iteration Identifier Not Found")
+    return config_file, library_config
+
+
+def print_version(args):
+    if "-V" in args or "--version" in args:
+        print(f"FOLIO Migration Tools: {metadata.version('folio_migration_tools')}")
         sys.exit(0)
     return None
 
@@ -115,6 +127,14 @@ def main():
         i18n.set("locale", args.report_language)
         config_file, library_config = prep_library_config(args)
         try:
+            if args.task_name == "AuthorityTransformer":
+                warn(
+                    "The AuthorityTransformer has been removed."
+                    " Please update your configuration accordingly."
+                    " Use Data Import to load authority records.",
+                    DeprecationWarning,
+                    stacklevel=2,
+                )
             migration_task_config = next(
                 t for t in config_file["migration_tasks"] if t["name"] == args.task_name
             )
@@ -122,7 +142,7 @@ def main():
             task_names = [t.get("name", "") for t in config_file["migration_tasks"]]
             print(
                 f"Referenced task name {args.task_name} not found in the "
-                f'configuration file. Use one of {", ".join(task_names)}'
+                f"configuration file. Use one of {', '.join(task_names)}"
                 "\nHalting..."
             )
             sys.exit("Task Name Not Found")
@@ -134,13 +154,15 @@ def main():
             )
         except StopIteration:
             print(
-                f'Referenced task {migration_task_config["migration_task_type"]} '
+                f"Referenced task {migration_task_config['migration_task_type']} "
                 "is not a valid option. Update your task to incorporate "
                 f"one of {json.dumps([tc.__name__ for tc in task_classes], indent=4)}"
             )
             sys.exit("Task Type Not Found")
         try:
-            logging.getLogger("httpx").setLevel(logging.WARNING) # Exclude info messages from httpx
+            logging.getLogger("httpx").setLevel(
+                logging.WARNING
+            )  # Exclude info messages from httpx
             with FolioClient(
                 library_config.gateway_url,
                 library_config.tenant_id,
@@ -161,16 +183,15 @@ def main():
         logging.critical(json_error)
         print(json_error.doc)
         print(
-            f"\n{json_error}"
-            f"\nError parsing the above JSON mapping or configruation file. Halting."
+            f"\n{json_error}\nError parsing the above JSON mapping or configruation file. Halting."
         )
         sys.exit("Invalid JSON")
     except ValidationError as e:
-        print(e.json())
+        print(json.dumps(e.errors(), indent=2))
         print("Validation errors in configuration file:")
         print("==========================================")
 
-        for validation_message in json.loads(e.json()):
+        for validation_message in e.errors():
             print(
                 f"{validation_message['msg']}\t"
                 f"{', '.join(humps.camelize(str(x)) for x in validation_message['loc'])}"
@@ -199,6 +220,7 @@ def main():
         sys.exit(ee.__class__.__name__)
     sys.exit(0)
 
+
 def inheritors(base_class):
     subclasses = set()
     work = [base_class]