Linting your Kedro project¶
Note: This documentation is based on
Kedro 0.16.1, if you spot anything that is incorrect then please create an issue or pull request.
Note: The following suggestions would require installing the
pylintpackage, subject to GPL licence.
You can lint your project code to ensure code quality using the
kedro lint command, your project is linted with
black (projects created with Python 3.6 and above),
isort. If you prefer to use pylint, a popular linting tool, then the sample commands you can use to help with this are included in the script below:
isort pylint -j 0 src/<your_project> kedro_cli.py pylint -j 0 --disable=missing-docstring,redefined-outer-name src/tests
Alternatively, you can opt to use it as a plugin to your Kedro project. To do this, add the following code snippet to
kedro_cli.py in your project root directory:
@cli.command() def lint(): """Check the Python code quality.""" python_call("isort", ["-rc", "src/<your_project>", "src/tests", "kedro_cli.py"]) python_call("pylint", ["-j", "0", "src/<your_project>", "kedro_cli.py"]) python_call( "pylint", ["-j", "0", "--disable=missing-docstring,redefined-outer-name", "src/tests"], )
To trigger the behaviour, simply run the following command in your terminal window:
Make sure you also include the dependency in your