mets-validator

Requirements

• Python 3
• lxml

Usage

python validate.py "[root directory path]"

Directory separator in [root directory path] can be either / or \. Double quotes must be used around [root directory path].

[datetime]_report.csv and [datetime]_output.log will be created at the [root directory path].

This validator assumes that each METS package has the following structure:

[name_date]/
    alto/
    images/
        pdf/
        jpg/
    [name_date]_mets.xml
    

csv report output

For each issue, include line in report.csv with the following fields:

• METS filename
• Valid METS (Yes/No)
• /mets:metsHdr/mets:agent[1]/mets:name
• /mets:metsHdr/mets:agent[2]/mets:name
• /mets:metsHdr/mets:agent[3]/mets:name
• /mods:mods/mods:titleInfo/mods:title
• /mods:mods/mods:typeOfResource
• /mods:mods/mods:genre
• /mods:mods/mods:originInfo/mods:dateIssued
• /mods:mods/mods:originInfo/mods:edition
• /mods:mods/mods:language/mods:languageTerm
• /mods:mods/mods:identifier[1]
• /mods:mods/mods:identifier[2]
• /mods:mods/mods:identifier[3]
• /mods:mods/mods:recordInfo/mods:recordContentSource
• Number of pages (based on the number of pages in the structMap section of the METS file)
• All files from METS present in package (Yes/No)
• All files in package present in METS (Yes/No)
• Each page has PDF, JPG, and Alto (Yes/No)
• Technical metadata for each JPG (Yes/No)

log ouput

Output is only created if errors are raised. For each xml file that raises an error, log output may include:

{
    mets-filename.xml: {
        "validation errors": {
            "mets": "mets-filename.xml",
            "value-ok": "",
            "value-error": "",
            "io-ok": "",
            "io-error": "",
            "well-formed": "",
            "syntax-error": "",
            "valid": "",
            "validation-error": "",
        },
        "files in mets not in package": [
            filename-array
        ],
        
        "files in package not in mets": [
            filename-array
        ],
        "missing derivatives in structMap": {
            pageID: {
                fileID: filename
            }
        },
        "missing technical metadata": {
            fileID: filename
        }
    }
}

performance testing

Requires: snakeviz (pip install snakeviz)

python -m cProfile -o out.dat validate.py "[root directory path]"
snakeviz out.dat