Metadata-Version: 2.1
Name: hermes
Version: 0.8.0
Summary: Workflow to publish research software with rich metadata
Home-page: https://software-metadata.pub
License: Apache-2.0
Keywords: publishing,metadata,automation
Author: Stephan Druskat
Author-email: stephan.druskat@dlr.de
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: cffconvert (>=2.0.0,<3.0.0)
Requires-Dist: jsonschema (>=3.0.0,<4.0.0)
Requires-Dist: pydantic (>=2.5.1,<3.0.0)
Requires-Dist: pydantic-settings (>=2.1.0,<3.0.0)
Requires-Dist: pyld (>=2.0.3,<3.0.0)
Requires-Dist: pyparsing (>=3.0.9,<4.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Requires-Dist: ruamel.yaml (>=0.17.21,<0.18.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://docs.software-metadata.pub
Project-URL: Repository, https://github.com/hermes-hmc/workflow
Description-Content-Type: text/markdown

<!--
SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR), Forschungszentrum Jülich

SPDX-License-Identifier: CC-BY-SA-4.0
-->

<!--
SPDX-FileContributor: Stephan Druskat
SPDX-FileContributor: Michael Meinel
SPDX-FileContributor: Oliver Bertuch
-->

![HERMES Key Visual](docs/source/_static/img/header.png)

# hermes

Implementation of the HERMES workflow. For more extensive documentation, see the [HERMES workflow documentation](https://docs.software-metadata.pub/en/latest).

(For more information about the HERMES [HMC](https://helmholtz-metadata.de) *project*, see the [HERMES project website](https://software-metadata.pub).)

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=hermes-hmc_workflow&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=hermes-hmc_workflow)


## Installation

`hermes`' primary use case is to [use it in a continuous integration environment](https://docs.software-metadata.pub/en/latest/tutorials/automated-publication-with-ci.html).

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

- Note: you must have Python 3.10 or newer installed.
- Note: please use the development installation method for now - releases coming to PyPI soon!

### 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](CONTRIBUTING.md).

HERMES was designed with extensibility in mind. Our [development guide](https://docs.software-metadata.pub/en/latest/dev/start.html)
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](https://www.helmholtz.de/en/about-us/structure-and-governance/initiating-and-networking)
in the framework of the [Helmholtz Metadata Collaboration](https://helmholtz-metadaten.de)'s
[2020 project call](https://helmholtz-metadaten.de/en/projects/hmc-projects-2020).

## License and Citation

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

