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

Update docs about building plugins to use pyproject.toml instead of setup.py #3053

Closed
merelcht opened this issue Sep 20, 2023 · 9 comments
Closed
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@merelcht
Copy link
Member

merelcht commented Sep 20, 2023

Description

The docs about building plugins for Kedro still mentions setup.py. We should update that to use pyproject.toml instead.

Context

This is inline with making the python packaging/plugin flow up to date with the current industry standards.

@merelcht merelcht added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Sep 20, 2023
@astrojuanlu
Copy link
Member

Maybe remilestone to https://github.com/kedro-org/kedro/milestone/36?

Otherwise, for general doc improvements, I think we have #1539 (and a duplicate I opened, #2685)

@merelcht
Copy link
Member Author

That milestone is closed because the majority of the work is done. This could actually be a nice small ticket for Hacktoberfest.

@stichbury
Copy link
Contributor

Parent ticket #1539

@astrojuanlu astrojuanlu changed the title Update docs about building plugins Update docs about building plugins to use pyproject.toml instead of setup.py Sep 29, 2023
@abhishek-nigam
Copy link

Hi team at Kendo-Org, I would like to pick this up. Though I have about 4 years of experience in software engineering, I haven't really worked with medium-large Python projects. Also, this would be my first contribution in open-source projects, and I feel excited about it.

Shall I work on it? Thank you for building Kendro!

@astrojuanlu
Copy link
Member

Hi @abhishek-nigam , welcome! Of course - no need to assign the issue, feel free to send a pull request for it whenever you're ready

@stichbury
Copy link
Contributor

Hi @abhishek-nigam Just checking in to see how this is going for you? I've assigned you to it and marked as "In progress" but do let us know if you prefer to put it back in the backlog.

@abhishek-nigam
Copy link

Hi @stichbury ! The past week has been slightly hectic for me since I've been interviewing for jobs. Now, that I've made it past them, I am looking forward to starting with this task from Friday. I'll keep you posted about any questions that I have, my progress here.

@stichbury
Copy link
Contributor

Hi @abhishek-nigam I'm not sure if you've had any time to tackle this issue but today is the last day of October, so just in case you've the work ready to go, but not yet got it in to our queue, now's the time to do so 🏃 💨

@merelcht
Copy link
Member Author

merelcht commented Nov 3, 2023

I just realised this was already done as part of #3013. So I'll close this issue.

@merelcht merelcht closed this as completed Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Development

No branches or pull requests

4 participants