document workflow to incrementally create a Kedro project #4305
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
noklam
requested review from
yetudada,
astrojuanlu and
merelcht
as code owners
merelcht
reviewed
Nov 11, 2024
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
noklam
requested review from
ankatiyar
and removed request for
astrojuanlu and
yetudada
merelcht
approved these changes
Nov 15, 2024
ElenaKhaustova
approved these changes
Nov 15, 2024
| #### `settings.py` | ||
| The `settings.py` file is an important configuration file in a Kedro project that allows you to define various settings and hooks for your project. Here’s a breakdown of its purpose and functionality: | ||
| - Project Settings: This file is where you can configure project-wide settings, such as defining the logging level, setting environment variables, or specifying paths for data and outputs. | ||
| - Hooks Registration: You can register custom hooks in settings.py, which are functions that can be executed at specific points in the Kedro pipeline lifecycle (e.g., before or after a node runs). This is useful for adding additional functionality, such as logging or monitoring. |
There was a problem hiding this comment.
Suggested change
| - Hooks Registration: You can register custom hooks in settings.py, which are functions that can be executed at specific points in the Kedro pipeline lifecycle (e.g., before or after a node runs). This is useful for adding additional functionality, such as logging or monitoring. | |
| - Hooks Registration: You can register custom hooks in `settings.py`, which are functions that can be executed at specific points in the Kedro pipeline lifecycle (e.g., before or after a node runs). This is useful for adding additional functionality, such as logging or monitoring. |
ankatiyar
approved these changes
Nov 18, 2024
| @@ -0,0 +1,176 @@ | |||
| # Create a Minimal Kedro Project | |||
| This documentation aims to explain the essential components of a minimal Kedro project. The guide begins with a blank project and gradually introduces the necessary elements. While most users typically start with a [project template]((./new_project.md)) or adapt an existing Python project, this guide will help you understand the core concepts and how to customise them to suit your specific needs. | |||
There was a problem hiding this comment.
Suggested change
| This documentation aims to explain the essential components of a minimal Kedro project. The guide begins with a blank project and gradually introduces the necessary elements. While most users typically start with a [project template]((./new_project.md)) or adapt an existing Python project, this guide will help you understand the core concepts and how to customise them to suit your specific needs. | |
| This documentation aims to explain the essential components of a minimal Kedro project. The guide begins with a blank project and gradually introduces the necessary elements. While most users typically start with a [project template](./new_project.md) or adapt an existing Python project, this guide will help you understand the core concepts and how to customise them to suit your specific needs. |
I find the second sentence a bit confusing. Maybe it can be "Most users typically start with a project template or adapt an existing Python project. This guide will help you understand the core components of a Kedro project and how to customise them to suit your specific needs."
There was a problem hiding this comment.
I think the idea is that, starting with a blank project isn't something that most people would do, so the goal of this documentation focus on explains the concept, but not a step-by-step guide that one should follow in reality.
Maybe I should flip the sentence like this?
While most users typically start with a project template or adapt an existing Python project, this guide begins with a blank project and gradually introduces the necessary elements. This will help you understand the core concepts and how to customise them to suit your specific needs.
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
astrojuanlu
reviewed
Nov 19, 2024
Comment on lines
+88
to
+94
| ```toml | ||
| [tool.kedro] | ||
| package_name = "minikedro" | ||
| project_name = "minikedro" | ||
| kedro_init_version = "0.19.9" | ||
| source_dir = "." | ||
| ``` |
There was a problem hiding this comment.
Interesting, so the Python packaging metadata ([project] table) is not even needed?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Close #2512
Development notes
Review note:
I am not sure yet where to put this documentation. Although this looks like a "How-to" documentation, I think this guides serve the purpose of explaining "Why" rather than try to guide people to create a project like this. We don't have any documentation like this yet, maybe we need a new section?
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-byline 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
RELEASE.mdfile