Update README.md for installation latest Kedro #3589
Merged
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 Lam Chan <nok.lam.chan@quantumblack.com>
noklam
changed the title
stichbury
reviewed
Feb 2, 2024
stichbury
reviewed
Feb 2, 2024
README.md
Outdated
Comment on lines
42
to
46
| ``` | ||
| git clone git@github.com:kedro-org/kedro.git | ||
| cd kedro | ||
| pip install . | ||
| ``` |
There was a problem hiding this comment.
Can I suggest that you split this into two, so the git clone command, then the text "Change to the kedro directory and enter the following: pip install ."
stichbury
reviewed
Feb 2, 2024
stichbury
suggested changes
Feb 2, 2024
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
|
Thanks, add a sentence to explain why is it useful. |
astrojuanlu
reviewed
Feb 2, 2024
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
stichbury
reviewed
Feb 3, 2024
| @@ -37,6 +37,12 @@ conda install -c conda-forge kedro | |||
|
|
|||
| Our [Get Started guide](https://docs.kedro.org/en/stable/get_started/install.html) contains full installation instructions, and includes how to set up Python virtual environments. | |||
|
|
|||
| ### Installation from source | |||
| To access the latest Kedro version before its official release, install it from the `main` branch. | |||
| ``` | |||
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```bash |
stichbury
approved these changes
Feb 3, 2024
astrojuanlu
approved these changes
Feb 3, 2024
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
Add a section for installation from source. We used to have nightly build(?), this is mainly for advance user who are willing to try out the latest Kedro which is not released yet. It would be nice to have a section to point them to.
Development notes
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