create_properties_script

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 🚧

create_properties_script(path: Path | None = None)

Create a properties script with default values.

If the script already exists, it will not be overwritten.

Parameters

path : Path | None = None

The path to the package folder. Defaults to the current working directory.

Returns

Path

The path to the newly created properties script.

Examples

import seedcase_sprout as sp

with sp.ExamplePackage():
    sp.create_properties_script()

PosixPath('/tmp/tmpak4xqamn/example-package/scripts/properties.py')