https://github.com/adrhill/jupyterplutoconverter.jl
Jupyter notebook to Pluto converter.
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.4%) to scientific vocabulary
Keywords
Repository
Jupyter notebook to Pluto converter.
Basic Info
Statistics
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
- Releases: 0
Topics
Metadata Files
README.md
JupyterPlutoConverter.jl
Another Jupyter notebook to Pluto converter.
By using Pluto's Notebook and Cell structs, the core functionality of this package
is implemented in around 30 lines of code.
Installation
To install this package, open the Julia REPL and run:
julia
julia> ]add JupyterPlutoConverter
Getting started
This package currently supports one-way conversions from Jupyter to Pluto.
A single function jupyter2pluto is exported:
```julia
using JupyterPlutoConverter
Convert notebook:
jupyter2pluto("notebook.ipynb") # use default output filename "notebook.jl" jupyter2pluto("notebook.ipynb", "myplutonotebook.jl") # use custom output filename
Convert directory:
jupyter2pluto(".") # convert all Jupyter notebooks in current directory jupyter2pluto(".", recursive=true) # recursively look through subdirectories ```
The following keyword arguments can be specified:
| Name | Default | Description |
|:-----------------|:-----------|:-----------------------------------------------------------------------------------------------------------------|
| fold_md | true | If true, Markdown cells are folded, hiding their source. |
| wrap_block | false | If true, code cells with multiple lines of code are wrapped in begin ... end blocks. |
| overwrite | false | If true, files at the specified output path will be overwritten. |
| recursive | false | If true, applying jupyter2pluto to a directory will recursively look for Jupyter notebooks in sub-directories. |
| verbose | true | Toggle verbosity. |
| transform_code | identity | Transformation applied to code cells. Has to be a function that maps strings to strings. |
| transform_md | identity | Transformation applied to Markdown cells. Has to be a function that maps strings to strings. |
Caveats
As the Pluto.jl ⇆ Jupyter conversion notebook summarizes, all automatic conversions from Jupyter to Pluto have caveats:
Pluto is different from Jupyter in many ways - the conversion will not be perfect. Pluto has restrictions on what kind of code you can write (no multiple definitions, for example), and it can be frustrating to start out with a notebook that contains a lot of these 'reactivity errors'.
Try it out, but remember that it might be easier to start the Pluto notebook 'from scratch' and copy code cell-by-cell. Pluto is designed for a different style of writing - this will be difficult to appreciate when you start out with a Jupyter notebook.
Reactivity makes this process more fun than you might think!
Related works
- Pluto.jl ⇆ Jupyter conversion: Observable notebook by Fons. Converts both ways.
- Jupyter2Pluto.jl: Composes strings manually to construct Pluto notebooks. Converts both ways.
Owner
- Name: Adrian Hill
- Login: adrhill
- Kind: user
- Location: Berlin
- Company: TU Berlin
- Twitter: adr_hill
- Repositories: 11
- Profile: https://github.com/adrhill
PhD student @ TU Berlin
GitHub Events
Total
- Create event: 1
- Commit comment event: 1
- Issues event: 4
- Delete event: 1
- Issue comment event: 23
- Push event: 4
- Pull request event: 7
- Fork event: 1
Last Year
- Create event: 1
- Commit comment event: 1
- Issues event: 4
- Delete event: 1
- Issue comment event: 23
- Push event: 4
- Pull request event: 7
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Adrian Hill | a****l@m****g | 18 |
| Fons van der Plas | f****s@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 11
- Average time to close issues: 3 months
- Average time to close pull requests: about 5 hours
- Total issue authors: 3
- Total pull request authors: 2
- Average comments per issue: 1.75
- Average comments per pull request: 0.55
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 7
- Average time to close issues: N/A
- Average time to close pull requests: about 5 hours
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.57
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- contra-bit (3)
- fonsp (1)
- JuliaTagBot (1)
Pull Request Authors
- adrhill (6)
- fonsp (5)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- julia 3 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
juliahub.com: JupyterPlutoConverter
Jupyter notebook to Pluto converter.
- Documentation: https://docs.juliahub.com/General/JupyterPlutoConverter/stable/
- License: MIT
-
Latest release: 0.1.2
published 7 months ago