search

kedro-org / kedro

Kedro is a toolbox for production-ready data science. It uses software engineering best practices to help you create data engineering and data science pipelines that are reproducible, maintainable, and modular.
https://kedro.org
Apache License 2.0
9.47k stars 875 forks source link

Remove redundant cli tools code #3961

Closed merelcht closed 1 week ago

merelcht commented 1 week ago

Description

I came across tools/cli.py and after digging I don't think this is used anywhere.

It was originally added in https://github.com/McK-Private/private-kedro/pull/1266:

This PR was created to provide a pathway to generate the KedroCLIstructure as a map (or tree or similar) that can then be leveraged by

Docs
kedro-telemetry

Then about a month later the same code was copied over to kedro-telemetry: https://github.com/kedro-org/kedro-plugins/blob/main/kedro-telemetry/kedro_telemetry/masking.py#L18 and https://github.com/kedro-org/kedro-plugins/blob/main/kedro-telemetry/kedro_telemetry/masking.py#L73

I've searched for use of tools.cli in the Kedro repo but no results other than in the tests: https://github.com/search?q=org%3Akedro-org+%22from+tools.cli+import%22&type=code

Development notes

I've removed tools/cli.py and tools/test_cli.py.

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

merelcht commented 1 week ago

I thought it was used for something related to the --help command, but it seems to be just legacy code.

It took me a while to figure out what this was for, also because the location inside tools was a bit weird :sweat_smile: