module_types

create.file.from.bytes

Documentation	Import a file from a byte array.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.filesystem.CreateFileFromBytesModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module.

deserialize.file

Documentation	Deserialize data to a 'file' value instance.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.filesystem.DeserializeFileModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. value_type string The value type of the actual (unserialized) value. ✓ target_profile string The profile name of the de-serialization result data. ✓ serialization_profile string The name of the serialization profile used to serialize the source value. ✓

deserialize.file_bundle

Documentation	Deserialize data to a 'file' value instance.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.filesystem.DeserializeFileBundleModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. value_type string The value type of the actual (unserialized) value. ✓ target_profile string The profile name of the de-serialization result data. ✓ serialization_profile string The name of the serialization profile used to serialize the source value. ✓

deserialize.from_json

Documentation	-- n/a --
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.serialization.DeserializeFromJsonModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. result_path anyOf: [{'type': 'string'}, {'type': 'null'}] The path of the result dictionary to return.

export.file

Documentation	Export files.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.filesystem.ExportFileModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. target_profile string The name of the target profile. Used to distinguish different target formats for the same data type. ✓ source_type string The type of the source data that is going to be exported. ✓

file_bundle.pick.file

Documentation	Pick a single file from a file_bundle value.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.filesystem.PickFileFromFileBundleModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module.

file_bundle.pick.sub_folder

Documentation	Pick a sub-folder from a file_bundle, resulting in a new file_bundle.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.filesystem.PickSubBundle
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module.

import.local.file

Documentation	Import a file from the local filesystem.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.filesystem.ImportLocalFileModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module.

import.local.file_bundle

Documentation	Import a folder (file_bundle) from the local filesystem.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.filesystem.ImportLocalFileBundleModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. include_file_types anyOf: [{'items': {'type': 'string'}, 'type': 'array'}, {'type': 'null'}] File types to include. Type is list of strings, which will be matched using 'endswith' test. exclude_file_types anyOf: [{'items': {'type': 'string'}, 'type': 'array'}, {'type': 'null'}] File types to exclude. Type is list of strings, which will be matched with the 'endswith' test.

load.bytes

Documentation	-- n/a --
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.serialization.LoadBytesModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. value_type string The value type of the actual (unserialized) value. ✓ target_profile string The profile name of the de-serialization result data. ✓ serialization_profile string The name of the serialization profile used to serialize the source value. ✓

load.internal_model

Documentation	-- n/a --
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.serialization.LoadInternalModel
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. value_type string The value type of the actual (unserialized) value. ✓ target_profile string The profile name of the de-serialization result data. ✓ serialization_profile string The name of the serialization profile used to serialize the source value. ✓

load.string

Documentation	-- n/a --
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.serialization.LoadStringModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. value_type string The value type of the actual (unserialized) value. ✓ target_profile string The profile name of the de-serialization result data. ✓ serialization_profile string The name of the serialization profile used to serialize the source value. ✓

mock

Documentation	-- n/a --
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.mock.MockKiaraModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. inputs_schema object The input fields and their types. ✓ outputs object The outputs fields of the operation, along with their types and mock data. title string The title of this operation. desc string A description of what this step does.

pipeline

Documentation	A utility module to run multiple connected inner-modules and present it as its own entity.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.pipeline.PipelineModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. pipeline_name string The name of this pipeline. ✓ steps array A list of steps/modules of this pipeline, and their connections. ✓ input_aliases object A map of input aliases, with the location of the input (in the format '[step_id].[input_field]') as key, and the pipeline input field name as value. ✓ output_aliases object A map of output aliases, with the location of the output (in the format '[step_id].[output_field]') as key, and the pipeline output field name as value. ✓ doc unknown Documentation about what the pipeline does. context object Metadata for this workflow.

pretty_print.any.value

Documentation	-- n/a --
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.pretty_print.PrettyPrintAnyValueModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. source_type string The value type of the source value. ✓ target_type string The value type of the rendered value. ✓

pretty_print.value

Documentation	-- n/a --
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.pretty_print.ValueTypePrettyPrintModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. source_type string The value type of the source value. ✓ target_type string The value type of the rendered value. ✓

render.value

Documentation	A module that uses render methods attached to DataType classes.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.render_value.ValueTypeRenderModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. source_type string The (kiara) data type to be rendered. ✓ target_type string The (kiara) data type of210 the rendered result. ✓

unpickle.value

Documentation	-- n/a --
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.serialization.UnpickleModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. value_type string The value type of the actual (unserialized) value. ✓ target_profile string The profile name of the de-serialization result data. ✓ serialization_profile string The name of the serialization profile used to serialize the source value. ✓

value.extract_metadata

Documentation	Base class to use when writing a module to extract metadata from a file. It's possible to use any arbitrary kiara module for this purpose, but sub-classing this makes it easier.
Author(s)	Markus Binsteiner <markus@frkl.dev>
Context	Tags Labels package References source_repo documentation
Python class	kiara.modules.included_core_modules.metadata.ExtractMetadataModule
Module config	Field Type Description Required Default constants object Value constants for this module. defaults object Value defaults for this module. data_type string The data type this module will be used for. ✓ kiara_model_id string The id of the kiara (metadata) model. ✓