folio-data-import 0.3.2__tar.gz → 0.4.1__tar.gz

{folio_data_import-0.3.2 → folio_data_import-0.4.1}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: folio_data_import
-Version: 0.3.2
-Summary: A python module to interact with the data importing capabilities of the open-source FOLIO ILS
+Version: 0.4.1
+Summary: A python module to perform bulk import of data into a FOLIO environment. Currently supports MARC and user data import.
 License: MIT
+License-File: LICENSE
 Author: Brooks Travis
 Author-email: brooks.travis@gmail.com
 Requires-Python: >=3.9,<4.0
@@ -13,6 +14,7 @@ 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
 Requires-Dist: aiofiles (>=24.1.0,<25.0.0)
 Requires-Dist: flake8-bandit (>=4.1.1,<5.0.0)
 Requires-Dist: flake8-black (>=0.3.6,<0.4.0)
@@ -24,7 +26,7 @@ Requires-Dist: inquirer (>=3.4.0,<4.0.0)
 Requires-Dist: pyhumps (>=3.8.0,<4.0.0)
 Requires-Dist: pymarc (>=5.2.2,<6.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
-Requires-Dist: tqdm (>=4.66.5,<5.0.0)
+Requires-Dist: typer (>=0.17.4,<0.18.0)
 Description-Content-Type: text/markdown
 
 # folio_data_import
@@ -42,7 +44,16 @@ This project is designed to import data into the FOLIO LSP. It provides a simple
 
 ## Installation
 
-To install the project using Poetry, follow these steps:
+Using `pip`
+```shell
+pip install folio_data_import
+```
+or `uv pip`
+```shell
+uv pip install folio_data_import
+```
+
+To install the project from the git repo using Poetry, follow these steps:
 
 1. Clone the repository.
 2. Navigate to the project directory: `$ cd /path/to/folio_data_import`.
@@ -58,8 +69,27 @@ Make sure to activate the virtual environment created by Poetry before running t
 2. Run the application and follow the prompts to import the data.
 3. Monitor the import progress and handle any errors or conflicts that may arise.
 
+### folio-data-import
+This command provides access to subcommands for importing user and marc data. To import users:
+```shell
+folio-data-import users --help
+```
+(for more information, see [folio-user-import](#folio-user-import), below)
+
+For MARC data:
+```shell
+folio-data-import marc --help
+```
+(for more information, see [folio-marc-import](#folio-marc-import), below)
+
+As an added convenience, this script can also install tab-completions for itself in your shell:
+```shell
+folio-data-import --install-completion
+```
+Once installed, you can `[tab][tab]` after typing `--` and be presented with a list of availabl command options.
+
 ### folio-user-import
-When this package is installed via PyPI or using `poetry install` from this repository, it installs a convenience script in your `$PATH` called `folio-user-import`. To view all command line options for this script, run `folio-user-import -h`. In addition to supporting `mod-user-import`-style JSON objects, this script also allows you to manage service point assignments for users by specifying a `servicePointsUser` object in the JSON object, using service point codes in place of UUIDs in the `defaultServicePointId` and `servicePointIds` fields:
+When this package is installed via PyPI or using `poetry install` from this repository, it installs a convenience script in your `$PATH` called `folio-user-import`. To view all command line options for this script, run `folio-user-import --help`. In addition to supporting `mod-user-import`-style JSON objects, this script also allows you to manage service point assignments for users by specifying a `servicePointsUser` object in the JSON object, using service point codes in place of UUIDs in the `defaultServicePointId` and `servicePointIds` fields:
 ```
 {
     "username": "checkin-all",
@@ -109,7 +139,7 @@ Unlike mod-user-import, this importer does not require `externalSystemId` as the
 
 Another point of departure from the behavior of `mod-user-import` is the handling of `preferredContactTypeId`. This importer will accept either the `"001", "002", "003"...` values stored by FOLIO, or the human-friendly strings used by `mod-user-import` (`"mail", "email", "text", "phone", "mobile"`). It will also __*set a customizable default for all users that do not otherwise have a valid value specified*__ (using `--default_preferred_contact_type`), unless a (valid) value is already present in the user record being updated.
 
-#### Field Protection (*experimental*)
+#### Per-record Field Protection (*experimental*)
 
 This script offers a rudimentary field protection implementation using custom fields. To enable this functionality, create a text custom field that has the field name `protectedFields`. In this field, you can specify a comma-separated list of User schema field names, using dot-notation for nested fields. This protection should support all standard fields except addresses within `personal.addresses`. If you include `personal.addresses` in a user record, any existing addresses will be replaced by the new values.
 
@@ -123,11 +153,32 @@ This script offers a rudimentary field protection implementation using custom fi
 
 Would result in `preferredFirstName`, `barcode`, and `telephone` remaining unchanged, regardless of the contents of the incoming records.
 
+#### Job-level field protection
+
+To protect fields for all records in a particular import job, you can pass a list of field paths with the `--fields-to-protect` flag. These protections will be applied in combination with any record-level protections specified.
+
+##### Example
+```Shell
+folio-user-import ... --fields-to-protect "personal.preferredFirstName,customFields.exampleCustomField"
+```
 
 #### How to use:
 1. Generate a JSON lines (one JSON object per line) file of FOLIO user objects in the style of [mod-user-import](https://github.com/folio-org/mod-user-import)
 2. Run the script and specify the required arguments (and any desired optional arguments), including the path to your file of user objects
+3. Watch the pretty progress bars...
+
+### folio-marc-import
+`folio-marc-import` provides direct access to the MARC import functionality of FOLIO. It can be used to import any file (or files) of binary MARC records via FOLIO's Data Import system using the [change-manager](https://github.com/folio-org/mod-source-record-manager?tab=readme-ov-file#data-import-workflow) APIs directly.
 
+#### How to use:
+1. Have a binary MARC21 file (or directory of files)
+2. Have a [Data Import Job Profile](https://docs.folio.org/docs/metadata/additional-topics/jobprofiles/) that you want to use to import your records already set up in FOLIO
+3. Run the script and specify the required arguments. (`folio-marc-import --help` for more details)
+4. Select the job profile you want to use
+5. Watch the pretty progress bars...
+
+#### A note on logging
+The import logs and job summaries provided by FOLIO can be unreliable in certain circumstances. The scripts have been written to balance the need to retrieve job summary information at the end of each job with the the need to move on to the next import job. If you don't see a job summary when your job completes, check Data Import in FOLIO (Data Import > Actions > View all logs...)
 
 ## Contributing
 

{folio_data_import-0.3.2 → folio_data_import-0.4.1}/README.md

@@ -13,7 +13,16 @@ This project is designed to import data into the FOLIO LSP. It provides a simple
 
 ## Installation
 
-To install the project using Poetry, follow these steps:
+Using `pip`
+```shell
+pip install folio_data_import
+```
+or `uv pip`
+```shell
+uv pip install folio_data_import
+```
+
+To install the project from the git repo using Poetry, follow these steps:
 
 1. Clone the repository.
 2. Navigate to the project directory: `$ cd /path/to/folio_data_import`.
@@ -29,8 +38,27 @@ Make sure to activate the virtual environment created by Poetry before running t
 2. Run the application and follow the prompts to import the data.
 3. Monitor the import progress and handle any errors or conflicts that may arise.
 
+### folio-data-import
+This command provides access to subcommands for importing user and marc data. To import users:
+```shell
+folio-data-import users --help
+```
+(for more information, see [folio-user-import](#folio-user-import), below)
+
+For MARC data:
+```shell
+folio-data-import marc --help
+```
+(for more information, see [folio-marc-import](#folio-marc-import), below)
+
+As an added convenience, this script can also install tab-completions for itself in your shell:
+```shell
+folio-data-import --install-completion
+```
+Once installed, you can `[tab][tab]` after typing `--` and be presented with a list of availabl command options.
+
 ### folio-user-import
-When this package is installed via PyPI or using `poetry install` from this repository, it installs a convenience script in your `$PATH` called `folio-user-import`. To view all command line options for this script, run `folio-user-import -h`. In addition to supporting `mod-user-import`-style JSON objects, this script also allows you to manage service point assignments for users by specifying a `servicePointsUser` object in the JSON object, using service point codes in place of UUIDs in the `defaultServicePointId` and `servicePointIds` fields:
+When this package is installed via PyPI or using `poetry install` from this repository, it installs a convenience script in your `$PATH` called `folio-user-import`. To view all command line options for this script, run `folio-user-import --help`. In addition to supporting `mod-user-import`-style JSON objects, this script also allows you to manage service point assignments for users by specifying a `servicePointsUser` object in the JSON object, using service point codes in place of UUIDs in the `defaultServicePointId` and `servicePointIds` fields:
 ```
 {
     "username": "checkin-all",
@@ -80,7 +108,7 @@ Unlike mod-user-import, this importer does not require `externalSystemId` as the
 
 Another point of departure from the behavior of `mod-user-import` is the handling of `preferredContactTypeId`. This importer will accept either the `"001", "002", "003"...` values stored by FOLIO, or the human-friendly strings used by `mod-user-import` (`"mail", "email", "text", "phone", "mobile"`). It will also __*set a customizable default for all users that do not otherwise have a valid value specified*__ (using `--default_preferred_contact_type`), unless a (valid) value is already present in the user record being updated.
 
-#### Field Protection (*experimental*)
+#### Per-record Field Protection (*experimental*)
 
 This script offers a rudimentary field protection implementation using custom fields. To enable this functionality, create a text custom field that has the field name `protectedFields`. In this field, you can specify a comma-separated list of User schema field names, using dot-notation for nested fields. This protection should support all standard fields except addresses within `personal.addresses`. If you include `personal.addresses` in a user record, any existing addresses will be replaced by the new values.
 
@@ -94,11 +122,32 @@ This script offers a rudimentary field protection implementation using custom fi
 
 Would result in `preferredFirstName`, `barcode`, and `telephone` remaining unchanged, regardless of the contents of the incoming records.
 
+#### Job-level field protection
+
+To protect fields for all records in a particular import job, you can pass a list of field paths with the `--fields-to-protect` flag. These protections will be applied in combination with any record-level protections specified.
+
+##### Example
+```Shell
+folio-user-import ... --fields-to-protect "personal.preferredFirstName,customFields.exampleCustomField"
+```
 
 #### How to use:
 1. Generate a JSON lines (one JSON object per line) file of FOLIO user objects in the style of [mod-user-import](https://github.com/folio-org/mod-user-import)
 2. Run the script and specify the required arguments (and any desired optional arguments), including the path to your file of user objects
+3. Watch the pretty progress bars...
+
+### folio-marc-import
+`folio-marc-import` provides direct access to the MARC import functionality of FOLIO. It can be used to import any file (or files) of binary MARC records via FOLIO's Data Import system using the [change-manager](https://github.com/folio-org/mod-source-record-manager?tab=readme-ov-file#data-import-workflow) APIs directly.
 
+#### How to use:
+1. Have a binary MARC21 file (or directory of files)
+2. Have a [Data Import Job Profile](https://docs.folio.org/docs/metadata/additional-topics/jobprofiles/) that you want to use to import your records already set up in FOLIO
+3. Run the script and specify the required arguments. (`folio-marc-import --help` for more details)
+4. Select the job profile you want to use
+5. Watch the pretty progress bars...
+
+#### A note on logging
+The import logs and job summaries provided by FOLIO can be unreliable in certain circumstances. The scripts have been written to balance the need to retrieve job summary information at the end of each job with the the need to move on to the next import job. If you don't see a job summary when your job completes, check Data Import in FOLIO (Data Import > Actions > View all logs...)
 
 ## Contributing
 

{folio_data_import-0.3.2 → folio_data_import-0.4.1}/pyproject.toml

@@ -1,16 +1,16 @@
 [tool.poetry]
 name = "folio_data_import"
-version = "0.3.2"
-description = "A python module to interact with the data importing capabilities of the open-source FOLIO ILS"
+version = "0.4.1"
+description = "A python module to perform bulk import of data into a FOLIO environment. Currently supports MARC and user data import."
 authors = ["Brooks Travis <brooks.travis@gmail.com>"]
 license = "MIT"
 readme = "README.md"
-packages = [{include = "folio_data_import", from="src"}]
+packages = [{ include = "folio_data_import", from = "src" }]
 
 [tool.poetry.scripts]
-folio-data-import = "folio_data_import.__main__:sync_main"
-folio-marc-import = "folio_data_import.MARCDataImport:sync_main"
-folio-user-import = "folio_data_import.UserImport:sync_main"
+folio-data-import = "folio_data_import.__main__:app"
+folio-marc-import = "folio_data_import.MARCDataImport:app"
+folio-user-import = "folio_data_import.UserImport:app"
 
 [tool.poetry.dependencies]
 python = "^3.9"
@@ -18,7 +18,6 @@ folioclient = "^0.70.1"
 pymarc = "^5.2.2"
 pyhumps = "^3.8.0"
 inquirer = "^3.4.0"
-tqdm = "^4.66.5"
 tabulate = "^0.9.0"
 aiofiles = "^24.1.0"
 flake8-black = "^0.3.6"
@@ -26,7 +25,7 @@ flake8-bugbear = "^24.8.19"
 flake8-bandit = "^4.1.1"
 flake8-isort = "^6.1.1"
 flake8-docstrings = "^1.7.0"
-
+typer = "^0.17.4"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.2"