Harvester Installation

How to Install Existing Harvesters

Harvesters written for the SHARE project run through scrAPI - or SHARE core. If you'd like to install scrapi on your own machine and run a few of the harvesters, follow these steps!

1. Fork scrAPI on GitHub, clone it to your local machine, and go into that directory.

• See the GitHub help page on forking for detailed instructions.

2. Using a new virtual environment, install the requirements for scrapi using
   pip install -r requirements.txt

   If you'll be doing development and would like to use the scrAPI linter, run:
   pip install -r dev-requirements.txt

3. Run all of the harvesters at once by running
   invoke harvesters
   ...or run a specific consumer by running
   invoke consumer [harvester name here]

If you'd like to run a harvester with a certain number of days back, run
invoke consumer [harvester name here] --days=[number of days back]

See the list of provider names or see the names of the current providers in scrapi for examples of harvesters you can invoke.