Skip to content

Commit 759420c

Browse files
Added readme.md
1 parent e58aed7 commit 759420c

1 file changed

Lines changed: 82 additions & 0 deletions

File tree

README.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
2+
# Hermes harvest plugin for .toml files
3+
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.
4+
5+
6+
## Authors
7+
8+
- [@led02](https://www.github.com/led02)
9+
- [@notactuallyfinn](https://www.github.com/notactuallyfinn)
10+
11+
12+
## Related
13+
14+
The hermes project
15+
16+
[Github repository](https://github.com/hermes-hmc/hermes)
17+
18+
The hermes harvest plugin for git
19+
20+
[Github repository](https://github.com/hermes-hmc/hermes-git)
21+
## Run Locally
22+
23+
Clone Hermes project
24+
25+
```bash
26+
git clone https://github.com/hermes-hmc/hermes
27+
```
28+
29+
Go to the project directory
30+
31+
```bash
32+
cd your_other_folder
33+
```
34+
35+
Make a python package out of it
36+
37+
```bash
38+
pip install .
39+
```
40+
41+
Clone the project
42+
43+
```bash
44+
git clone https://github.com/hermes-hmc/hermes-python
45+
```
46+
47+
Go to the project directory
48+
49+
```bash
50+
cd your_folder
51+
```
52+
53+
Make a python package out of it
54+
55+
```bash
56+
pip install .
57+
```
58+
59+
Go to the project folder you want to harvest
60+
61+
```bash
62+
cd your_project_to_harvest
63+
```
64+
65+
Controll that you have a file named "hermes.toml" in your project with the following content.
66+
```
67+
[harvest]
68+
sources = ["cff", "toml"]
69+
70+
[deposit.invenio_rdm]
71+
site_url = "https://sandbox.zenodo.org"
72+
access_right = "open"
73+
```
74+
75+
Run harvest command
76+
77+
```bash
78+
hermes harvest
79+
```
80+
81+
![Logo](https://docs.software-metadata.pub/en/latest/_static/hermes-visual-blue.svg)
82+

0 commit comments

Comments
 (0)