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)
- Organizations (Vendor records)
- Orders (limited support)
What additional functionality is on the roadmap?
This is the loose roadmap, in order of most likely implementations first
- 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.10 or above.
1. Using uv
2.1. Create and activate a virtual environment
uv venv # Creates a virtual env in the current folder
source .venv/bin/activate # Activates the venv
2. Install using pip:
uv pip install folio-migration-tools
3. Test the installation by showing the help pages
uv run 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
- A FOLIO tenant running the latest or the second latest version of FOLIO
Internationalization
This repo uses Python-i18n to translate reports between languages, and to handle large strings for templates.
Any English string which will end up in a report should be wrapped in the function i18n.t from i18n:
Keys/Usage
i18n.t("Reports")+":"
Templating is achieved with %{[key]} blocks, and keyword arguments in the internationaliation:
i18n.t("Code '%{code}' not found in FOLIO",code=folio_code)
Long strings can use a placeholder key:
i18n.t("blurbs.Introduction.description")
With the full string in translations/en.json:
"blurbs.Introduction.description": "<br/>Data errors preventing records from being migrated
Translations Files
Translation files live in the translations directory, with en.json as the default.
Extract template files with the extract_translations script:
python scripts/extract_translations.py
Internationalizations
Other langauges translations live in translations/[locale].json.
For example, Spanish would be es.json.
The keys must match the English keys, but the Values should be translated.
You can update a language file's keys with:
python scripts/update_language.py --target-lang [locale]
Translate all new strings, which begin with TRANSLATE, then commit.
Tips
- Internationalize entire phrases or paragraphs, not just the constitutent words. Syntax and grammar vary significantly between languages.
- Name template variables as generically as possible in the circumstance, and check translations for reusable translations.
- In a block with sentences separately followed by values, such as a table, you only need to translate the sentences.
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 ¨
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file folio_migration_tools-1.12.2.tar.gz.
File metadata
- Download URL: folio_migration_tools-1.12.2.tar.gz
- Upload date:
- Size: 234.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f733942d1f337cf9ca1a00b827b8aa1c0a833f7fa731b161e42e898bc0bc8498
|
|
| MD5 |
dbfd0b00e6cee58bc7911f5f4412082f
|
|
| BLAKE2b-256 |
f8a1568954b17ee9711b0392d64d0078faf5e685d7294174a3ceb88d3ca3a969
|
File details
Details for the file folio_migration_tools-1.12.2-py3-none-any.whl.
File metadata
- Download URL: folio_migration_tools-1.12.2-py3-none-any.whl
- Upload date:
- Size: 278.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4843899ae674ba0f8a47bb9ae21085d32e5fdad2b8a0c2d8dd84ecd34dcacf29
|
|
| MD5 |
b38dc72a011a06126a29d5a7f47a9976
|
|
| BLAKE2b-256 |
f9f46e61d4b3659cb84bd6e9f26eb1673aba06bbe36348d58696ceb0103bd3cc
|
