Skip to main content

Python library and CLI tool to download Archivematica METS files

Project description

mets-retriever

About

CLI tool for bulk downloading Archivematica METS files.

Unlike Gloria the flat-coated retriever mix, mets-retriever is all about fetching.

Gloria, the flat-coated retriever mix

Usage

After installing with pip (see below), use the retrieve-mets command.

retrieve-mets has two subcommands, fetch-all and fetch-one. Both subcommands have some common arguments:

  • METS files are fetched to a directory specified with the --output-dir argument. If one is not provided, a mets_files directory will be created in the current directory and METS files will be written there.
  • Storage Service credentials must be included using the --ss-url, --ss-user-name, and --ss-api-key arguments for both commands. By default these default to values from the Archivematica Docker development environment.
  • If the --sidecar flag is passed, a sidecar txt file will be written alongside each METS file in the output directory with additional metadata about the AIP not found in the METS file, namely, the storage location UUID and the UUIDs of any AIP replicas.
Usage: retrieve-mets [OPTIONS] COMMAND [ARGS]...

  METS Retriever CLI tool

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  fetch-all  Fetch all METS files not already retrieved.
  fetch-one  Fetch single METS file, even if it's already been retrieved.

fetch-all

To fetch all AIP METS files that have not already been retreived, use the fetch-all subcommand. E.g.:

retrieve-mets fetch-all

Once a METS file is fetched, its UUID is stored in a local SQLite database so that it will not be fetched again on subsequent runs.

This command accepts several optional arguments:

Usage: retrieve-mets fetch-all [OPTIONS]

  Fetch all METS files not already retrieved.

Options:
  --ss-url TEXT         Storage Service host URL  [default:
                        http://127.0.0.1:62081; required]
  --ss-user-name TEXT   Storage Service username  [default: test;
                        required]
  --ss-api-key TEXT     Storage Service API key  [default: test; required]
  --output-dir TEXT     Path to output directory  [default: mets_files;
                        required]
  --sidecar             Write sidecar file for each METS with Storage
                        Location and AIP replica UUIDs
  --with-replicas-only  Only retrieve METS for an AIP if a replica has 
                        also been stored
  --help                Show this message and exit.

fetch-one

To fetch (or re-fetch) a single AIP METS file, use the fetch-one subcommand. E.g.:

retrieve-mets fetch-one 68ee3c66-d90a-4b9a-a33c-2e4e6d339ff7

This command accepts several optional arguments:

Usage: retrieve-mets fetch-one [OPTIONS] AIP_UUID

  Fetch single METS file, even if it's already been retrieved.

Options:
  --ss-url TEXT       Storage Service host URL  [default:
                      http://127.0.0.1:62081; required]
  --ss-user-name TEXT Storage Service username  [default: test; required]
  --ss-api-key TEXT   Storage Service API key  [default: test; required]
  --output-dir TEXT   Path to output directory  [default: mets_files;
                      required]
  --sidecar           Write sidecar file for each METS with Storage 
                      Location and AIP replica UUIDs
  --help              Show this message and exit.

Install

Install mets-retriever package

mets-retriever requires Python 3.6+.

Via PyPI

pip install mets-retriever

Manually

Download this repo:

git clone https://github.com/artefactual-labs/mets-retriever.git

Change into the cloned directory and install:

cd mets-retriever/
pip install .

Development

Installation

For development, it may be useful to install mets-retriever with pip install -e ., which will apply changes made to the source code immediately.

Testing

To run all tests with tox: tox

Or run tests directly with pytest:

pip install -r requirements/test.txt
pytest

Publishing to PyPI

This repository contains a Makefile with commands to aid in building packages and publishing to PyPI.

To check that the package is valid:

make package-check

To upload the package to PyPI (this requires PyPI credentials and being listed as a collaborator on the auditmatica project):

make package-upload

To clean up package distribution files:

make clean

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

mets-retriever-0.2.2.tar.gz (9.3 kB view hashes)

Uploaded source

Built Distribution

mets_retriever-0.2.2-py3-none-any.whl (10.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page