<!--
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
-->
[](https://www.repostatus.org/#wip)
# hermes
Implementation of the HERMES workflow to automatize software publication with rich metadata.
For more extensive documentation, see our [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).)
## 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`:
```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](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.
Raw data
{
"_id": null,
"home_page": "https://software-metadata.pub",
"name": "hermes",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "publishing, metadata, automation",
"author": "Stephan Druskat",
"author_email": "stephan.druskat@dlr.de",
"download_url": "https://files.pythonhosted.org/packages/68/75/607cb7143f2d3566fc7ae287f82eaf99a72f73e5c463b0550cc3e1403bbf/hermes-0.8.1.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2022 German Aerospace Center (DLR), Forschungszentrum J\u00fclich\n\nSPDX-License-Identifier: CC-BY-SA-4.0\n-->\n\n<!--\nSPDX-FileContributor: Stephan Druskat\nSPDX-FileContributor: Michael Meinel\nSPDX-FileContributor: Oliver Bertuch\n-->\n\n\n\n[](https://www.repostatus.org/#wip)\n\n\n\n# hermes\n\nImplementation of the HERMES workflow to automatize software publication with rich metadata.\nFor more extensive documentation, see our [HERMES workflow documentation](https://docs.software-metadata.pub/en/latest).\n\n(For more information about the HERMES [HMC](https://helmholtz-metadata.de) *project*, see the [HERMES project website](https://software-metadata.pub).)\n\n\n\n## Installation\n\n`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).\n\nIn case you still want to install on your machine, you can (for example) use `pip`:\n\n```shell\npip install hermes\n```\n\n**Note: you must have Python 3.10 or newer installed.**\nOlder installations of Python will receive a non-related package because of PyPI limitations!\n\n### Development Snapshot\n\nTo install the most recent version that has not been released yet, please install from our sources on GitHub:\n\n```commandline\npip install git+https://github.com/hermes-hmc/hermes.git\n```\n\n## Usage\n\nThe `hermes` application provides the entry point for the HERMES workflow.\nAfter installation, you can run it from your command line environment:\n\n```shell\nhermes --help\nhermes harvest\n```\n\nYou can also call the `hermes` package as a Python module:\n\n```shell\npython -m hermes --help\npython -m hermes harvest\n```\n\n## Contributions, Extension and Development\n\nWe welcome external contributions! Please follow our [contribution guidelines](CONTRIBUTING.md).\n\nHERMES was designed with extensibility in mind. Our [development guide](https://docs.software-metadata.pub/en/latest/dev/start.html)\ncontains in-depth information on how to get ready and start coding.\n\n## Acknowledgements\n\nThis project (ZT-I-PF-3-006) was funded by the *Initiative and Networking Fund*\nof the [Helmholtz Association](https://www.helmholtz.de/en/about-us/structure-and-governance/initiating-and-networking)\nin the framework of the [Helmholtz Metadata Collaboration](https://helmholtz-metadaten.de)'s\n[2020 project call](https://helmholtz-metadaten.de/en/projects/hmc-projects-2020).\n\n## License and Citation\n\nPlease see [`LICENSE.md`](LICENSE.md) for legal information.\nWe provide a [`CITATION.cff`](CITATION.cff) containing all metadata for citation, which is also easy to\nuse via the widget on the right-hand side.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Workflow to publish research software with rich metadata",
"version": "0.8.1",
"project_urls": {
"Documentation": "https://docs.software-metadata.pub",
"Homepage": "https://software-metadata.pub",
"Repository": "https://github.com/hermes-hmc/workflow"
},
"split_keywords": [
"publishing",
" metadata",
" automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42614accde27ab059fe8c5f2b881a14c6dcd7c9d8208d82019e52e73dcec095c",
"md5": "fbc87cb976b337fe93a7eb7bce3bccc1",
"sha256": "ba674a7d39a3a36b386a29d233d6aa96881d28924d00487657a27b5eaa90f08b"
},
"downloads": -1,
"filename": "hermes-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fbc87cb976b337fe93a7eb7bce3bccc1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 63436,
"upload_time": "2024-08-13T12:32:55",
"upload_time_iso_8601": "2024-08-13T12:32:55.255325Z",
"url": "https://files.pythonhosted.org/packages/42/61/4accde27ab059fe8c5f2b881a14c6dcd7c9d8208d82019e52e73dcec095c/hermes-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6875607cb7143f2d3566fc7ae287f82eaf99a72f73e5c463b0550cc3e1403bbf",
"md5": "6a5a882edcc4d11695c8686e7f491c5e",
"sha256": "24a208ac2ae9ede45ae1e0bfd534e8b2bd4dbf594d9ef773dfbe10f59d989379"
},
"downloads": -1,
"filename": "hermes-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "6a5a882edcc4d11695c8686e7f491c5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 44192,
"upload_time": "2024-08-13T12:32:56",
"upload_time_iso_8601": "2024-08-13T12:32:56.470267Z",
"url": "https://files.pythonhosted.org/packages/68/75/607cb7143f2d3566fc7ae287f82eaf99a72f73e5c463b0550cc3e1403bbf/hermes-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 12:32:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hermes-hmc",
"github_project": "workflow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hermes"
}
JSON
