Data

Tools

Indexes

Applications

Experiments

Open Source Science

hermes

Implementation of the HERMES workflow

https://github.com/softwarepub/hermes

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

automation continuous-integration fair-software fair4rs software-citation software-metadata software-publication
Last synced: 6 months ago · JSON representation ·

Repository

Implementation of the HERMES workflow

Basic Info
Statistics
  • Stars: 28
  • Watchers: 7
  • Forks: 6
  • Open Issues: 164
  • Releases: 3
Topics
automation continuous-integration fair-software fair4rs software-citation software-metadata software-publication
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation Governance

README.md

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:

shell 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:

commandline 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:

shell hermes --help hermes harvest

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

shell 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.

Citation (CITATION.cff) 

# SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR), Helmholtz-Zentrum Dresden-Rossendorf
#
# SPDX-License-Identifier: CC0-1.0

# SPDX-FileContributor: Michael Meinel
# SPDX-FileContributor: Oliver Knodel
# SPDX-FileContributor: Stephan Druskat

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: hermes
message: >-
  If you use this software, please cite it using the
  metadata from this file.
version: 0.9.0
license: "Apache-2.0"
abstract: "Tool to automate software publication. Not stable yet."
type: software
authors:
  - given-names: Michael
    family-names: Meinel
    email: michael.meinel@dlr.de
    affiliation: German Aerospace Center (DLR)
    orcid: 'https://orcid.org/0000-0001-6372-3853'
  - given-names: Stephan
    family-names: Druskat
    email: stephan.druskat@dlr.de
    affiliation: German Aerospace Center (DLR)
    orcid: 'https://orcid.org/0000-0003-4925-7248'
  - given-names: Oliver
    family-names: Bertuch
    email: o.bertuch@fz-juelich.de
    affiliation: Forschungszentrum Jülich
    orcid: 'https://orcid.org/0000-0002-2702-3419'
  - given-names: Oliver
    family-names: Knodel
    email: o.knodel@hzdr.de
    affiliation: Helmholtz-Zentrum Dresden-Rossendorf (HZDR)
    orcid: 'https://orcid.org/0000-0001-8174-7795'
  - given-names: David
    family-names: Pape
    email: d.pape@hzdr.de
    affiliation: Helmholtz-Zentrum Dresden-Rossendorf (HZDR)
    orcid: 'https://orcid.org/0000-0002-3145-9880'
  - given-names: Kernchen
    family-names: Sophie
    email: sophie.kernchen@dlr.de
    affiliation: German Aerospace Center (DLR)
    orcid: 'https://orcid.org/0009-0005-4430-6743'
  - given-names: Nitai
    family-names: Heeb
    email: n.heeb@fz-juelich.de
    affiliation: Forschungszentrum Jülich
    orcid: 'https://orcid.org/0009-0001-8382-4923'
identifiers:
  - type: doi
    value: 10.5281/zenodo.13221384
    description: Version 0.8.1b1

GitHub Events

Total
  • Create event: 32
  • Release event: 1
  • Issues event: 92
  • Watch event: 10
  • Delete event: 25
  • Issue comment event: 137
  • Push event: 222
  • Pull request review comment event: 72
  • Pull request review event: 101
  • Pull request event: 59
Last Year
  • Create event: 32
  • Release event: 1
  • Issues event: 92
  • Watch event: 10
  • Delete event: 25
  • Issue comment event: 137
  • Push event: 222
  • Pull request review comment event: 72
  • Pull request review event: 101
  • Pull request event: 59

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 75
  • Total pull requests: 43
  • Average time to close issues: 4 months
  • Average time to close pull requests: 11 days
  • Total issue authors: 14
  • Total pull request authors: 9
  • Average comments per issue: 0.63
  • Average comments per pull request: 0.58
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 12
Past Year
  • Issues: 65
  • Pull requests: 33
  • Average time to close issues: 20 days
  • Average time to close pull requests: 10 days
  • Issue authors: 12
  • Pull request authors: 9
  • Average comments per issue: 0.45
  • Average comments per pull request: 0.7
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 4
View more stats
Top Authors
Issue Authors
  • sdruskat (32)
  • SKernchen (13)
  • zyzzyxdonta (8)
  • led02 (5)
  • nheeb (3)
  • Aidajafarbigloo (3)
  • poikilotherm (3)
  • notactuallyfinn (2)
  • schlauch (1)
  • fabas-mpcdf (1)
  • aaronpeikert (1)
  • jkelling (1)
  • FObersteiner (1)
  • daniel-mohr (1)
