API Reference

Functions

Core functions used to check Data Packages.

check Checks a Data Package’s properties against the Data Package standard.
read_json Reads datapackage.json into a Python dictionary.

Configuration

Classes to configure behaviour of the checks.

Config Configuration for checking a Data Package descriptor.
Extensions Extensions to the standard checks.
CustomCheck A custom check to be done on Data Package metadata.
RequiredCheck Set a specific property as required.
Exclusion A check to be excluded when checking properties.

Output

Classes that contain details about the output.

Issue An issue found while checking a Data Package descriptor.

Examples

Example Data Package properties used for documents and testing.

example_package_properties Create a set of example package properties.
example_resource_properties Create a set of example resource properties.
example_field_properties Create a set of example field properties.