Skip to content

Commit

Permalink
Replace YALM with YAML #42
Browse files Browse the repository at this point in the history
  • Loading branch information
PavelAntonia committed May 7, 2022
1 parent 4009e0d commit 53b91b8
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 14 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,14 @@ If everything goes fine, you should see:
d8'
_________________________________________________________
usage: ya2ro [-h] (-i YALM_PATH | -l YA2RO_PREV_OUTPUT) [-o OUTPUT_DIR] [-p PROPERTIES_FILE] [-ns]
usage: ya2ro [-h] (-i YAML_PATH | -l YA2RO_PREV_OUTPUT) [-o OUTPUT_DIR] [-p PROPERTIES_FILE] [-ns]
Human and machine readable input as a yaml file and create RO-Object in jsonld and/or HTML view. Run 'ya2ro -configure GITHUB_PERSONAL_ACCESS_TOKEN' this the first time to configure ya2ro
properly
options:
-h, --help show this help message and exit
-i YALM_PATH, --input YALM_PATH
-i YAML_PATH, --input YAML_PATH
Path of the required yaml input. Follow the documentation or the example given to see the structure of the file.
-l YA2RO_PREV_OUTPUT, --landing_page YA2RO_PREV_OUTPUT
Path of a previous output folder using the ya2ro tool. This flag will make a landing page to make all the resources accessible.
Expand All @@ -104,19 +104,19 @@ options:

### How to use

The first thing to do is create some input for ya2ro. To create valid a yalm you should follow the documentation bellow.
The first thing to do is create some input for ya2ro. To create valid a yaml you should follow the documentation bellow.

Create a yalm from scratch or use one of the supplied templates. Currently ya2ro supports two formats:
Create a yaml from scratch or use one of the supplied templates. Currently ya2ro supports two formats:

* paper
* project

Please find a template for each type under the directory templates.
Once you have a valid yalm (proyect or paper) is time to run ya2ro.
Once you have a valid yaml (project or paper) is time to run ya2ro.

#### Create machine and human readable content

It is possible to process batches of yalms at the same time, to do that just specify as input a folder with all the yalms inside.
It is possible to process batches of yamls at the same time, to do that just specify as input a folder with all the yamls inside.

##### Simple execution

Expand Down
2 changes: 1 addition & 1 deletion Yaml Examples/EELISA - Green Planet Projects/ya2ro.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ demo:
-
name: "Demo Green Planet Projects"
link: https://oeg-upm.github.io/ya2ro/output/landing_page.html
description: "This is an output example using the 'Green Planet Projects' yalms as input and it is hosted on GitHub Pages."
description: "This is an output example using the 'Green Planet Projects' yamls as input and it is hosted on GitHub Pages."

software:
-
Expand Down
7 changes: 2 additions & 5 deletions output/agricultural_practices/ro-crate.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
{
"@id": "https://orcid.org/0000-0003-0212-3381",
"@type": "Person",
"description": null,
"name": "MARGARITA RUIZ RAMOS",
"position": [
"Universidad Polit\u00e9cnica de Madrid - Technical University of Madrid"
Expand Down Expand Up @@ -91,14 +90,12 @@
{
"@type": "Demo",
"description": "Anonymous interview transcript.",
"link": "https://drive.google.com/drive/folders/1xKIWHDgsBjiRalMb5BM-pDHEbslLYJpr",
"name": null
"link": "https://drive.google.com/drive/folders/1xKIWHDgsBjiRalMb5BM-pDHEbslLYJpr"
},
{
"@type": "Demo",
"description": "Interview questions.",
"link": "https://drive.google.com/drive/folders/1I_KPjAKJ1zKPWqj2VVWj4uRLOxH2DCLk",
"name": null
"link": "https://drive.google.com/drive/folders/1I_KPjAKJ1zKPWqj2VVWj4uRLOxH2DCLk"
}
]
},
Expand Down
1 change: 0 additions & 1 deletion src/ya2ro/ro_jsonld.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
from pandas import notnull
from . import properties as p
import json

Expand Down
2 changes: 1 addition & 1 deletion src/ya2ro/ya2ro.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def main():
group = parser.add_mutually_exclusive_group(required=True)

# Required positional argument
group.add_argument('-i','--input', type=str, metavar='YALM_PATH',
group.add_argument('-i','--input', type=str, metavar='YAML_PATH',
help='Path of the required yaml input. Follow the documentation or the example given to see the structure of the file.')

# Required positional argument
Expand Down

0 comments on commit 53b91b8

Please sign in to comment.