Skip to content

Tool for automated processing of directories in BitCurator

License

Notifications You must be signed in to change notification settings

CCA-Public/folderprocessor

Repository files navigation

Folder Processor

Tool for automated processing of directories in BitCurator.

Version: 1.1.0

CCA Folder Processor creates Archivematica-ready SIPs from directories on a local filesystem, piece of external media, or network shares, and generates a pre-populated description spreadsheet containing information such as start and end dates, extents, and a scope and content note for each created SIP.

The GUI offers a checkbox interface to select which directories should be turned into SIPs.

CCA Folder Processor creates an md5deep-generated checksum.md5 manifest saved in each SIP's metadata directory (according to Archivematica packaging ventions) as default behavior. To create each SIP as a bag instead, select that option from the GUI interface. Folder Processor can optionally also run a PII scan of each SIP using bulk_extractor as part of the Brunnhilde characterization step of SIP creation and description. Bulk_extractor results are saved to metadata/submissionDocumentation, in the Brunnhilde report output folder.

Installation

This utility is designed for easy use in BitCurator 4. It requires Python 3.7+ and PyQt5.

Install as part of CCA Tools

Install all of the CCA Tools together using the installation script in the CCA Tools repo.

Install as a separate utlity

  • Install PyQt5:
    sudo pip3 install pyqt5
  • Clone this repo to your local machine.
  • Run the install script with sudo privileges:
    sudo ./install.sh