🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧
Get the absolute path to a specific file or folder in a data package.
Use the functions in this class to get the absolute path to a specific file or folder in your data package. They are intended as convenience functions to provide you with easy and quick access to required files and folders within your data package. These functions have these characteristics in common:
Path object.path argument that defaults to the current working directory available from the base class.resource_name is given, an error message will include a list of all the actual resource_name’s for a specific package.Outputs a PackagePath object representing the structure of a data package.
path : Path | None = NoneProvide a path to the package directory. Defaults to the current working directory.
from pathlib import Path
import seedcase_sprout as sp
# With default path
sp.PackagePath().properties()
sp.PackagePath().readme()
# With custom path
my_path = Path("my/path")
sp.PackagePath(my_path).properties()
sp.PackagePath(my_path).readme()PosixPath('/home/runner/work/seedcase-sprout/seedcase-sprout/datapackage.json')PosixPath('/home/runner/work/seedcase-sprout/seedcase-sprout/README.md')PosixPath('my/path/datapackage.json')PosixPath('my/path/README.md')| Name | Description |
|---|---|
| properties | Path to the datapackage.json file. |
| properties_script | Path to the properties script. |
| readme | Path to the README.md file. |
| resource | Path to the specified resources/<name>/ folder. |
| resource_batch | Path to the specific resource’s batch/ folder. |
| resource_batch_files | Paths to all the files in the specific resource’s batch/ folder. |
| resource_data | Path to the specific resource’s data file. |
| resource_properties_script | Path to a specific resource’s resource properties script. |
| resources | Path to the resources/ folder. |
| root | Path to the root folder of the package. |
Path to the datapackage.json file.
Path to the properties script.
Path to the README.md file.
Path to the specified resources/<name>/ folder.
resource_name : strThe name of the resource. Use ResourceProperties.name to get the correct resource name.
Path to the specific resource’s batch/ folder.
resource_name : strThe name of the resource. Use ResourceProperties.name to get the correct resource name.
Paths to all the files in the specific resource’s batch/ folder.
resource_name : strThe name of the resource. Use ResourceProperties.name to get the correct resource name.
Path to the specific resource’s data file.
resource_name : strThe name of the resource. Use ResourceProperties.name to get the correct resource name.
Path to a specific resource’s resource properties script.
resource_name : str = ''The name of the resource.
Path to the resources/ folder.
Path to the root folder of the package.