Package Functions (autotransform.util.package)

Provides utility functions for traversing the overall package.

autotransform.util.package.get_config_dir() → str

Gets the directory where the configuration is stored.

Returns:

The directory where configuration is stored.

Return type:

str

autotransform.util.package.get_examples_dir() → str

Gets the directory where examples are located.

Returns:

The examples directory

Return type:

str

autotransform.util.package.get_package_dir() → Path

Gets the directory for the autotransform package

Returns:

The package’s directory.

Return type:

pathlib.Path

autotransform.util.package.get_path_as_str(path: Path) → str

Coverts a path to a string AutoTransform can use.

Parameters:

path (pathlib.Path) – The path to convert.

Returns:

The path as a string.

Return type:

str