Pull Request Authors
  • github-actions[bot] (10)
  • sdruskat (7)
  • led02 (6)
  • nheeb (5)
  • zyzzyxdonta (5)
  • SKernchen (4)
  • poikilotherm (3)
  • dependabot[bot] (2)
  • Aidajafarbigloo (1)
Top Labels
Issue Labels
data model (20) enhancement (12) bug (8) architecture (8) Hackathon24 (7) documentation (6) meeting-discussion (5) good first issue (5) 🗺️ data-model-refactoring-roadmap (5) 4️ prepare/deposit (4) 0️⃣init (3) question (3) :grey_question: Triage (3) 1️ harvesting (3) 🎯 InvenioRDM (2) 2️ process/validate (1) conference-discussion (1) de-RSE24 (1)
Pull Request Labels
dependencies (2) python (2) enhancement (2) data model (1) documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 330 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 3
  • Total versions: 10
  • Total maintainers: 5
pypi.org: hermes

Workflow to publish research software with rich metadata

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 3
  • Downloads: 330 Last month
Rankings
Stargazers count: 6.2%
Dependent repos count: 9.0%
Dependent packages count: 10.0%
Forks count: 10.2%
Average: 11.2%
Downloads: 20.7%
Maintainers (5)
sdruskat poikilotherm led02 zyzzyxdonta meinel
Last synced: 6 months ago

Dependencies

poetry.lock pypi
  • alabaster 0.7.12 develop
  • atomicwrites 1.4.0 develop
  • attrs 21.4.0 develop
  • babel 2.10.1 develop
  • certifi 2021.10.8 develop
  • charset-normalizer 2.0.12 develop
  • coverage 6.3.2 develop
  • docutils 0.17.1 develop
  • idna 3.3 develop
  • imagesize 1.3.0 develop
  • iniconfig 1.1.1 develop
  • jinja2 3.1.2 develop
  • markdown-it-py 2.1.0 develop
  • markupsafe 2.1.1 develop
  • mdit-py-plugins 0.3.0 develop
  • mdurl 0.1.1 develop
  • myst-parser 0.17.2 develop
  • packaging 21.3 develop
  • pluggy 1.0.0 develop
  • py 1.11.0 develop
  • pygments 2.12.0 develop
  • pyparsing 3.0.8 develop
  • pytest 7.1.2 develop
  • pytest-cov 3.0.0 develop
  • pytz 2022.1 develop
  • pyyaml 6.0 develop
  • requests 2.27.1 develop
  • snowballstemmer 2.2.0 develop
  • sphinx 4.5.0 develop
  • sphinxcontrib-applehelp 1.0.2 develop
  • sphinxcontrib-devhelp 1.0.2 develop
  • sphinxcontrib-htmlhelp 2.0.0 develop
  • sphinxcontrib-jsmath 1.0.1 develop
  • sphinxcontrib-qthelp 1.0.3 develop
  • sphinxcontrib-serializinghtml 1.1.5 develop
  • tomli 2.0.1 develop
  • typing-extensions 4.2.0 develop
  • urllib3 1.26.9 develop
  • click 8.1.2
  • colorama 0.4.4
pyproject.toml pypi
  • Sphinx ^4.5.0 develop
  • myst-parser ^0.17.2 develop
  • pytest ^7.1.1 develop
  • pytest-cov ^3.0.0 develop
  • click ^8.1
  • python ^3.10
.github/workflows/cffconvert.yml actions
  • actions/checkout v2 composite
  • citation-file-format/cffconvert-github-action 2.0.0 composite
.github/workflows/check-licenses.yml actions
  • actions/checkout v3 composite
  • fsfe/reuse-action v1 composite
.github/workflows/hermes-zenodo-sandbox.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite