diff --git a/docs/draft/installed-kedro-project.puml b/docs/draft/installed-kedro-project.puml deleted file mode 100644 index d2b768f36c..0000000000 --- a/docs/draft/installed-kedro-project.puml +++ /dev/null @@ -1,13 +0,0 @@ -@startuml -title "Installed Kedro project" - -participant "third-party Python script" as script -participant "Directory with Kedro conf/ in it" as curr_dir -participant "KedroSession" as session - -script->script: run third-party script -script->curr_dir: get path to the project config -script->session: create a session with Kedro project name and project config dir -session->run: run a pipeline and/or nodes - -@enduml diff --git a/docs/draft/kedro-ipython.puml b/docs/draft/kedro-ipython.puml deleted file mode 100644 index 2b51539a4b..0000000000 --- a/docs/draft/kedro-ipython.puml +++ /dev/null @@ -1,29 +0,0 @@ -@startuml -title "$ kedro ipython" - -participant "$ kedro ipython" as cli -participant "Environment variables" as env -participant "IPython" as ipython -participant "00-kedro-init.py\nreload_kedro" as entrypoint -participant "Hook manager" as hook_manager -participant "Kedro project directory" as project -participant "KedroSession" as session -participant "KedroContext" as context - -cli->cli: Check if IPython is importable -cli->env: Set IPYTHONDIR to metadata.project_path / ".ipython" -cli->env: Set KEDRO_ENV to the chosen Kedro environment -cli->cli: Print an info message -cli->ipython: Start ipython -ipython->entrypoint: load startup script -entrypoint->entrypoint: import Kedro -entrypoint->hook_manager: clear the hook manager -entrypoint->project: bootstrap the project -entrypoint->entrypoint: remove imported project package modules -entrypoint->session: create a KedroSession -entrypoint->session: activate the session -entrypoint->session: load KedroContext -entrypoint->context: get the data catalog -entrypoint->entrypoint: expose session, context and catalog variables -entrypoint->entrypoint: register reload_kedro line magic -@enduml diff --git a/docs/draft/kedro-no-project.puml b/docs/draft/kedro-no-project.puml deleted file mode 100644 index 2903487209..0000000000 --- a/docs/draft/kedro-no-project.puml +++ /dev/null @@ -1,21 +0,0 @@ -@startuml -title "$ kedro\ndirectory without Kedro project" - -participant "$ kedro" as kedro -participant "setup.py\nkedro = kedro.framework.cli:main" as entrypoint -participant "Kedro Plugins\nentry_point = kedro.init" as init_plugins -participant "Kedro CLI\nglobal commands\ninfo, new, docs, starter" as kedro_cli -participant "Kedro Plugins\nentry_point = kedro.global_commands" as global_plugins -participant "Current directory\npyproject.toml" as pyproject.toml -participant "Click" as click - - -kedro->entrypoint: Python calls this - -entrypoint->init_plugins: load and run all installed plugins -entrypoint->kedro_cli: collect built-in commands -entrypoint->global_plugins: load and collect global plugin commands -entrypoint->pyproject.toml: check current dir for a Kedro project -pyproject.toml-->>entrypoint: not found or missing [tool.kedro] -entrypoint->click: combine all command collections and run click -@enduml diff --git a/docs/draft/kedro-plugin.puml b/docs/draft/kedro-plugin.puml deleted file mode 100644 index cd4ca0a8d4..0000000000 --- a/docs/draft/kedro-plugin.puml +++ /dev/null @@ -1,15 +0,0 @@ -@startuml -title "$ kedro plugin" - -participant "$ kedro plugin" as cli -participant "See kedro-with-project.puml for details" as prelude -participant "Kedro Plugin\nentry_point = kedro.project_commands" as project_plugin -participant "Click context" as click -participant "KedroSession" as session - -cli->prelude: prepare click commands as prelude to this -prelude->project_plugin: execute plugin click command -project_plugin->click: get ProjectMetadata from the click context -project_plugin->project_plugin: plugin code -project_plugin->session: need to create KedroSession for all runtime config and info -@enduml diff --git a/docs/draft/kedro-run.puml b/docs/draft/kedro-run.puml deleted file mode 100644 index 5b70d14cf0..0000000000 --- a/docs/draft/kedro-run.puml +++ /dev/null @@ -1,26 +0,0 @@ -@startuml -title "$ kedro run" - -participant "$ kedro run" as cli -participant "See kedro-with-project.puml for details" as prelude -participant "Project directory\ncli.py" as project_cli -participant "KedroSession" as session -participant "KedroContext" as context -participant "Runner" as runner -participant "Hook manager" as hooks - -cli->prelude: prepare click commands as prelude to this -prelude->project_cli: run -project_cli->session: create KedroSession -session->session: run -session->session: load KedroContext -session->context: get the selected pipeline -context->context: filter the pipeline based on command line arguments -session->context: get catalog with load version / save version -session->runner: create runner -session->hooks: get hook manager -hooks->hooks: before_pipeline_run -runner->runner: run the filtered pipeline with the catalog -hooks->hooks: on_pipeline_error (if runner fails) -hooks->hooks: after_pipeline_run -@enduml diff --git a/docs/draft/kedro-with-project.puml b/docs/draft/kedro-with-project.puml deleted file mode 100644 index 6f0c21f3e9..0000000000 --- a/docs/draft/kedro-with-project.puml +++ /dev/null @@ -1,25 +0,0 @@ -@startuml -title "$ kedro\ndirectory without Kedro project" - -participant "$ kedro" as kedro -participant "setup.py\nkedro = kedro.framework.cli:main" as entrypoint -participant "Kedro Plugins\nentry_point = kedro.init" as init_plugins -participant "Kedro CLI\nglobal commands\ninfo, new, docs, starter" as kedro_cli -participant "Kedro Plugins\nentry_point = kedro.global_commands" as global_plugins -participant "Current directory\npyproject.toml" as pyproject.toml -participant "Kedro Plugins\nentry_point = kedro.project_commands" as project_plugins -participant "Current directory\nKedro Project: cli.py" as kedro_project -participant "Click" as click - - -kedro->entrypoint: Python calls this -entrypoint->init_plugins: load and run all installed -entrypoint->kedro_cli: collect built-in commands -entrypoint->global_plugins: load and collect global plugin commands -entrypoint->pyproject.toml: check current dir for a Kedro project -entrypoint->pyproject.toml: bootstrap the project -entrypoint->entrypoint: add project metadata to the click cli context -entrypoint->project_plugins: load and collect project plugin commands -entrypoint->kedro_project: load and collect project cli commands -entrypoint->click: combine all command collections and run click -@enduml diff --git a/docs/draft/python-m-project.puml b/docs/draft/python-m-project.puml deleted file mode 100644 index 3e8d042b6d..0000000000 --- a/docs/draft/python-m-project.puml +++ /dev/null @@ -1,12 +0,0 @@ -@startuml -title "$ \n$ python -m .run" - -participant "$ \n$ python -m " as cli -participant "setup.py\n = .~__main__" as entrypoint -participant "KedroSession" as session - -cli->entrypoint: Python calls the entrypoint -entrypoint->session: create session -session->session: run - -@enduml diff --git a/docs/source/hooks/index.md b/docs/source/hooks/index.md index 74f819c3e0..71bb1cf695 100644 --- a/docs/source/hooks/index.md +++ b/docs/source/hooks/index.md @@ -1,8 +1,5 @@ # Hooks - -## Introduction - Hooks are a mechanism to add extra behaviour to Kedro's main execution in an easy and consistent manner. Some examples might include: * Adding a log statement after the data catalog is loaded. diff --git a/docs/source/nodes_and_pipelines/run_a_pipeline.md b/docs/source/nodes_and_pipelines/run_a_pipeline.md index 4d7fa7804c..c9a9790302 100644 --- a/docs/source/nodes_and_pipelines/run_a_pipeline.md +++ b/docs/source/nodes_and_pipelines/run_a_pipeline.md @@ -48,8 +48,6 @@ kedro run --runner=ThreadRunner For more information on how to maximise concurrency when using Kedro with PySpark, please visit our guide on [how to build a Kedro pipeline with PySpark](../integrations/pyspark_integration.md). -hook_manager: PluginManager = None, - ## Custom runners If the built-in Kedro runners do not meet your requirements, you can also define your own runner within your project. For example, you may want to add a dry runner, which lists which nodes would be run without executing them: diff --git a/docs/source/tutorial/spaceflights_tutorial.md b/docs/source/tutorial/spaceflights_tutorial.md index 8ced829765..0a65d0369b 100644 --- a/docs/source/tutorial/spaceflights_tutorial.md +++ b/docs/source/tutorial/spaceflights_tutorial.md @@ -4,9 +4,6 @@ In this tutorial, we construct nodes and pipelines for a price-prediction model The tutorial takes approximately **30 minutes** to complete. You will work in the terminal and by inspecting project files in an IDE or text editor. There is no Jupyter notebook for the project. - -## Scenario - *It is 2160, and the space tourism industry is booming. Globally, thousands of space shuttle companies take tourists to the Moon and back. You have been able to source data that lists the amenities offered in each space shuttle, customer reviews, and company information.* ***Project***: *You want to construct a model that predicts the price for each trip to the Moon and the corresponding return flight.*