| Name | rocrate JSON |
| Version |
0.13.0
JSON |
| download |
| home_page | https://github.com/ResearchObject/ro-crate-py/ |
| Summary | RO-Crate metadata generator/parser |
| upload_time | 2024-12-20 14:20:35 |
| maintainer | None |
| docs_url | None |
| author | Eli Chadwick, Paul De Geest, Bert Droesbeke, Ignacio Eguinoa, Alban Gaignard, Matthias Hörtenhuber, Sebastiaan Huber, Bruno Kinoshita, Simone Leo, Luca Pireddu, Laura Rodríguez-Navas, Raül Sirvent, Stian Soiland-Reyes |
| requires_python | >=3.9 |
| license | Apache-2.0 |
| keywords |
researchobject
ro-crate
ro
metadata
jsonld
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
requests
arcp
jinja2
python-dateutil
click
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/ResearchObject/ro-crate-py/actions?query=workflow%3A%22Python+package%22) [](https://github.com/ResearchObject/ro-crate-py/actions?query=workflow%3A%22Upload+Python+Package%22) [](https://pypi.org/project/rocrate/) [](https://zenodo.org/badge/latestdoi/216605684)
ro-crate-py is a Python library to create and consume [Research Object Crates](https://w3id.org/ro/crate). It currently supports the [RO-Crate 1.1](https://w3id.org/ro/crate/1.1) specification.
## Installation
ro-crate-py requires Python 3.9 or later. The easiest way to install is via [pip](https://docs.python.org/3/installing/):
```
pip install rocrate
```
To install manually from this code base (e.g., to try the latest development revision):
```
git clone https://github.com/ResearchObject/ro-crate-py
cd ro-crate-py
pip install .
```
## Usage
### Creating an RO-Crate
In its simplest form, an RO-Crate is a directory tree with an `ro-crate-metadata.json` file at the top level. This file contains metadata about the other files and directories, represented by [data entities](https://www.researchobject.org/ro-crate/1.1/data-entities.html). These metadata consist both of properties of the data entities themselves and of other, non-digital entities called [contextual entities](https://www.researchobject.org/ro-crate/1.1/contextual-entities.html). A contextual entity can represent, for instance, a person, an organization or an event.
Suppose Alice and Bob worked on a research task together, which resulted in a manuscript written by both; additionally, Alice prepared a spreadsheet containing the experimental data, which Bob used to generate a diagram. We will create placeholder files for these documents:
```bash
mkdir exp
touch exp/paper.pdf
touch exp/results.csv
touch exp/diagram.svg
```
Let's make an RO-Crate to package all this:
```python
from rocrate.rocrate import ROCrate
crate = ROCrate()
paper = crate.add_file("exp/paper.pdf", properties={
"name": "manuscript",
"encodingFormat": "application/pdf"
})
table = crate.add_file("exp/results.csv", properties={
"name": "experimental data",
"encodingFormat": "text/csv"
})
diagram = crate.add_file("exp/diagram.svg", dest_path="images/figure.svg", properties={
"name": "bar chart",
"encodingFormat": "image/svg+xml"
})
```
The `dest_path` argument is used to specify the relative path of the file with respect to the crate's directory (which will be determined when the crate is written). Note that the first two `add_file` calls do not specify `dest_path`: in this case, it will be set to the source file's basename (`"paper.pdf"` in the first case), so the file will be at the crate's top level when it is written.
We've started by adding the data entities. Now we need contextual entities to represent Alice and Bob:
```python
from rocrate.model.person import Person
alice_id = "https://orcid.org/0000-0000-0000-0000"
bob_id = "https://orcid.org/0000-0000-0000-0001"
alice = crate.add(Person(crate, alice_id, properties={
"name": "Alice Doe",
"affiliation": "University of Flatland"
}))
bob = crate.add(Person(crate, bob_id, properties={
"name": "Bob Doe",
"affiliation": "University of Flatland"
}))
```
At this point, we have a representation of the various entities. Now we need to express the relationships between them. This is done by adding properties that reference other entities:
```python
paper["author"] = [alice, bob]
table["author"] = alice
diagram["author"] = bob
```
You can also add whole directories together with their contents. In an RO-Crate, a directory is represented by the `Dataset` entity. Create a directory with some placeholder files:
```bash
mkdir exp/logs
touch exp/logs/log1.txt
touch exp/logs/log2.txt
```
Now add it to the crate:
```python
logs = crate.add_dataset("exp/logs")
```
Finally, we serialize the crate to disk:
```python
crate.write("exp_crate")
```
Now the `exp_crate` directory should contain copies of all the files we added and an `ro-crate-metadata.json` file with a [JSON-LD](https://json-ld.org) representation of the entities and relationships we created, with the following layout:
```
exp_crate/
|-- images/
| `-- figure.svg
|-- logs/
| |-- log1.txt
| `-- log2.txt
|-- paper.pdf
|-- results.csv
`-- ro-crate-metadata.json
```
Exploring the `exp_crate` directory, we see that all files and directories contained in `exp/logs` have been added recursively to the crate. However, in the `ro-crate-metadata.json` file, only the top level Dataset with `@id` `"exp/logs"` is listed. This is because we used `crate.add_dataset("exp/logs")` rather than adding every file individually. There is no requirement to represent every file and folder within the crate in the `ro-crate-metadata.json` file. If you do want to add files and directories recursively to the metadata, use `crate.add_tree` instead of `crate.add_dataset` (but note that it only works on local directory trees).
Some applications and services support RO-Crates stored as archives. To save the crate in zip format, use `write_zip`:
```python
crate.write_zip("exp_crate.zip")
```
#### Appending elements to property values
What ro-crate-py entities actually store is their JSON representation:
```python
paper.properties()
```
```json
{
"@id": "paper.pdf",
"@type": "File",
"name": "manuscript",
"encodingFormat": "application/pdf",
"author": [
{"@id": "https://orcid.org/0000-0000-0000-0000"},
{"@id": "https://orcid.org/0000-0000-0000-0001"},
]
}
```
When `paper["author"]` is accessed, a new list containing the `alice` and `bob` entities is generated on the fly. For this reason, calling `append` on `paper["author"]` won't actually modify the `paper` entity in any way. To add an author, use the `append_to` method instead:
```python
donald = crate.add(Person(crate, "https://en.wikipedia.org/wiki/Donald_Duck", properties={
"name": "Donald Duck"
}))
paper.append_to("author", donald)
```
Note that `append_to` also works if the property to be updated is missing or has only one value:
```python
for n in "Mickey_Mouse", "Scrooge_McDuck":
p = crate.add(Person(crate, f"https://en.wikipedia.org/wiki/{n}"))
donald.append_to("follows", p)
```
#### Adding remote entities
Data entities can also be remote:
```python
input_data = crate.add_file("http://example.org/exp_data.zip")
```
By default the file won't be downloaded, and will be referenced by its URI in the serialized crate:
```json
{
"@id": "http://example.org/exp_data.zip",
"@type": "File"
},
```
If you add `fetch_remote=True` to the `add_file` call, however, the library (when `crate.write` is called) will try to download the file and include it in the output crate.
Another option that influences the behavior when dealing with remote entities is `validate_url`, also `False` by default: if it's set to `True`, when the crate is serialized, the library will try to open the URL to add / update metadata bits such as the content's length and format (but it won't try to download the file unless `fetch_remote` is also set).
#### Adding entities with an arbitrary type
An entity can be of any type listed in the [RO-Crate context](https://www.researchobject.org/ro-crate/1.1/context.jsonld). However, only a few of them have a counterpart (e.g., `File`) in the library's class hierarchy (either because they are very common or because they are associated with specific functionality that can be conveniently embedded in the class implementation). In other cases, you can explicitly pass the type via the `properties` argument:
```python
from rocrate.model.contextentity import ContextEntity
hackathon = crate.add(ContextEntity(crate, "#bh2021", properties={
"@type": "Hackathon",
"name": "Biohackathon 2021",
"location": "Barcelona, Spain",
"startDate": "2021-11-08",
"endDate": "2021-11-12"
}))
```
Note that entities can have multiple types, e.g.:
```python
"@type" = ["File", "SoftwareSourceCode"]
```
### Consuming an RO-Crate
An existing RO-Crate package can be loaded from a directory or zip file:
```python
crate = ROCrate('exp_crate') # or ROCrate('exp_crate.zip')
for e in crate.get_entities():
print(e.id, e.type)
```
```
./ Dataset
ro-crate-metadata.json CreativeWork
paper.pdf File
results.csv File
images/figure.svg File
https://orcid.org/0000-0000-0000-0000 Person
https://orcid.org/0000-0000-0000-0001 Person
```
The first two entities shown in the output are the [root data entity](https://www.researchobject.org/ro-crate/1.1/root-data-entity.html) and the [metadata file descriptor](https://www.researchobject.org/ro-crate/1.1/metadata.html), respectively. The former represents the whole crate, while the latter represents the metadata file. These are special entities managed by the `ROCrate` object, and are always present. The other entities are the ones we added in the [section on RO-Crate creation](#creating-an-ro-crate).
As shown above, `get_entities` allows to iterate over all entities in the crate. You can also access only data entities with `crate.data_entities` and only contextual entities with `crate.contextual_entities`. For instance:
```python
for e in crate.data_entities:
author = e.get("author")
if not author:
continue
elif isinstance(author, list):
print(e.id, [p["name"] for p in author])
else:
print(e.id, repr(author["name"]))
```
```
paper.pdf ['Alice Doe', 'Bob Doe']
results.csv 'Alice Doe'
images/figure.svg 'Bob Doe'
```
You can fetch an entity by its `@id` as follows:
```python
article = crate.dereference("paper.pdf")
```
## Advanced features
### Modifying the crate from JSON-LD dictionaries
The `add_jsonld` method allows to add a contextual entity directly from a
JSON-LD dictionary containing at least the `@id` and `@type` keys:
```python
crate.add_jsonld({
"@id": "https://orcid.org/0000-0000-0000-0000",
"@type": "Person",
"name": "Alice Doe"
})
```
Existing entities can be updated from JSON-LD dictionaries via `update_jsonld`:
```python
crate.update_jsonld({
"@id": "https://orcid.org/0000-0000-0000-0000",
"name": "Alice K. Doe"
})
```
There is also an `add_or_update_jsonld` method that adds the entity if it's
not already in the crate and updates it if it already exists (note that, when
updating, the `@type` key is ignored). This allows to "patch" an RO-Crate from
a JSON-LD file. For instance, suppose you have the following `patch.json` file:
```json
{
"@graph": [
{
"@id": "./",
"author": {"@id": "https://orcid.org/0000-0000-0000-0001"}
},
{
"@id": "https://orcid.org/0000-0000-0000-0001",
"@type": "Person",
"name": "Bob Doe"
}
]
}
```
Then the following sets Bob as the author of the crate according to the above
file:
```python
crate = ROCrate("temp-crate")
with open("patch.json") as f:
json_data = json.load(f)
for d in json_data.get("@graph", []):
crate.add_or_update_jsonld(d)
```
## Command Line Interface
`ro-crate-py` includes a hierarchical command line interface: the `rocrate` tool. `rocrate` is the top-level command, while specific functionalities are provided via sub-commands. Currently, the tool allows to initialize a directory tree as an RO-Crate (`rocrate init`) and to modify the metadata of an existing RO-Crate (`rocrate add`).
```console
$ rocrate --help
Usage: rocrate [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
add
init
write-zip
```
### Crate initialization
The `rocrate init` command explores a directory tree and generates an RO-Crate metadata file (`ro-crate-metadata.json`) listing all files and directories as `File` and `Dataset` entities, respectively.
```console
$ rocrate init --help
Usage: rocrate init [OPTIONS]
Options:
--gen-preview Generate a HTML preview file for the crate.
-e, --exclude NAME Exclude files or directories from the metadata file.
NAME may be a single name or a comma-separated list of
names.
-c, --crate-dir PATH The path to the root data entity of the crate.
Defaults to the current working directory.
--help Show this message and exit.
```
The command acts on the current directory, unless the `-c` option is specified. The metadata file is added (overwritten if present) to the directory at the top level, turning it into an RO-Crate.
### Adding items to the crate
The `rocrate add` command allows to add file, datasets (directories), workflows and other entity types (currently [testing-related metadata](https://crs4.github.io/life_monitor/workflow_testing_ro_crate)) to an RO-Crate:
```console
$ rocrate add --help
Usage: rocrate add [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
dataset
file
test-definition
test-instance
test-suite
workflow
```
Note that data entities (e.g., workflows) must already be present in the directory tree: the effect of the command is to register them in the metadata file.
### Example
```bash
# From the ro-crate-py repository root
cd test/test-data/ro-crate-galaxy-sortchangecase
```
This directory is already an RO-Crate. Delete the metadata file to get a plain directory tree:
```bash
rm ro-crate-metadata.json
```
Now the directory tree contains several files and directories, including a Galaxy workflow and a Planemo test file, but it's not an RO-Crate since there is no metadata file. Initialize the crate:
```bash
rocrate init
```
This creates an `ro-crate-metadata.json` file that lists files and directories rooted at the current directory. Note that the Galaxy workflow is listed as a plain `File`:
```json
{
"@id": "sort-and-change-case.ga",
"@type": "File"
}
```
To register the workflow as a `ComputationalWorkflow`:
```bash
rocrate add workflow -l galaxy sort-and-change-case.ga
```
Now the workflow has a type of `["File", "SoftwareSourceCode", "ComputationalWorkflow"]` and points to a `ComputerLanguage` entity that represents the Galaxy workflow language. Also, the workflow is listed as the crate's `mainEntity` (this is required by the [Workflow RO-Crate profile](https://w3id.org/workflowhub/workflow-ro-crate/1.0), a subtype of RO-Crate which provides extra specifications for workflow metadata).
To add [workflow testing metadata](https://crs4.github.io/life_monitor/workflow_testing_ro_crate) to the crate:
```bash
rocrate add test-suite -i '#test1'
rocrate add test-instance '#test1' http://example.com -r jobs -i '#test1_1'
rocrate add test-definition '#test1' test/test1/sort-and-change-case-test.yml -e planemo -v '>=0.70'
```
To add files or directories after crate initialization:
```bash
cp ../sample_file.txt .
rocrate add file sample_file.txt -P name=sample -P description="Sample file"
cp -r ../test_add_dir .
rocrate add dataset test_add_dir
```
The above example also shows how to set arbitrary properties for the entity with `-P`. This is supported by most `rocrate add` subcommands.
```console
$ rocrate add workflow --help
Usage: rocrate add workflow [OPTIONS] PATH
Options:
-l, --language [cwl|galaxy|knime|nextflow|snakemake|compss|autosubmit]
The workflow language.
-c, --crate-dir PATH The path to the root data entity of the
crate. Defaults to the current working
directory.
-P, --property KEY=VALUE Add an additional property to the metadata
for this entity. Can be used multiple times
to set multiple properties.
--help Show this message and exit.
```
## License
* Copyright 2019-2024 The University of Manchester, UK
* Copyright 2020-2024 Vlaams Instituut voor Biotechnologie (VIB), BE
* Copyright 2020-2024 Barcelona Supercomputing Center (BSC), ES
* Copyright 2020-2024 Center for Advanced Studies, Research and Development in Sardinia (CRS4), IT
* Copyright 2022-2024 École Polytechnique Fédérale de Lausanne, CH
* Copyright 2024 Data Centre, SciLifeLab, SE
* Copyright 2024 National Institute of Informatics (NII), JP
Licensed under the
Apache License, version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>,
see the file `LICENSE.txt` for details.
## Cite as
[](https://zenodo.org/badge/latestdoi/216605684)
The above DOI corresponds to the latest versioned release as [published to Zenodo](https://zenodo.org/record/3956493), where you will find all earlier releases.
To cite `ro-crate-py` independent of version, use <https://doi.org/10.5281/zenodo.3956493>, which will always redirect to the latest release.
You may also be interested in the paper [Packaging research artefacts with RO-Crate](https://doi.org/10.3233/DS-210053).
Raw data
{
"_id": null,
"home_page": "https://github.com/ResearchObject/ro-crate-py/",
"name": "rocrate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "researchobject ro-crate ro metadata jsonld",
"author": "Eli Chadwick, Paul De Geest, Bert Droesbeke, Ignacio Eguinoa, Alban Gaignard, Matthias H\u00f6rtenhuber, Sebastiaan Huber, Bruno Kinoshita, Simone Leo, Luca Pireddu, Laura Rodr\u00edguez-Navas, Ra\u00fcl Sirvent, Stian Soiland-Reyes",
"author_email": "stain@apache.org",
"download_url": "https://files.pythonhosted.org/packages/e6/23/f69edcd6193811e093b4245ae544e5da431e5d3dd4d56398b43054f078a7/rocrate-0.13.0.tar.gz",
"platform": null,
"description": "[](https://github.com/ResearchObject/ro-crate-py/actions?query=workflow%3A%22Python+package%22) [](https://github.com/ResearchObject/ro-crate-py/actions?query=workflow%3A%22Upload+Python+Package%22) [](https://pypi.org/project/rocrate/) [](https://zenodo.org/badge/latestdoi/216605684)\n\nro-crate-py is a Python library to create and consume [Research Object Crates](https://w3id.org/ro/crate). It currently supports the [RO-Crate 1.1](https://w3id.org/ro/crate/1.1) specification.\n\n## Installation\n\nro-crate-py requires Python 3.9 or later. The easiest way to install is via [pip](https://docs.python.org/3/installing/):\n\n```\npip install rocrate\n```\n\nTo install manually from this code base (e.g., to try the latest development revision):\n\n```\ngit clone https://github.com/ResearchObject/ro-crate-py\ncd ro-crate-py\npip install .\n```\n\n## Usage\n\n### Creating an RO-Crate\n\nIn its simplest form, an RO-Crate is a directory tree with an `ro-crate-metadata.json` file at the top level. This file contains metadata about the other files and directories, represented by [data entities](https://www.researchobject.org/ro-crate/1.1/data-entities.html). These metadata consist both of properties of the data entities themselves and of other, non-digital entities called [contextual entities](https://www.researchobject.org/ro-crate/1.1/contextual-entities.html). A contextual entity can represent, for instance, a person, an organization or an event.\n\nSuppose Alice and Bob worked on a research task together, which resulted in a manuscript written by both; additionally, Alice prepared a spreadsheet containing the experimental data, which Bob used to generate a diagram. We will create placeholder files for these documents:\n\n```bash\nmkdir exp\ntouch exp/paper.pdf\ntouch exp/results.csv\ntouch exp/diagram.svg\n```\n\nLet's make an RO-Crate to package all this:\n\n```python\nfrom rocrate.rocrate import ROCrate\n\ncrate = ROCrate()\npaper = crate.add_file(\"exp/paper.pdf\", properties={\n \"name\": \"manuscript\",\n \"encodingFormat\": \"application/pdf\"\n})\ntable = crate.add_file(\"exp/results.csv\", properties={\n \"name\": \"experimental data\",\n \"encodingFormat\": \"text/csv\"\n})\ndiagram = crate.add_file(\"exp/diagram.svg\", dest_path=\"images/figure.svg\", properties={\n \"name\": \"bar chart\",\n \"encodingFormat\": \"image/svg+xml\"\n})\n```\n\nThe `dest_path` argument is used to specify the relative path of the file with respect to the crate's directory (which will be determined when the crate is written). Note that the first two `add_file` calls do not specify `dest_path`: in this case, it will be set to the source file's basename (`\"paper.pdf\"` in the first case), so the file will be at the crate's top level when it is written.\n\nWe've started by adding the data entities. Now we need contextual entities to represent Alice and Bob:\n\n```python\nfrom rocrate.model.person import Person\n\nalice_id = \"https://orcid.org/0000-0000-0000-0000\"\nbob_id = \"https://orcid.org/0000-0000-0000-0001\"\nalice = crate.add(Person(crate, alice_id, properties={\n \"name\": \"Alice Doe\",\n \"affiliation\": \"University of Flatland\"\n}))\nbob = crate.add(Person(crate, bob_id, properties={\n \"name\": \"Bob Doe\",\n \"affiliation\": \"University of Flatland\"\n}))\n```\n\nAt this point, we have a representation of the various entities. Now we need to express the relationships between them. This is done by adding properties that reference other entities:\n\n```python\npaper[\"author\"] = [alice, bob]\ntable[\"author\"] = alice\ndiagram[\"author\"] = bob\n```\n\nYou can also add whole directories together with their contents. In an RO-Crate, a directory is represented by the `Dataset` entity. Create a directory with some placeholder files:\n\n```bash\nmkdir exp/logs\ntouch exp/logs/log1.txt\ntouch exp/logs/log2.txt\n```\n\nNow add it to the crate:\n\n```python\nlogs = crate.add_dataset(\"exp/logs\")\n```\n\nFinally, we serialize the crate to disk:\n\n```python\ncrate.write(\"exp_crate\")\n```\n\nNow the `exp_crate` directory should contain copies of all the files we added and an `ro-crate-metadata.json` file with a [JSON-LD](https://json-ld.org) representation of the entities and relationships we created, with the following layout:\n\n```\nexp_crate/\n|-- images/\n| `-- figure.svg\n|-- logs/\n| |-- log1.txt\n| `-- log2.txt\n|-- paper.pdf\n|-- results.csv\n`-- ro-crate-metadata.json\n```\n\nExploring the `exp_crate` directory, we see that all files and directories contained in `exp/logs` have been added recursively to the crate. However, in the `ro-crate-metadata.json` file, only the top level Dataset with `@id` `\"exp/logs\"` is listed. This is because we used `crate.add_dataset(\"exp/logs\")` rather than adding every file individually. There is no requirement to represent every file and folder within the crate in the `ro-crate-metadata.json` file. If you do want to add files and directories recursively to the metadata, use `crate.add_tree` instead of `crate.add_dataset` (but note that it only works on local directory trees).\n\nSome applications and services support RO-Crates stored as archives. To save the crate in zip format, use `write_zip`:\n\n```python\ncrate.write_zip(\"exp_crate.zip\")\n```\n\n#### Appending elements to property values\n\nWhat ro-crate-py entities actually store is their JSON representation:\n\n```python\npaper.properties()\n```\n\n```json\n{\n \"@id\": \"paper.pdf\",\n \"@type\": \"File\",\n \"name\": \"manuscript\",\n \"encodingFormat\": \"application/pdf\",\n \"author\": [\n {\"@id\": \"https://orcid.org/0000-0000-0000-0000\"},\n {\"@id\": \"https://orcid.org/0000-0000-0000-0001\"},\n ]\n}\n```\n\nWhen `paper[\"author\"]` is accessed, a new list containing the `alice` and `bob` entities is generated on the fly. For this reason, calling `append` on `paper[\"author\"]` won't actually modify the `paper` entity in any way. To add an author, use the `append_to` method instead:\n\n```python\ndonald = crate.add(Person(crate, \"https://en.wikipedia.org/wiki/Donald_Duck\", properties={\n \"name\": \"Donald Duck\"\n}))\npaper.append_to(\"author\", donald)\n```\n\nNote that `append_to` also works if the property to be updated is missing or has only one value:\n\n```python\nfor n in \"Mickey_Mouse\", \"Scrooge_McDuck\":\n p = crate.add(Person(crate, f\"https://en.wikipedia.org/wiki/{n}\"))\n donald.append_to(\"follows\", p)\n```\n\n#### Adding remote entities\n\nData entities can also be remote:\n\n```python\ninput_data = crate.add_file(\"http://example.org/exp_data.zip\")\n```\n\nBy default the file won't be downloaded, and will be referenced by its URI in the serialized crate:\n\n```json\n{\n \"@id\": \"http://example.org/exp_data.zip\",\n \"@type\": \"File\"\n},\n```\n\nIf you add `fetch_remote=True` to the `add_file` call, however, the library (when `crate.write` is called) will try to download the file and include it in the output crate.\n\nAnother option that influences the behavior when dealing with remote entities is `validate_url`, also `False` by default: if it's set to `True`, when the crate is serialized, the library will try to open the URL to add / update metadata bits such as the content's length and format (but it won't try to download the file unless `fetch_remote` is also set).\n\n#### Adding entities with an arbitrary type\n\nAn entity can be of any type listed in the [RO-Crate context](https://www.researchobject.org/ro-crate/1.1/context.jsonld). However, only a few of them have a counterpart (e.g., `File`) in the library's class hierarchy (either because they are very common or because they are associated with specific functionality that can be conveniently embedded in the class implementation). In other cases, you can explicitly pass the type via the `properties` argument:\n\n```python\nfrom rocrate.model.contextentity import ContextEntity\n\nhackathon = crate.add(ContextEntity(crate, \"#bh2021\", properties={\n \"@type\": \"Hackathon\",\n \"name\": \"Biohackathon 2021\",\n \"location\": \"Barcelona, Spain\",\n \"startDate\": \"2021-11-08\",\n \"endDate\": \"2021-11-12\"\n}))\n```\n\nNote that entities can have multiple types, e.g.:\n\n```python\n \"@type\" = [\"File\", \"SoftwareSourceCode\"]\n```\n\n### Consuming an RO-Crate\n\nAn existing RO-Crate package can be loaded from a directory or zip file:\n\n```python\ncrate = ROCrate('exp_crate') # or ROCrate('exp_crate.zip')\nfor e in crate.get_entities():\n print(e.id, e.type)\n```\n\n```\n./ Dataset\nro-crate-metadata.json CreativeWork\npaper.pdf File\nresults.csv File\nimages/figure.svg File\nhttps://orcid.org/0000-0000-0000-0000 Person\nhttps://orcid.org/0000-0000-0000-0001 Person\n```\n\nThe first two entities shown in the output are the [root data entity](https://www.researchobject.org/ro-crate/1.1/root-data-entity.html) and the [metadata file descriptor](https://www.researchobject.org/ro-crate/1.1/metadata.html), respectively. The former represents the whole crate, while the latter represents the metadata file. These are special entities managed by the `ROCrate` object, and are always present. The other entities are the ones we added in the [section on RO-Crate creation](#creating-an-ro-crate).\n\nAs shown above, `get_entities` allows to iterate over all entities in the crate. You can also access only data entities with `crate.data_entities` and only contextual entities with `crate.contextual_entities`. For instance:\n\n```python\nfor e in crate.data_entities:\n author = e.get(\"author\")\n if not author:\n continue\n elif isinstance(author, list):\n print(e.id, [p[\"name\"] for p in author])\n else:\n print(e.id, repr(author[\"name\"]))\n```\n\n```\npaper.pdf ['Alice Doe', 'Bob Doe']\nresults.csv 'Alice Doe'\nimages/figure.svg 'Bob Doe'\n```\n\nYou can fetch an entity by its `@id` as follows:\n\n```python\narticle = crate.dereference(\"paper.pdf\")\n```\n\n## Advanced features\n\n### Modifying the crate from JSON-LD dictionaries\n\nThe `add_jsonld` method allows to add a contextual entity directly from a\nJSON-LD dictionary containing at least the `@id` and `@type` keys:\n\n```python\ncrate.add_jsonld({\n \"@id\": \"https://orcid.org/0000-0000-0000-0000\",\n \"@type\": \"Person\",\n \"name\": \"Alice Doe\"\n})\n```\n\nExisting entities can be updated from JSON-LD dictionaries via `update_jsonld`:\n\n```python\ncrate.update_jsonld({\n \"@id\": \"https://orcid.org/0000-0000-0000-0000\",\n \"name\": \"Alice K. Doe\"\n})\n```\n\nThere is also an `add_or_update_jsonld` method that adds the entity if it's\nnot already in the crate and updates it if it already exists (note that, when\nupdating, the `@type` key is ignored). This allows to \"patch\" an RO-Crate from\na JSON-LD file. For instance, suppose you have the following `patch.json` file:\n\n```json\n{\n \"@graph\": [\n {\n \"@id\": \"./\",\n \"author\": {\"@id\": \"https://orcid.org/0000-0000-0000-0001\"}\n },\n {\n \"@id\": \"https://orcid.org/0000-0000-0000-0001\",\n \"@type\": \"Person\",\n \"name\": \"Bob Doe\"\n }\n ]\n}\n```\n\nThen the following sets Bob as the author of the crate according to the above\nfile:\n\n```python\ncrate = ROCrate(\"temp-crate\")\nwith open(\"patch.json\") as f:\n json_data = json.load(f)\nfor d in json_data.get(\"@graph\", []):\n crate.add_or_update_jsonld(d)\n```\n\n## Command Line Interface\n\n`ro-crate-py` includes a hierarchical command line interface: the `rocrate` tool. `rocrate` is the top-level command, while specific functionalities are provided via sub-commands. Currently, the tool allows to initialize a directory tree as an RO-Crate (`rocrate init`) and to modify the metadata of an existing RO-Crate (`rocrate add`).\n\n```console\n$ rocrate --help\nUsage: rocrate [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n add\n init\n write-zip\n```\n\n### Crate initialization\n\nThe `rocrate init` command explores a directory tree and generates an RO-Crate metadata file (`ro-crate-metadata.json`) listing all files and directories as `File` and `Dataset` entities, respectively.\n\n```console\n$ rocrate init --help\nUsage: rocrate init [OPTIONS]\n\nOptions:\n --gen-preview Generate a HTML preview file for the crate.\n -e, --exclude NAME Exclude files or directories from the metadata file.\n NAME may be a single name or a comma-separated list of\n names.\n -c, --crate-dir PATH The path to the root data entity of the crate.\n Defaults to the current working directory.\n --help Show this message and exit.\n```\n\nThe command acts on the current directory, unless the `-c` option is specified. The metadata file is added (overwritten if present) to the directory at the top level, turning it into an RO-Crate.\n\n### Adding items to the crate\n\nThe `rocrate add` command allows to add file, datasets (directories), workflows and other entity types (currently [testing-related metadata](https://crs4.github.io/life_monitor/workflow_testing_ro_crate)) to an RO-Crate:\n\n```console\n$ rocrate add --help\nUsage: rocrate add [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n dataset\n file\n test-definition\n test-instance\n test-suite\n workflow\n```\n\nNote that data entities (e.g., workflows) must already be present in the directory tree: the effect of the command is to register them in the metadata file.\n\n### Example\n\n```bash\n# From the ro-crate-py repository root\ncd test/test-data/ro-crate-galaxy-sortchangecase\n```\n\nThis directory is already an RO-Crate. Delete the metadata file to get a plain directory tree:\n\n```bash\nrm ro-crate-metadata.json\n```\n\nNow the directory tree contains several files and directories, including a Galaxy workflow and a Planemo test file, but it's not an RO-Crate since there is no metadata file. Initialize the crate:\n\n```bash\nrocrate init\n```\n\nThis creates an `ro-crate-metadata.json` file that lists files and directories rooted at the current directory. Note that the Galaxy workflow is listed as a plain `File`:\n\n```json\n{\n \"@id\": \"sort-and-change-case.ga\",\n \"@type\": \"File\"\n}\n```\n\nTo register the workflow as a `ComputationalWorkflow`:\n\n```bash\nrocrate add workflow -l galaxy sort-and-change-case.ga\n```\n\nNow the workflow has a type of `[\"File\", \"SoftwareSourceCode\", \"ComputationalWorkflow\"]` and points to a `ComputerLanguage` entity that represents the Galaxy workflow language. Also, the workflow is listed as the crate's `mainEntity` (this is required by the [Workflow RO-Crate profile](https://w3id.org/workflowhub/workflow-ro-crate/1.0), a subtype of RO-Crate which provides extra specifications for workflow metadata).\n\nTo add [workflow testing metadata](https://crs4.github.io/life_monitor/workflow_testing_ro_crate) to the crate:\n\n```bash\nrocrate add test-suite -i '#test1'\nrocrate add test-instance '#test1' http://example.com -r jobs -i '#test1_1'\nrocrate add test-definition '#test1' test/test1/sort-and-change-case-test.yml -e planemo -v '>=0.70'\n```\n\nTo add files or directories after crate initialization:\n\n```bash\ncp ../sample_file.txt .\nrocrate add file sample_file.txt -P name=sample -P description=\"Sample file\"\ncp -r ../test_add_dir .\nrocrate add dataset test_add_dir\n```\n\nThe above example also shows how to set arbitrary properties for the entity with `-P`. This is supported by most `rocrate add` subcommands.\n\n```console\n$ rocrate add workflow --help\nUsage: rocrate add workflow [OPTIONS] PATH\n\nOptions:\n -l, --language [cwl|galaxy|knime|nextflow|snakemake|compss|autosubmit]\n The workflow language.\n -c, --crate-dir PATH The path to the root data entity of the\n crate. Defaults to the current working\n directory.\n -P, --property KEY=VALUE Add an additional property to the metadata\n for this entity. Can be used multiple times\n to set multiple properties.\n --help Show this message and exit.\n```\n\n## License\n\n* Copyright 2019-2024 The University of Manchester, UK\n* Copyright 2020-2024 Vlaams Instituut voor Biotechnologie (VIB), BE\n* Copyright 2020-2024 Barcelona Supercomputing Center (BSC), ES\n* Copyright 2020-2024 Center for Advanced Studies, Research and Development in Sardinia (CRS4), IT\n* Copyright 2022-2024 \u00c9cole Polytechnique F\u00e9d\u00e9rale de Lausanne, CH\n* Copyright 2024 Data Centre, SciLifeLab, SE\n* Copyright 2024 National Institute of Informatics (NII), JP\n\nLicensed under the\nApache License, version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>,\nsee the file `LICENSE.txt` for details.\n\n## Cite as\n\n[](https://zenodo.org/badge/latestdoi/216605684)\n\nThe above DOI corresponds to the latest versioned release as [published to Zenodo](https://zenodo.org/record/3956493), where you will find all earlier releases.\nTo cite `ro-crate-py` independent of version, use <https://doi.org/10.5281/zenodo.3956493>, which will always redirect to the latest release.\n\nYou may also be interested in the paper [Packaging research artefacts with RO-Crate](https://doi.org/10.3233/DS-210053).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "RO-Crate metadata generator/parser",
"version": "0.13.0",
"project_urls": {
"Download": "https://github.com/researchobject/ro-crate-py/archive/0.13.0.tar.gz",
"Homepage": "https://github.com/ResearchObject/ro-crate-py/"
},
"split_keywords": [
"researchobject",
"ro-crate",
"ro",
"metadata",
"jsonld"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8ade1663dccf38460d2d4bb7ee7552c18b55340d96db266fe22be2d1bf69e262",
"md5": "f6d115e0ab746a8cc69fd0d5a82c4c86",
"sha256": "268e00d2ffe589507fbb65c75458a09834b563fad295cbf6e53b6f3d031f3443"
},
"downloads": -1,
"filename": "rocrate-0.13.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6d115e0ab746a8cc69fd0d5a82c4c86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 332265,
"upload_time": "2024-12-20T14:20:32",
"upload_time_iso_8601": "2024-12-20T14:20:32.951973Z",
"url": "https://files.pythonhosted.org/packages/8a/de/1663dccf38460d2d4bb7ee7552c18b55340d96db266fe22be2d1bf69e262/rocrate-0.13.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e623f69edcd6193811e093b4245ae544e5da431e5d3dd4d56398b43054f078a7",
"md5": "da457285d3bc55ac2facf003317ebfcd",
"sha256": "4e67606965ed7a45c845222bbd60bdd766886e17f21d8b603e0ae68c8cc71f2a"
},
"downloads": -1,
"filename": "rocrate-0.13.0.tar.gz",
"has_sig": false,
"md5_digest": "da457285d3bc55ac2facf003317ebfcd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 304840,
"upload_time": "2024-12-20T14:20:35",
"upload_time_iso_8601": "2024-12-20T14:20:35.512373Z",
"url": "https://files.pythonhosted.org/packages/e6/23/f69edcd6193811e093b4245ae544e5da431e5d3dd4d56398b43054f078a7/rocrate-0.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 14:20:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ResearchObject",
"github_project": "ro-crate-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "arcp",
"specs": [
[
"==",
"0.2.1"
]
]
},
{
"name": "jinja2",
"specs": []
},
{
"name": "python-dateutil",
"specs": []
},
{
"name": "click",
"specs": []
}
],
"lcname": "rocrate"
}
