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 🚧

core.create_resource_structure

core.create_resource_structure

Functions

Name Description
create_resource_structure Create the directory structure of a new resource.

create_resource_structure

core.create_resource_structure.create_resource_structure(path)

Create the directory structure of a new resource.

This is the first function to use to set up the structure for a data resource. It creates the paths for a new data resource in a specific (existing) package by creating the folder setup described in the Outputs section on the Sprout website. Use the path_resources() function to provide the correct path location.

Parameters

path : Path

Path to the resources directory in a package.

Returns

: list[Path]

A list of the two created directories: - A path to the resource directory and - A path to the raw data directory.

Raises

: NotADirectoryError

If path is not an existing directory.