check_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 🚧

check_properties(properties: PackageProperties)

Check that all properties match Sprout’s requirements.

If the resources property hasn’t been filled in yet, this will only check the package properties. The properties are checked against the Data Package standard and the following Sprout-specific requirements:

• Sprout-specific required fields are present
• Required fields are not blank

If the resources property has been filled in, these resource properties will also be checked:

• path is of type string.
• path includes resource name.
• data is not set.

Parameters

properties : PackageProperties

The properties to check.

Returns

PackageProperties

The properties if all checks pass.

Raises

ExceptionGroup

A group of CheckErrors, one error per failed check.