Linting your Kedro project¶
To follow these instructions, you will need to install the
pylint package, subject to GPL licence.
Note: This documentation is based on
Kedro 0.17.0, if you spot anything that is incorrect then please create an issue or pull request.
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> 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
cli.py in your project package directory:
@cli.command() def lint(): """Check the Python code quality.""" python_call("isort", ["-rc", "src/<your_project>", "src/tests"]) python_call("pylint", ["-j", "0", "src/<your_project>"]) 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