soso¶
Release v1.1.0. (Installation)
For converting dataset metadata into Science On Schema.Org markup.
Installation
Install from PyPI:
$ pip install soso
Metadata Conversion
To perform a conversion, specify the file path of the metadata and the desired conversion strategy. Each metadata standard corresponds to a specific strategy.
>>> from soso.main import convert
>>> r = convert(file='metadata.xml', strategy='EML')
>>> r
'{"@context": ["https://schema.org/", {"prov": "http://www. ..."}]'
For a list of available strategies, please refer to the documentation of the convert function.
Adding Unmappable Properties
Some SOSO properties may not be derived from metadata records alone. In such cases, additional information can be provided via kwargs, where keys match the top level property name, and values are the property value.
For example, the url property representing the landing page URL does not exist in an EML metadata record. But this information is known to the repository hosting the dataset.
>>> kwargs = {'url': 'https://sample-data-repository.org/dataset/472032'}
>>> r = convert(file='metadata.xml', strategy='EML', **kwargs)
>>> r
'{"@context": ["https://schema.org/", {"prov": "http://www. ..."}]'
It’s worth noting that this kwargs approach is not limited to supplying unmappable properties; it can be utilized to override any top-level SOSO property.
Unmappable properties are listed in the strategy documentation.
Other Modifications
Any additional modifications can be made to the resulting JSON-LD string before it is used. Simply parse the string into a Python dictionary, make the necessary changes, and then convert it back to a JSON-LD string.
Shared Conversion Scripts
When data repositories use a common metadata standard and adopt shared infrastructure, such as databases containing ancillary information, a shared conversion script can be used. These scripts reliably reference the shared infrastructure to create a richer SOSO record by incorporating this additional information. Below is a list of available scripts and their usage examples:
The User Guide¶
This part of the documentation begins with some background information about soso, then focuses on step-by-step instructions for getting the most out of it.
The API Documentation / Guide¶
If you are looking for information on a specific function, class, or method, this part of the documentation is for you.
The Contributor Guide¶
If you want to contribute to the project, this part of the documentation is for you.
The Maintainer Guide¶
If you are a project maintainer, this part of the documentation is for you.
Project Design¶
The project design documentation provides an overview of the project’s architecture and design decisions.
Code of Conduct¶
In the spirit of collaboration, we emphasize the importance of maintaining a respectful and inclusive environment.
See the Code of Conduct for details.
