Request documentation on best practises when debugging kedro cli commands in a pycharm environment

Introduction

I am trying to generate a project using kedro new --starter and see a cookiecutter error that I would like to investigate in more detail by stepping through the code line by line

Background

Being able to step inside the code is invaluable for better understand the error.

Problem

There’s a lot of code to work through to get to the core functionality that actually creates the new project repo using the commands we pass on the cli. I’m unable to access those functions directly because then a number of initialization steps are not present. For example, context is missing, so on.

[AntonyMilneQB]

Hi @roumail, I’ve reworked the implementation of kedro new --starter quite a bit recently so would be curious to hear what the problem is here. To debug it while developing, my approach is to set up a run configuration as per this guide to run kedro new --starter. You can put PyCharm breakpoints in the source code of kedro in site-packages and it should still work. Alternatively, if you want to have it more easily accessible you can pip install kedro --target=. --no-deps to install it into your current working directory rather than site-packages.

To get started you’ll want to put your first breakpoint in kedro.framework.cli.starters.new, which is the function that gets called when kedro new is executed. Let me know if you need a hand following the flow after that - I know it well since I just rewrote lots of it.

[datajoely]

Hi @roumail do you want to join us on Discord and it will be easier to debug? https://discord.gg/akJDeVaxnB