Utils

composapy.utils.file_ref(path: str | Path) → FileReference

Returns a CompAnalytics.Contracts.FileReference object, which can then be passed as the external input of a DataFlow.

from composapy import file_ref
from composapy.dataflow.api import DataFlow
_ref = file_ref("path/to/file.txt")
dataflow_run = DataFlow.run(123456, external_inputs={"foo_ref": _ref})

Parameters:

path – location of the file to make a file reference for

Returns:

the FileReference contract