question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Should `kedro test` and `kedro lint` be deprecated?

See original GitHub issue

Investigate what the alternatives would be for users currently using kedro test and kedro lint. Write up a plan to deprecating kedro lint and kedro test (including how the users can “migrate” to these alternatives) or alternatively summarise why those commands shouldn’t be deprecated.

Also keep in mind that the alternatives should still make it possible to have a linted/testable Kedro template.

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:10 (10 by maintainers)

github_iconTop GitHub Comments

1reaction
jmholzercommented, Sep 14, 2022

In technical design (14/09/22) it was concluded that both commands should be deprecated. The following action items were agreed:

1 (#1619 and #1620). Short guides for linting and testing should be written and added to the docs. Depending on the traffic metrics for this part of the docs, a next step of creating either a lint / test starter* (see below) or a plugin will be considered. 2 (#1849). Explore whether the /tests folder and / or the linting configuration (requirements, config files) should be kept or dropped in the starters and / or template.

* @yetudada proposed moving the elements needed to add both commands to a starter project. This may provide significant advantages in ease of maintenance relative to the plugin option.

1reaction
yetudadacommented, Sep 7, 2022

This write-up and evaluation is stellar 🎉 An additional benefit is a simpler starter for new users.

If I quickly scan the documentation and starters it would mean that we would be making the following changes (if I haven’t forgotten anything):

  • Starters:
    • Remove setup.cfg
    • Edit pyproject.toml
    • Edit src/requirements.txt
  • Documentation:
    • Edits to anywhere where setup.cfg is mentioned like in the Project directory structure, the section on Astronomer, and the one on Starters
    • Add new sections on testing and linting, probably under Development or Tools integration

I like the documentation addition because in future, the section on testing could be expanded to cover #1271. I think @deepyaman’s comment is the only thing left to cover, which is how do we make sure that we deliver linted and tested starters to our users without those configuration files being present in the starters.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Linting your Kedro project — Kedro 0.17.5 documentation
You can lint your project code to ensure code quality using the kedro lint command, your project is linted with black (projects created...
Read more >
Kedro's command line interface - Read the Docs
This command will be deprecated from Kedro version 0.19.0. The following runs all pytest unit tests found in src/tests , including coverage (see...
Read more >
Linting your Kedro project — Kedro 0.17.3 documentation
You can lint your project code to ensure code quality using the kedro lint command, your project is linted with black (projects created...
Read more >
Frequently asked questions — Kedro 0.17.3 documentation
Important: The development version of Kedro is not guaranteed to be bug-free and/or compatible with any of the stable versions.
Read more >
Kedro's command line interface — Kedro 0.17.6 documentation
You need to use the CLI to set up a new Kedro project, and to run it. ... kedro test ... See our...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found