write_properties
Warning
🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧
write_properties(properties: PackageProperties, path: Path | None = None)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 : PackageProperties-
The properties to write. Use
create_properties_script()to create a file with your properties object. path : Path | None = None-
A
Pathto thedatapackage.jsonfile.
Returns
Path-
The path to the updated
datapackage.jsonfile.
Raises
ExceptionGroup-
If there is an error in the properties. A group of
CheckErrors, one error for each failed check.