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 🚧

Function reference

Core functions

Data package functions

Functions to work with and manage data packages, but not the data resources within them.

core.create_package_structure
core.edit_package_properties

Data resource functions

Functions to work with and manage data resources found within a data package.

core.write_resource_properties
core.create_resource_properties
core.create_resource_structure

Property dataclasses

Dataclasses that support creating correct data package properties.

core.ConstraintsProperties	A class that expresses constraints for validating field values.
core.ContributorProperties	The people or organizations who contributed to this data package.
core.FieldProperties	A field in a table schema.
core.LicenseProperties	The license(s) under which the package or resource is provided.
core.MissingValueProperties	Values that, when encountered in the source, should be considered as not present.
core.PackageProperties	A data package.
core.ReferenceProperties	The destination part of a foreign key.
core.ResourceProperties	A data resource.
core.SourceProperties	The raw sources for this data package.
core.TableDialectProperties	Table dialect describes how tabular data is stored in a file.
core.TableSchemaForeignKeyProperties	A foreign key in a table schema.
core.TableSchemaProperties	A table schema for a data resource.

Path functions

Functions to support providing the correct file paths to data package and data resource functions.

core.path_package	Gets the absolute path to the specific package folder.
core.path_package_database	Gets the absolute path to a given package’s SQL database.
core.path_package_properties	Gets the absolute path to a given package’s properties file.
core.path_packages	Gets the absolute path to the packages folder.
core.path_resource	Gets the absolute path to a given resource of a given package.
core.path_resource_data	Gets the absolute path to a given resource’s data (i.e., parquet) file.
core.path_resource_raw	Gets the absolute path to a given resource’s raw folder.
core.path_resource_raw_files	Gets the absolute path to the raw files of a resource.
core.path_resources	Gets the absolute path to resources of a given package.
core.path_sprout_root