Skip to main content

Workflow to publish research software with rich metadata

Project description

HERMES Key Visual

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. PyPI - Version PyPI - Python Version

hermes

Implementation of the HERMES workflow to automatize software publication with rich metadata. For more extensive documentation, see our HERMES workflow documentation.

(For more information about the HERMES HMC project, see the HERMES project website.)

HERMES Workflow Visualization

Installation

hermes' primary use case is to use it in a continuous integration environment.

In case you still want to install on your machine, you can (for example) use pip:

pip install hermes

Note: you must have Python 3.10 or newer installed. Older installations of Python will receive a non-related package because of PyPI limitations!

Development Snapshot

To install the most recent version that has not been released yet, please install from our sources on GitHub:

pip install git+https://github.com/hermes-hmc/hermes.git

Usage

The hermes application provides the entry point for the HERMES workflow. After installation, you can run it from your command line environment:

hermes --help
hermes harvest

You can also call the hermes package as a Python module:

python -m hermes --help
python -m hermes harvest

Contributions, Extension and Development

We welcome external contributions! Please follow our contribution guidelines.

HERMES was designed with extensibility in mind. Our development guide contains in-depth information on how to get ready and start coding.

Acknowledgements

This project (ZT-I-PF-3-006) was funded by the Initiative and Networking Fund of the Helmholtz Association in the framework of the Helmholtz Metadata Collaboration's 2020 project call.

License and Citation

Please see LICENSE.md for legal information. We provide a CITATION.cff containing all metadata for citation, which is also easy to use via the widget on the right-hand side.

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

hermes-0.9.0.tar.gz (62.6 kB view details)

Uploaded Source

Built Distribution

hermes-0.9.0-py3-none-any.whl (88.1 kB view details)

Uploaded Python 3

File details

Details for the file hermes-0.9.0.tar.gz.

File metadata

  • Download URL: hermes-0.9.0.tar.gz
  • Upload date:
  • Size: 62.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hermes-0.9.0.tar.gz
Algorithm Hash digest
SHA256 3bd0ecda026e94da470864f22c9af05e1d68f3cb23d50628ecffe059e8c20721
MD5 f2503542253e1da4aa2de620956de006
BLAKE2b-256 c0942903e4b2e5709afd9f6c98d6648538bea88147bdd2fd33fcd519feb6b4a2

See more details on using hashes here.

Provenance

The following attestation bundles were made for hermes-0.9.0.tar.gz:

Publisher: release.yml on softwarepub/hermes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hermes-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: hermes-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 88.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hermes-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 260881b678b90ac298a10b26cd2f6d95bb14d9d4d6f77bbb37b8b0ad854228f3
MD5 eb3cccfc769bb2cf982f755a55376aa6
BLAKE2b-256 3e71bf7282b4678266df4648b685edc2496954c463bea7d0aeff0cc181503d62

See more details on using hashes here.

Provenance

The following attestation bundles were made for hermes-0.9.0-py3-none-any.whl:

Publisher: release.yml on softwarepub/hermes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page