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

docs: add marimo usage to README #653

Merged
merged 1 commit into from
Nov 8, 2024

Conversation

akshayka
Copy link
Contributor

@akshayka akshayka commented Nov 6, 2024

This PR updates the English-language README with how to use Pygwalker in marimo.

Note that marimo patches pygwalker.walk to use pygwalker.api.marimo.walk, so pygwalker.walk(df) works in marimo. This was added in version 0.9.15 of marimo: marimo-team/marimo#2798

@ObservedObserver
Copy link
Member

Thank you for the patches. I'll merge the PR, but I want to keep the main README simple to avoid overwhelming readers with too much information. Our API and documentation follow a progressive design approach, providing only the essential details to start.

Since the official pygwalker documentation is not well-maintained, I'll merge this PR now. We'll update our official docs later, where Marimo will have its own dedicated page or section. After that, I'll create a simpler version of the main README.

@Haleshot Haleshot mentioned this pull request Nov 6, 2024
@akshayka
Copy link
Contributor Author

akshayka commented Nov 6, 2024

That makes sense to me. Thank you!

@ObservedObserver ObservedObserver merged commit 9aebec0 into Kanaries:main Nov 8, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants