Skip to main content

A library for generating predictive uuids for FOLIO data migrations

Project description


A python module for creating deterministic UUIDs (UUID v5) outside of FOLIO when migrating data.


The module is uploaded to pypi. Just do

pip install folio-uuid


pipenv install folio-uuid      


The UUIDs (v5) are contstructed in the following way:

  • The namespace is the same for all "Folio UUIDs": 8405ae4d-b315-42e1-918a-d1919900cf3f
  • The name is contstructed by the following parts, delimited by a colon (:)
    • OKAPI_URL This should be the full OKAPI Url including https. Example:
    • OBJECT_TYPE_NAME This should be the name of the type of object that the ID is generated for. In plural. the file in this repo has a complete list of the ones currently in use. Example: items
    • LEGACY_IDENTIFIER This should be the legacy identifier comming from the source system. The library will perform some normalization* of the identifier if it is a Sierra/Millennium identifier. Example: i3696836

* The normalization strips away any dots (.), check digits and campus codes from the identifiers


Bash/linux example


uuidgen --sha1 -n 8405ae4d-b315-42e1-918a-d1919900cf3f -N

To install uuidgen on a apt-enabled Linux distribution, use

sudo apt-get install uuid-runtime

Python Example

def test_deterministic_uuid_generation_holdings():
    deterministic_uuid = FolioUUID(
    assert "a0b4c8a2-01fd-50fd-8158-81bd551412a0" == str(deterministic_uuid)


Wikipedia has an article on UUID version 5

There are many browser-based tools to create singe UUIDs v5. UUIDTools is one of them.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

folio_uuid-0.2.10.tar.gz (6.2 kB view hashes)

Uploaded Source

Built Distribution

folio_uuid-0.2.10-py3-none-any.whl (6.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page