Nbless: (de)construct, convert, execute, and prepare slides from Jupyter notebooks. #4
Description
Submitting Author: Name (@marskar)
Repository Link: https://github.com/marskar/nbless
Documentation Link: https://marskar.github.io/nbless/
PyPI Link: https://pypi.org/project/nbless/
- Paste the full DESCRIPTION file inside a code block below:
The Nbless Python package allows you to
- (de)construct,
- convert,
- execute, and
- prepare slides from Jupyter notebooks.
The Nbless Python package consists of 6 Python functions and shell commands:
- nbconv, which converts a notebook into various formats.
- nbdeck, which prepares a notebook to be viewed as or converted into slides.
- nbexec, which runs a notebook from top to bottom and saves an executed version.
- nbless, which calls nbuild and nbexec to create and execute a notebook.
- nbraze, which extracts code and markdown files from a notebook.
- nbuild, which creates a notebook from code and markdown files.
Scope
-
Please indicate which category or categories this package falls under:
- Data retrieval
- Data extraction
- Data munging
- Data deposition
- Data visualization
- Reproducibility
- Geospatial
- Education
- Unsure/Other (explain below)
-
Explain how the and why the package falls under these categories (briefly, 1-2 sentences). Please note any areas you are unsure of:
Jupyter notebooks are important for reproducibility, because they facilitate literate programming, the combination of code and text. This way, descriptions of methods and results can be adjacent to the code used to obtain the results.
I frequently use Jupyter notebooks in my work and in the Python classes I teach, but access may be limited due to the underlying JSON structure of notebooks.
With Nbless, anyone can create Jupyter notebooks from simple source files or extract code and markdown files from Jupyter notebooks. This can promote the modularity principle without sacrificing the benefits of literate programming or the convenience of a single file with all code, text, and output for the project.
Code and markdown files can be easily be accessed with any text editor or even opened in a browser. Importantly, the original Jupyter notebook can be recreated from code and markdown files.
- Who is the target audience and what are scientific applications of this package?
The target audience is anyone who uses Jupyter notebooks. This package may help teachers and researchers to improve the efficiency of their Jupyter notebook workflows. One of the major features of Nbless is that it can facilitate the creation of slides from Jupyter notebooks. I can imagine teachers and researchers writing markdown and code files and then using nbless to creating Jupyter notebooks to share with their students and colleagues.
- Are there other Python packages that accomplish the same thing? If so, how does yours differ?
Related packages include:
These packages can all convert Jupyter notebooks to other formats: markdown files (all three) or Python scripts (jupytext). Nbless can take a more modular approach to file conversion by extracting the contents of each notebook cell into a separate file (cell -> file) or using a source file to create each notebook cell (file -> cell). Looking beyond simple file conversion, Nbless includes a tool for making slides from notebooks (by setting slide_type in notebook metadata).
- Any other questions or issues we should be aware of?:
P.S. Have feedback/comments about our review process? Leave a comment here