Getting started

1. Update fields in pyproject.toml: replace or remove dummy data, choose a build backend, etc.
2. Replace all placeholders (e.g. <your_source>, etc.) in all files and directory names.
3. Describe your plugin below.
4. License your plugin: we recommend following the REUSE specifications and use of the reuse tool.
5. Update fields in CITATION.cff: replace or remove dummy data
6. Delete this section and start implementing.
7. When release-ready, add your plugin to the HERMES Marketplace.

Hermes harvest plugin for <your_source>

This plugin enables the harvesting of metadata stored in <your_source>.

Related

• The Github repository of the hermes project

Run Locally

Clone this project, go to the project directory and install this project:

  git clone link_to_your_repository
  cd your_folder
  
  # Recommended: Create a virtual environment to install into
  pip install .

Go to the project folder you want to harvest:

  cd your_project_to_harvest

Make sure that you have a file named hermes.toml in your project with the following content:

  [harvest]
  sources = ["your_source"]

Run the harvest command:

  hermes harvest

The harvested metadata from <your_source> is stored in the local cache at .hermes/harvest/.