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

improvement: marimo export ipynb with outputs #3048

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

improvement: marimo export ipynb with outputs #3048

wants to merge 8 commits into from
+773 −42

Conversation

mscolnick
Copy link
Contributor

@mscolnick mscolnick commented Dec 3, 2024 •
edited by akshayka
Loading

📝 Summary

add --include-outputs for marimo export. The goal for this is to export to ipynb so they can be committed to git and viewable in GitHub. GitHub doesn't allow scripts/styles that are remote (they get sanitized), so web-components or widgets (including anywidgets) do not get shown.

Instead, we will output markdown as that will be best rendered in GitHub's notebook renderer.

e.g.

# with outputs
marimo export ipynb notebook.py -o notebook.ipynb --include-outputs
# without outputs (default)
marimo export ipynb notebook.py -o notebook.ipynb --no-include-outputs

@vercel Vercel
Copy link

vercel bot commented Dec 3, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marimo-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 4, 2024 9:27pm
marimo-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 4, 2024 9:27pm

@mscolnick mscolnick changed the title improvement: marimo convert ipynb with outputs improvement: marimo export ipynb with outputs Dec 3, 2024
mscolnick
mscolnick commented Dec 3, 2024
View reviewed changes
tests/_server/export/snapshots/notebook_with_outputs.ipynb.txt
@@ -0,0 +1,250 @@
{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://ipynb.js.org/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmarimo-team%2Fmarimo%2Fba4d7f8f0669da3c34a595a056c62239344505c8%2Ftests%2F_server%2Fexport%2Fsnapshots%2Fnotebook_with_outputs.ipynb.txt

@mscolnick mscolnick marked this pull request as ready for review December 3, 2024 21:22
akshayka
akshayka previously approved these changes Dec 4, 2024
View reviewed changes
Copy link
Contributor

@akshayka akshayka left a comment

Choose a reason for hiding this comment

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

Nice! Does this work with

  1. matplotlib plots
  2. plotly
  3. altair (looks like not yet?)

?

akshayka
akshayka reviewed Dec 4, 2024
View reviewed changes
Copy link
Contributor

@akshayka akshayka left a comment

Choose a reason for hiding this comment

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

Noticed the failing tests — let me know if help is needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akshayka akshayka akshayka left review comments

@dmadisetti dmadisetti Awaiting requested review from dmadisetti

At least 1 approving review is required to merge this pull request.

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

Successfully merging this pull request may close these issues.
2 participants
@mscolnick @akshayka