Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add selected add-ons to the created project's metadata #3129

Closed
ankatiyar opened this issue Oct 5, 2023 · 1 comment · Fixed by #3188
Closed

Add selected add-ons to the created project's metadata #3129

ankatiyar opened this issue Oct 5, 2023 · 1 comment · Fixed by #3188
Assignees
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@ankatiyar
Copy link
Contributor

ankatiyar commented Oct 5, 2023

Description

This is a follow up ticket for #2522
This can be done after the add-ons workflow is in its final iteration of design and implementation.
Once the user creates a new Kedro project with the project creation wizard or using the --addons flag. This information should be added to the user project's pyproject.toml

[tool.kedro]
package_name = "spaceflights"
project_name = "spaceflights"
project_version = "0.18.11"
add_ons = ["1,2,3"] #or ["Linting", "Documentation"] or ["1", "2", "3"] format can be decided later, in agreement with Design

This metadata can then me passed on to kedro-telemetry.

Context

Write up in the comment of the spike ticket #2522 (comment)

Possible Implementation

  • Decide on how to add the add ons to the metadata - Should it be a string, list, list of strings, written in number form or as words?

add_ons = ["1,2,3"] or ["Linting", "Documentation"] or ["1", "2", "3"] format can be decided later

This implementation has two things to be done -

  1. Make sure when project is created, add-ons is added to the project's pyproject.toml
  2. When project metadata is read, add-ons is allowed as a field. This change will go in kedro/framework/startup.py

Possible Alternatives

@ankatiyar ankatiyar added the Issue: Feature Request New feature or improvement to existing feature label Oct 5, 2023
@merelcht merelcht moved this to To Do in Kedro Framework Oct 16, 2023
@noklam noklam moved this from To Do to In Progress in Kedro Framework Oct 17, 2023
@noklam noklam linked a pull request Oct 17, 2023 that will close this issue
7 tasks
@noklam noklam moved this from In Progress to In Review in Kedro Framework Oct 20, 2023
@noklam noklam moved this from In Review to Done in Kedro Framework Oct 25, 2023
@merelcht
Copy link
Member

Completed in #3188

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue: Feature Request New feature or improvement to existing feature
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants