diff --git a/docs/source/04_kedro_project_setup/02_configuration.md b/docs/source/04_kedro_project_setup/02_configuration.md index b83d75c1fa..5d5de691d0 100644 --- a/docs/source/04_kedro_project_setup/02_configuration.md +++ b/docs/source/04_kedro_project_setup/02_configuration.md @@ -3,7 +3,7 @@ This section contains detailed information about configuration, for which the relevant API documentation can be found in [kedro.config.ConfigLoader](/kedro.config.ConfigLoader) -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. ## Local and base configuration diff --git a/docs/source/05_data/01_data_catalog.md b/docs/source/05_data/01_data_catalog.md index bedb846016..80d8235adf 100644 --- a/docs/source/05_data/01_data_catalog.md +++ b/docs/source/05_data/01_data_catalog.md @@ -1,6 +1,6 @@ # The Data Catalog -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. This section introduces `catalog.yml`, the project-shareable Data Catalog. The file is located in `conf/base` and is a registry of all data sources available for use by a project; it manages loading and saving of data. diff --git a/docs/source/05_data/02_kedro_io.md b/docs/source/05_data/02_kedro_io.md index 869b55ec97..963a375734 100644 --- a/docs/source/05_data/02_kedro_io.md +++ b/docs/source/05_data/02_kedro_io.md @@ -3,7 +3,7 @@ In this tutorial, we cover advanced uses of the [Kedro IO](/kedro.io.rst) module to understand the underlying implementation. The relevant API documentation is [kedro.io.AbstractDataSet](/kedro.io.AbstractDataSet) and [kedro.io.DataSetError](/kedro.io.DataSetError). -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. ## Error handling diff --git a/docs/source/06_nodes_and_pipelines/01_nodes.md b/docs/source/06_nodes_and_pipelines/01_nodes.md index 6d36086a2c..4e970bae97 100644 --- a/docs/source/06_nodes_and_pipelines/01_nodes.md +++ b/docs/source/06_nodes_and_pipelines/01_nodes.md @@ -2,7 +2,7 @@ In this section we introduce the concept of a node, for which the relevant API documentation is [kedro.pipeline.node](/kedro.pipeline.node). -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. You will first need to import libraries from Kedro and other standard tools to run the code snippets demonstrated below. diff --git a/docs/source/06_nodes_and_pipelines/02_pipelines.md b/docs/source/06_nodes_and_pipelines/02_pipelines.md index f8653288ac..ad2e3233af 100644 --- a/docs/source/06_nodes_and_pipelines/02_pipelines.md +++ b/docs/source/06_nodes_and_pipelines/02_pipelines.md @@ -3,7 +3,7 @@ To benefit from Kedro's automatic dependency resolution, nodes can be chained in a [pipeline](/kedro.pipeline.Pipeline). A pipeline is a list of nodes that use a shared set of variables. -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. ## Building pipelines diff --git a/docs/source/07_extend_kedro/05_plugins.md b/docs/source/07_extend_kedro/05_plugins.md index be8b03fe45..5b68634f36 100644 --- a/docs/source/07_extend_kedro/05_plugins.md +++ b/docs/source/07_extend_kedro/05_plugins.md @@ -1,7 +1,7 @@ # Kedro plugins -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. Kedro plugins allow you to create new features for Kedro and inject additional commands into the CLI. Plugins are developed as separate Python packages that exist outside of any Kedro project. diff --git a/docs/source/08_logging/01_logging.md b/docs/source/08_logging/01_logging.md index a55ce24ff9..7b6787a0af 100644 --- a/docs/source/08_logging/01_logging.md +++ b/docs/source/08_logging/01_logging.md @@ -3,7 +3,7 @@ Kedro uses, and facilitates, the use of Python’s `logging` library by providing a default logging configuration. This can be found in `conf/base/logging.yml` in every project generated using Kedro’s CLI `kedro new` command. -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. ## Configure logging diff --git a/docs/source/08_logging/02_journal.md b/docs/source/08_logging/02_journal.md index 4f62d21fd7..ea956d2f4e 100644 --- a/docs/source/08_logging/02_journal.md +++ b/docs/source/08_logging/02_journal.md @@ -1,7 +1,7 @@ # Journal -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. ## Overview @@ -18,7 +18,7 @@ A context journal record captures all the necessary information to reproduce the "run_id": "2019-10-01T09.15.57.289Z", "project_path": "/src/kedro-tutorial", "env": "local", - "kedro_version": "0.16.4", + "kedro_version": "0.16.5", "tags": [], "from_nodes": [], "to_nodes": [], diff --git a/docs/source/09_development/01_set_up_vscode.md b/docs/source/09_development/01_set_up_vscode.md index 3ef3e31a93..7a4240656d 100644 --- a/docs/source/09_development/01_set_up_vscode.md +++ b/docs/source/09_development/01_set_up_vscode.md @@ -1,7 +1,7 @@ # Set up Visual Studio Code -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. Start by opening a new project directory in VS Code and installing the Python plugin under **Tools and languages**: diff --git a/docs/source/09_development/02_set_up_pycharm.md b/docs/source/09_development/02_set_up_pycharm.md index 9c7e962e4b..4584ead646 100644 --- a/docs/source/09_development/02_set_up_pycharm.md +++ b/docs/source/09_development/02_set_up_pycharm.md @@ -1,6 +1,6 @@ # Set up PyCharm -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. This section will present a quick guide on how to configure [PyCharm](https://www.jetbrains.com/pycharm/) as a development environment for working on Kedro projects. diff --git a/docs/source/09_development/03_commands_reference.md b/docs/source/09_development/03_commands_reference.md index 76052b9ad9..62aee32623 100644 --- a/docs/source/09_development/03_commands_reference.md +++ b/docs/source/09_development/03_commands_reference.md @@ -1,6 +1,6 @@ # Kedro's command line interface -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. Kedro's command line interface (CLI) is used to give commands to Kedro via a terminal shell (such as the terminal app on macOS, or cmd.exe or PowerShell on Windows). You need to use the CLI to set up a new Kedro project, and to run it. @@ -115,7 +115,7 @@ Returns output similar to the following, depending on the version of Kedro used | |/ / _ \/ _` | '__/ _ \ | < __/ (_| | | | (_) | |_|\_\___|\__,_|_| \___/ -v0.16.4 +v0.16.5 kedro allows teams to create analytics projects. It is developed as part of diff --git a/docs/source/09_development/04_lint.md b/docs/source/09_development/04_lint.md index 61fbdd827d..ef73b6036b 100644 --- a/docs/source/09_development/04_lint.md +++ b/docs/source/09_development/04_lint.md @@ -2,7 +2,7 @@ To follow these instructions, you will need to install the `pylint` package, subject to GPL licence. -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. You can lint your project code to ensure code quality using the `kedro lint` command, your project is linted with [`black`](https://github.com/psf/black) (projects created with Python 3.6 and above), [`flake8`](https://gitlab.com/pycqa/flake8) and [`isort`](https://github.com/timothycrosley/isort). If you prefer to use [pylint](https://www.pylint.org/), a popular linting tool, then the sample commands you can use to help with this are included in the script below: diff --git a/docs/source/09_development/05_debugging.md b/docs/source/09_development/05_debugging.md index 4ad2fbee94..b96400ae66 100644 --- a/docs/source/09_development/05_debugging.md +++ b/docs/source/09_development/05_debugging.md @@ -1,6 +1,6 @@ # Debugging -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. ## Introduction diff --git a/docs/source/10_tools_integration/01_pyspark.md b/docs/source/10_tools_integration/01_pyspark.md index c9b07ca76f..d5e1d9045e 100644 --- a/docs/source/10_tools_integration/01_pyspark.md +++ b/docs/source/10_tools_integration/01_pyspark.md @@ -1,6 +1,6 @@ # Build a Kedro pipeline with PySpark -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. This page outlines some best practices when building a Kedro pipeline with [`PySpark`](https://spark.apache.org/docs/latest/api/python/index.html). It assumes a basic understanding of both Kedro and `PySpark`. diff --git a/docs/source/10_tools_integration/02_ipython.md b/docs/source/10_tools_integration/02_ipython.md index 1ebbd8ea2a..75f2818ce5 100644 --- a/docs/source/10_tools_integration/02_ipython.md +++ b/docs/source/10_tools_integration/02_ipython.md @@ -1,6 +1,6 @@ # Use Kedro with IPython and Jupyter Notebooks/Lab -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. This section follows the [Iris dataset example](../02_get_started/05_example_project.md) and demonstrates how to effectively use IPython and Jupyter Notebooks / Lab. diff --git a/docs/source/10_tools_integration/03_databricks.md b/docs/source/10_tools_integration/03_databricks.md index 33447625db..ef440c2aab 100644 --- a/docs/source/10_tools_integration/03_databricks.md +++ b/docs/source/10_tools_integration/03_databricks.md @@ -1,7 +1,7 @@ # How to use Kedro on a Databricks cluster -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. We recommend that you use [Databricks Connect](https://pypi.org/project/databricks-connect/) to execute your Kedro pipeline on a Databricks cluster. diff --git a/docs/source/11_faq/02_architecture_overview.md b/docs/source/11_faq/02_architecture_overview.md index f4521e379a..291ae3d21b 100644 --- a/docs/source/11_faq/02_architecture_overview.md +++ b/docs/source/11_faq/02_architecture_overview.md @@ -1,7 +1,7 @@ # Kedro architecture overview -> *Note:* This documentation is based on `Kedro 0.16.4`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. +> *Note:* This documentation is based on `Kedro 0.16.5`, if you spot anything that is incorrect then please create an [issue](https://github.com/quantumblacklabs/kedro/issues) or pull request. Here is a diagram showing high-level architecture of Kedro library: diff --git a/kedro/__init__.py b/kedro/__init__.py index 9fd2bae9f0..76bbf73291 100644 --- a/kedro/__init__.py +++ b/kedro/__init__.py @@ -31,7 +31,7 @@ configuration and pipeline assembly. """ -__version__ = "0.16.4" +__version__ = "0.16.5" import logging