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

Make settings.py optional #3050

Closed
noklam opened this issue Sep 19, 2023 · 4 comments · Fixed by #3163
Closed

Make settings.py optional #3050

noklam opened this issue Sep 19, 2023 · 4 comments · Fixed by #3163
Assignees
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@noklam
Copy link
Contributor

noklam commented Sep 19, 2023

Description

Currently settings.py must be provided for a Kedro Project. kedro new always ship a settings.py with commented default. We should update the functionality so that when a user deleted settings.py, kedro run still works.

Context

Reduce assumptions of what makes a "Kedro Project". Since the file by default doesn't do anything, we shouldn't enforce user to have it if they don't need to customise settings.

In addition, we can discuss whether we should allow user to customise where Kedro search for the "settings.py".

Implementation

This should be backwards compatible and a non-breaking change, so kedro should work with or without a settings.py file.

@noklam noklam added the Issue: Feature Request New feature or improvement to existing feature label Sep 19, 2023
@astrojuanlu
Copy link
Member

+1, creating an empty settings.py always feels like a burden.

This nudges Kedro more towards "convention over configuration", which might be a philosophical change we might want to discuss.

@miguel-ortiz-marin
Copy link
Contributor

I have an idea around it! Can I please be assigned to it?

@astrojuanlu
Copy link
Member

Hi @miguel-ortiz-marin, feel welcome to work on it! We don't assign issues to external contributors, just share the idea with us or better yet, open a PR directly :) If you need any help, let us know.

@miguel-ortiz-marin
Copy link
Contributor

Hi @astrojuanlu. Awesome! I opened a draft PR, I still have to update some comments and go through all the PR checklist but the core functionality is there!.

Happy Hacktoberfest 👻

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
None yet
Development

Successfully merging a pull request may close this issue.

4 participants