kedro.framework.cli.project

module documentation
(source)

A collection of CLI commands for working with Kedro project.

Function activate_nbstripout Install the nbstripout git hook to automatically clean notebooks. (DEPRECATED)
Function build_docs Build the project documentation. (DEPRECATED)
Function build_reqs Run pip-compile on src/requirements.txt or the user defined input file and save the compiled requirements to src/requirements.lock or the user defined output file. (DEPRECATED)
Function ipython Open IPython with project specific variables loaded.
Function lint Run flake8, isort and black. (DEPRECATED)
Function package Package the project as a Python egg and wheel.
Function project_group Undocumented
Function run Run the pipeline.
Function test Run the test suite. (DEPRECATED)
Constant ASYNC_ARG_HELP Undocumented
Constant CONF_SOURCE_HELP Undocumented
Constant CONFIG_FILE_HELP Undocumented
Constant FROM_INPUTS_HELP Undocumented
Constant FROM_NODES_HELP Undocumented
Constant INPUT_FILE_HELP Undocumented
Constant LINT_CHECK_ONLY_HELP Undocumented
Constant LOAD_VERSION_HELP Undocumented
Constant NAMESPACE_ARG_HELP Undocumented
Constant NO_DEPENDENCY_MESSAGE Undocumented
Constant NODE_ARG_HELP Undocumented
Constant OPEN_ARG_HELP Undocumented
Constant OUTPUT_FILE_HELP Undocumented
Constant PARAMS_ARG_HELP Undocumented
Constant PIPELINE_ARG_HELP Undocumented
Constant RUNNER_ARG_HELP Undocumented
Constant TAG_ARG_HELP Undocumented
Constant TO_NODES_HELP Undocumented
Constant TO_OUTPUTS_HELP Undocumented
@command_with_verbosity(project_group, 'activate-nbstripout')
@click.pass_obj
def activate_nbstripout(metadata: ProjectMetadata, **kwargs): (source)

Install the nbstripout git hook to automatically clean notebooks. (DEPRECATED)

@project_group.command('build-docs')
@click.option('--open', '-o', 'open_docs', is_flag=True, multiple=False, default=False, help=OPEN_ARG_HELP)
@click.pass_obj
def build_docs(metadata: ProjectMetadata, open_docs): (source)

Build the project documentation. (DEPRECATED)

@forward_command(project_group, name='build-reqs')
@click.option('--input-file', 'input_file', type=click.Path(exists=True, dir_okay=False, resolve_path=True), multiple=False, help=INPUT_FILE_HELP)
@click.option('--output-file', 'output_file', multiple=False, help=OUTPUT_FILE_HELP)
@click.pass_obj
def build_reqs(metadata: ProjectMetadata, input_file, output_file, args, **kwargs): (source)

Run pip-compile on src/requirements.txt or the user defined input file and save the compiled requirements to src/requirements.lock or the user defined output file. (DEPRECATED)

@forward_command(project_group, forward_help=True)
@env_option
@click.pass_obj
def ipython(metadata: ProjectMetadata, env, args, **kwargs): (source)

Open IPython with project specific variables loaded.

@command_with_verbosity(project_group)
@click.option('-c', '--check-only', is_flag=True, help=LINT_CHECK_ONLY_HELP)
@click.argument('files', type=click.Path(exists=True), nargs=-1)
@click.pass_obj
def lint(metadata: ProjectMetadata, files, check_only, **kwargs): (source)

Run flake8, isort and black. (DEPRECATED)

@project_group.command()
@click.pass_obj
def package(metadata: ProjectMetadata): (source)

Package the project as a Python egg and wheel.

@click.group(name='Kedro')
def project_group(): (source)

Undocumented

@project_group.command()
@click.option('--from-inputs', type=str, default='', help=FROM_INPUTS_HELP, callback=split_string)
@click.option('--to-outputs', type=str, default='', help=TO_OUTPUTS_HELP, callback=split_string)
@click.option('--from-nodes', type=str, default='', help=FROM_NODES_HELP, callback=split_node_names)
@click.option('--to-nodes', type=str, default='', help=TO_NODES_HELP, callback=split_node_names)
@click.option('--node', '-n', 'node_names', type=str, multiple=True, help=NODE_ARG_HELP, callback=_deprecate_options)
@click.option('--nodes', 'nodes_names', type=str, default='', help=NODE_ARG_HELP, callback=split_node_names)
@click.option('--runner', '-r', type=str, default=None, help=RUNNER_ARG_HELP)
@click.option('--async', 'is_async', is_flag=True, help=ASYNC_ARG_HELP)
@env_option
@click.option('--tag', '-t', type=str, multiple=True, help=TAG_ARG_HELP, callback=_deprecate_options)
@click.option('--tags', type=str, default='', help=TAG_ARG_HELP, callback=split_string)
@click.option('--load-version', '-lv', type=str, multiple=True, help=LOAD_VERSION_HELP, callback=_reformat_load_versions)
@click.option('--load-versions', type=str, default='', help=LOAD_VERSION_HELP, callback=_split_load_versions)
@click.option('--pipeline', '-p', type=str, default=None, help=PIPELINE_ARG_HELP)
@click.option('--namespace', '-ns', type=str, default=None, help=NAMESPACE_ARG_HELP)
@click.option('--config', '-c', type=click.Path(exists=True, dir_okay=False, resolve_path=True), help=CONFIG_FILE_HELP, callback=_config_file_callback)
@click.option('--conf-source', type=click.Path(exists=True, file_okay=False, resolve_path=True), help=CONF_SOURCE_HELP)
@click.option('--params', type=click.UNPROCESSED, default='', help=PARAMS_ARG_HELP, callback=_split_params)
def run(tag, tags, env, runner, is_async, node_names, nodes_names, to_nodes, from_nodes, from_inputs, to_outputs, load_version, load_versions, pipeline, config, conf_source, params, namespace): (source)

Run the pipeline.

@forward_command(project_group, forward_help=True)
@click.pass_obj
def test(metadata: ProjectMetadata, args, **kwargs): (source)

Run the test suite. (DEPRECATED)

ASYNC_ARG_HELP: str = (source)

Undocumented

Value
'''Load and save node inputs and outputs asynchronously
with threads. If not specified, load and save datasets synchronously.'''
CONF_SOURCE_HELP: str = (source)

Undocumented

Value
'Path of a directory where project configuration is stored.'
CONFIG_FILE_HELP: str = (source)

Undocumented

Value
'''Specify a YAML configuration file to load the run
command arguments from. If command line arguments are provided, they will
override the loaded ones.'''
FROM_INPUTS_HELP: str = (source)

Undocumented

Value
'A list of dataset names which should be used as a starting point.'
FROM_NODES_HELP: str = (source)

Undocumented

Value
'A list of node names which should be used as a starting point.'
INPUT_FILE_HELP: str = (source)

Undocumented

Value
'Name of the requirements file to compile.'
LINT_CHECK_ONLY_HELP: str = (source)

Undocumented

Value
'''Check the files for style guide violations, unsorted /
unformatted imports, and unblackened Python code without modifying the files.'''
LOAD_VERSION_HELP: str = (source)

Undocumented

Value
'Specify a particular dataset version (timestamp) for loading.'
NAMESPACE_ARG_HELP: str = (source)

Undocumented

Value
'Name of the node namespace to run.'
NO_DEPENDENCY_MESSAGE: str = (source)

Undocumented

Value
'''{module} is not installed. Please make sure {module} is in
{src}/requirements.txt and run \'pip install -r src/requirements.txt\'.'''
NODE_ARG_HELP: str = (source)

Undocumented

Value
'Run only nodes with specified names.'
OPEN_ARG_HELP: str = (source)

Undocumented

Value
'Open the documentation in your default browser after building.'
OUTPUT_FILE_HELP: str = (source)

Undocumented

Value
'Name of the file where compiled requirements should be stored.'
PARAMS_ARG_HELP: str = (source)

Undocumented

Value
'''Specify extra parameters that you want to pass
to the context initialiser. Items must be separated by comma, keys - by colon or↵
 equals sign,
example: param1=value1,param2=value2. Each parameter is split by the first comma↵
,
so parameter values are allowed to contain colons, parameter keys are not.
To pass a nested dictionary as parameter, separate keys by \'.\', example:
...
PIPELINE_ARG_HELP: str = (source)

Undocumented

Value
'''Name of the registered pipeline to run.
If not set, the \'__default__\' pipeline is run.'''
RUNNER_ARG_HELP: str = (source)

Undocumented

Value
'''Specify a runner that you want to run the pipeline with.
Available runners: \'SequentialRunner\', \'ParallelRunner\' and \'ThreadRun\'.'''
TAG_ARG_HELP: str = (source)

Undocumented

Value
'''Construct the pipeline using only nodes which have this tag
attached. Option can be used multiple times, what results in a
pipeline constructed from nodes having any of those tags.'''
TO_NODES_HELP: str = (source)

Undocumented

Value
'A list of node names which should be used as an end point.'
TO_OUTPUTS_HELP: str = (source)

Undocumented

Value
'A list of dataset names which should be used as an end point.'