# Hermes harvest plugin for .toml files
This plugin enables the harvesting of metadata stored in the .toml file of the project. It is configured to automatically harvest from "pyproject.toml". Although it can be used for every .toml file it uses the fields commonly used in .toml files for python.
## Authors
- [@led02](https://www.github.com/led02)
- [@notactuallyfinn](https://www.github.com/notactuallyfinn)
## Related
The hermes project
[Github repository](https://github.com/hermes-hmc/hermes)
The hermes harvest plugin for git
[Github repository](https://github.com/hermes-hmc/hermes-git)
## Run Locally
Clone Hermes project
```bash
git clone https://github.com/hermes-hmc/hermes.git
```
Go to the project directory
```bash
cd your_other_folder
```
Make a python package out of it
```bash
pip install .
```
Clone the project
```bash
git clone https://github.com/hermes-hmc/hermes-python.git
```
Go to the project directory
```bash
cd your_folder
```
Make a python package out of it
```bash
pip install .
```
Go to the project folder you want to harvest
```bash
cd your_project_to_harvest
```
Controll that you have a file named "hermes.toml" in your project with the following content.
```
[harvest]
sources = ["cff", "toml"]
[deposit.invenio_rdm]
site_url = "https://sandbox.zenodo.org"
access_right = "open"
```
Run harvest command
```bash
hermes harvest
```
![Logo](https://docs.software-metadata.pub/en/latest/_static/hermes-visual-blue.svg)
Raw data
{
"_id": null,
"home_page": null,
"name": "hermes-plugin-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "publishing, metadata, automation",
"author": "Michael Fritzsche",
"author_email": "Michael Meinel <michael.meinel@dlr.de>",
"download_url": "https://files.pythonhosted.org/packages/4b/ed/1dba3250bb087562a106dc0f855cd0a3989116ad59f2e93d9ee999caaca5/hermes_plugin_python-0.2.0.tar.gz",
"platform": null,
"description": "\n# Hermes harvest plugin for .toml files\nThis plugin enables the harvesting of metadata stored in the .toml file of the project. It is configured to automatically harvest from \"pyproject.toml\". Although it can be used for every .toml file it uses the fields commonly used in .toml files for python.\n\n\n## Authors\n\n- [@led02](https://www.github.com/led02)\n- [@notactuallyfinn](https://www.github.com/notactuallyfinn)\n\n\n## Related\n\nThe hermes project\n\n[Github repository](https://github.com/hermes-hmc/hermes)\n\nThe hermes harvest plugin for git\n\n[Github repository](https://github.com/hermes-hmc/hermes-git)\n## Run Locally\n\nClone Hermes project\n\n```bash\n git clone https://github.com/hermes-hmc/hermes.git\n```\n\nGo to the project directory\n\n```bash\n cd your_other_folder\n```\n\nMake a python package out of it\n\n```bash\n pip install .\n```\n\nClone the project\n\n```bash\n git clone https://github.com/hermes-hmc/hermes-python.git\n```\n\nGo to the project directory\n\n```bash\n cd your_folder\n```\n\nMake a python package out of it\n\n```bash\n pip install .\n```\n\nGo to the project folder you want to harvest\n\n```bash\n cd your_project_to_harvest\n```\n\nControll that you have a file named \"hermes.toml\" in your project with the following content.\n```\n [harvest]\n sources = [\"cff\", \"toml\"]\n\n [deposit.invenio_rdm]\n site_url = \"https://sandbox.zenodo.org\"\n access_right = \"open\"\n```\n\nRun harvest command\n\n```bash\n hermes harvest\n```\n\n![Logo](https://docs.software-metadata.pub/en/latest/_static/hermes-visual-blue.svg)\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "HERMES plugin for .toml files",
"version": "0.2.0",
"project_urls": {
"Repository": "https://github.com/hermes-hmc/hermes-plugin-python"
},
"split_keywords": [
"publishing",
" metadata",
" automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e726703b8b5ecd60f9a20f08d5bcb7cecb321d6e3c102e234922cb52a6ba679",
"md5": "7294cdfd0c543159f9e64d4543158ae5",
"sha256": "42068df17c6f23d0b15ab3938057355a08a72dfcbca9156947f922352523a4c6"
},
"downloads": -1,
"filename": "hermes_plugin_python-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7294cdfd0c543159f9e64d4543158ae5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5128,
"upload_time": "2024-08-02T11:18:42",
"upload_time_iso_8601": "2024-08-02T11:18:42.407517Z",
"url": "https://files.pythonhosted.org/packages/7e/72/6703b8b5ecd60f9a20f08d5bcb7cecb321d6e3c102e234922cb52a6ba679/hermes_plugin_python-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4bed1dba3250bb087562a106dc0f855cd0a3989116ad59f2e93d9ee999caaca5",
"md5": "51ecd4be15e91d1940a47c32af746f1f",
"sha256": "c6777075cef389e914613ddf7029917bde1e7e7f4cd327382b5a7ac60b4d2ea2"
},
"downloads": -1,
"filename": "hermes_plugin_python-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "51ecd4be15e91d1940a47c32af746f1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4679,
"upload_time": "2024-08-02T11:18:43",
"upload_time_iso_8601": "2024-08-02T11:18:43.686595Z",
"url": "https://files.pythonhosted.org/packages/4b/ed/1dba3250bb087562a106dc0f855cd0a3989116ad59f2e93d9ee999caaca5/hermes_plugin_python-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 11:18:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hermes-hmc",
"github_project": "hermes-plugin-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hermes-plugin-python"
}