def
run_project
cauldron.run_project()

Runs a project as a single command directly within the current Python interpreter.

Arguments
Required
Optional
project_directory

str

The fully-qualified path to the directory where the Cauldron project is located

output_directory

str

The fully-qualified path to the directory where the results will be written. All of the results files will be written within this directory. If the directory does not exist, it will be created.

Default Value: 

None

logging_path

str

The fully-qualified path to a file that will be used for logging. If a directory is specified instead of a file, a file will be created using the default filename of cauldron_run.log. If a file already exists at that location it will be removed and a new file created in its place.

Default Value: 

None

reader_path

str

Specifies a path where a reader file will be saved after the project has finished running. If no path is specified, no reader file will be saved. If the path is a directory, a reader file will be saved in that directory with the project name as the file name.

Default Value: 

None

kwargs

Any

Any variables to be available in the cauldron.shared object during execution of the project can be specified here as keyword arguments.

Default Value: 

dict

Returns

Response

A response object that contains information about the run process.