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.

Sign up for GitHub

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

Jump to bottom

docs(bindings/python): ipynb examples for users #2061

Merged
merged 3 commits into from
Apr 22, 2023
Merged

docs(bindings/python): ipynb examples for users #2061

merged 3 commits into from
Apr 22, 2023

Conversation

Justin-Xiang
Copy link
Contributor

Fix #1835

@Justin-Xiang Justin-Xiang requested a review from messense as a code owner April 21, 2023 17:00
@Xuanwo Xuanwo changed the title Add: ipynb examples for users docs(bindings/python): ipynb examples for users Apr 22, 2023
@Xuanwo
Copy link
Member

Xuanwo commented Apr 22, 2023 •
edited
Loading

image

Seems we need to run pip install opendal first.

This example could be run at https://colab.research.google.com/github/Justin-Xiang/incubator-opendal/blob/add-ipynb-example/bindings/python/examples/object.ipynb

And I think we can remove the async main() so that we can run the example diectly.

image

image

And it's better to use print directly, becuase most service won't output stderr by default.

@Justin-Xiang
Copy link
Contributor Author

@Xuanwo I have made the modifications. I use logging and async because the example here did so, so I want to be consistent.

@Xuanwo
Copy link
Member

Xuanwo commented Apr 22, 2023

Maybe we should split pip install in a new cell?

@Justin-Xiang
Copy link
Contributor Author

@Xuanwo Sure, that's much better.

Xuanwo
Xuanwo approved these changes Apr 22, 2023
View reviewed changes
Copy link
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks a lot!

@Xuanwo Xuanwo merged commit fe92691 into apache:main Apr 22, 2023
@Xuanwo Xuanwo mentioned this pull request Apr 23, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Xuanwo Xuanwo Xuanwo approved these changes

@messense messense Awaiting requested review from messense messense is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

bindings/python: Add ipynb examples for users to get started in a click
2 participants
@Justin-Xiang @Xuanwo