folio-migration-tools 1.7.0rc12

A tool allowing you to migrate data from legacy ILS:s (Library systems) into FOLIO LSP

FOLIO Migration Tools

A toolkit that enables you to migrate data over from a legacy ILS system into FOLIO LSP

What is it good for?

FOLIO Migration tools enables you to migrate libraries with the most common ILS:s over to FOLIO without data losses or any major data transformation tasks. The tools transforms and loads the data providing you and the library with good actionable logs and data cleaning task lists together with the migrated data.

What data does it cover?

FOLIO Migration Tools currently covers the following data sets:

• Catalog (Inventory and SRS in FOLIO terminology)
• Circulation transactions (Open loans and requests)
• Users/Patrons (In FOLIO, these share the same app/database)
• Courses and Reserves (Course reserves)

What additional functionality is on the roadmap?

This is the loose roadmap, in order of most likely implementations first

• Organizations (Vendor records)
• Orders
• ERM-related objects
• Financial records

Can I use the tools for ongoing imports and integrations?

The tools are primarliy maintained for performing initial data migrations. We recommend that you use native FOLIO functionality for ongoing loads where possible. In theory, these tools can be used for ongoing patron loads from systems like Banner, Workday, or PeopleSoft. But we recommend you to weigh your options carefully before going down this path.

Contributing

Want to contribute? Read the CONTRIBUTING.MD

Found an issue?

Report it on the Github Issue tracker

The scripts requires a FOLIO tenant with reference data properly set up. The script will throw messages telling what reference data is missing.

Installing

Make sure you are running Python 3.9 or above.

1. Using pip and venv

2.1. Create and activate a virtual environment

python -m venv ./.venv     # Creates a virtual env in the current folder
source .venv/bin/activate  # Activates the venv    

2. Install using pip:

python -m pip install folio_migration_tools

3. Test the installation by showing the help pages

python -m folio_migration_tools -h

2. Using pipenv

1. Run

pipenv install folio-migration-tools

2. Test the installation by showing the help pages

pipenv run python3 -m folio_migration_tools -h

FOLIO migration process

This repo plays the main part in a process using a collection of tools. The process itself is documented in more detail, including example configuration files, at this template repository In order to perform migrations according to this process, you need the following:

• An Installation of FOLIO Migration Tools. Installation instructions above.
• A clone, or a separate repo created from migration_repo_template
• Access to the Data mapping file creator web tool
• A FOLIO tenant running the latest or the second latest version of FOLIO

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. We are building out the docs section in this repository as well: Documentation ¨

Tests

There is a test suite for Bibs-to-Instance mapping. You need to add arguments in order to run it against a FOLIO environment. The tests are run against the latest FOLIO Bugfest environment as part of the commit process in this repo.

IMPORTANT! the tests and the tools relies on many calls to GitHub, and you need to create a GitHub personal Access token and add a .env file in the root of the folder with the following contents:
GITHUB_TOKEN=ghp_.....
Then, either restart your shell or run
source .env
from the command line

Running the tests for the Rules mapper

Pipenv

• Install the packages in the Pipfile
• Run clear; pipenv run pytest -v --log-level=DEBUG --password PASSWORD --tenant_id TENANT_ID --okapi_url OKAPI URL --username USERNAME

Poetry

• Install the packages from the pyproject.toml
• Run clear; poetry run pytest -v --log-level=DEBUG --password folio --tenant_id fs09000000 --okapi_url https://okapi-bugfest-lotus.int.aws.folio.org --username folio --cov