Update on credentials.md

[jmnunezd]

Updating example code in credentials.md to make it usable when copy/pasting. Since as of now it will generate a TypeError

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

I was reading the docs on how to load credentials directly in code, I tried using the copy button and paste it in my local to test it.

The problem is that even if you change project_path you will still get an TypeError since Python won't allow to use "/" between two strings.

For example:
conf_path = str(project_path / settings.CONF_SOURCE) changing project_path:
conf_path = str("my_project_path" / "conf") <----- Will raise TypeError

Specifically:
TypeError: unsupported operand type(s) for /: 'str' and 'str'

Development notes

I changed the credentials.md from:

conf_path = str(project_path / settings.CONF_SOURCE)

To:
conf_path = f"{project_path}/{settings.CONF_SOURCE}"

Checklist

• Read the contributing guidelines
• [N/A] Opened this PR as a 'Draft Pull Request' if it is work-in-progress
• [N/A] Updated the documentation to reflect the code changes
• [N/A] Added a description of this change in the RELEASE.md file
• [N/A] Added tests to cover my changes

[astrojuanlu]

project_path needs to be assigned

[astrojuanlu]

The code snippet still fails because project_path is not defined, right?

[jmnunezd]

The code snippet still fails because project_path is not defined, right?

That's right! but again, I think the user should be able to manually give the path they want to use and assign it to project_path, does that makes sense? what would be the alternative?

[noklam]

@jmnunezd Late to this conversation - Maybe we should just keep it consistent with <project_root> to indicate that this is something user need to define themselve?

[stichbury]

It'd be great to get this in @jmnunezd as we are close to making a release and these changes have been on the cards a while. How can I help push it over the line? cc @astrojuanlu @noklam

[noklam]

@stichbury I think it's good to check our terminology, is it project_root or project_path? The code snippet here is not working because project_path does not exist. Would it be enough to change it to <project_root> to indicate that this is something user need to put in themselves since it is different for every case.

[stichbury]

@stichbury I think it's good to check our terminology, is it project_root or project_path? The code snippet here is not working because project_path does not exist. Would it be enough to change it to <project_root> to indicate that this is something user need to put in themselves since it is different for every case.

Thanks @noklam yes I agree. We use this term reasonably consistently and define it here https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html#terminology so I think we should change it (and maybe put a comment in the code to explain?

[astrojuanlu]

Thanks @jmnunezd for your patience and for kicking this off!

[astrojuanlu]

After merging this we should probably add a more practical example on how credentials are normally used, see also #2669 (and more broadly, #1646)