Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 1.21 KB

README.md

File metadata and controls

58 lines (37 loc) · 1.21 KB
Raw

oai-pmh-harvester

Scripts for harvesting from repositories using OAI-PMH

Harvesting

Do this before proceeding to other commands:

  • pipenv install
  • pipenv shell
  • pipenv install --editable .

To perform a harvest with all default settings:

  • harvest

To see configuration options:

  • harvest --help

Development

Clone the repo and install the dependencies using Pipenv:

git git@github.com:MITLibraries/oai-pmh-harvester.git
cd oai-pmh-harvester
pipenv install --dev

Docker

To build and run in docker:

docker build -t harvester .
docker run -it harvester

To run this locally in Docker while maintaining the ability to see the output file, you can do something like:

docker run -it -v '/FULL/PATH/TO/WHERE/YOU/WANT/FILES/tmp:/app/tmp' harvester --host https://aspace-staff-dev.mit.edu/oai --from_date 2019-09-10 --verbose --out tmp/out.xml --format oai_ead

S3 Output

You can save to s3 by passing an s3 url as the --out in a format like:

--out s3://AWS_KEY:AWS_SECRET_KEY@BUCKET_NAME/FILENAME.xml

If you have your credentials stored locally, you can omit the passed params like:

--out s3://BUCKET_NAME/FILENAME.xml