write_properties

write_properties(properties: SproutProperties, path: Path)

Write the properties to the datapackage.json file.

If the datapackage.json file already exists, it will be overwritten. If not, a new file will be created.

Parameters

properties : SproutProperties

The properties to write. Use the CLI command init-metadata to create a file with your properties object.

path : Path

A Path to the datapackage.json file.

Returns

Path

The path to the updated datapackage.json file.

Raises

ExceptionGroup

If there is an error in the properties. A group of CheckErrors, one error for each failed check.