Package: nbpreview
nbpreviewA terminal viewer for Jupyter notebooks.
It's likecatfor ipynb files.Documentationnbpreview'sdocumentationcontains
a detailed breakdown of itsfeatures,command-line usage,
andinstructions on how to configurethe tool.RequirementsPython 3.8+Installationnbpreview can be installed throughpipxorpipfromPyPI.pipxprovides an easy way to install Python applications in isolated environments.See the documentation for how to install pipx.%pipxinstallnbpreviewIfpipxis not installed,
nbpreview may also be installed viapip:%python-mpipinstallnbpreviewFeaturesSyntax highlight code cellsRender markdownDraw imagesRender DataFrameCreate previews for Vega chartsRender LaTeXParse HTMLCreate hyperlinks for complex contentRender stderr outputRender tracebacksUse Nerd Font iconsTry it outAssumingcurlandpipxare installed,
nbpreview may be tried out on the terminal by running:%curlhttps://raw.githubusercontent.com/paw-lu/nbpreview/main/docs/example_notebook_cells/hero_notebook.ipynb|pipxrunnbpreviewUsageTo use nbpreview,
typenbpreviewinto your terminal followed by the path of the notebook you wish to view.%nbpreviewnotebook.ipynbSee thecommand-line referencefor details on options.ContributingContributions are very welcome.
To learn more, see thecontributor guide.LicenseDistributed under the terms of theMIT license,nbpreviewis free and open source software.IssuesIf you encounter any problems,
pleasefile an issuealong with a detailed description.Prior artSimilar toolsThanks to@joouhaformaintaining a list of these tools.
Many of the projects here were found directly on their page.ipynb-termipynbatipynbviewerjcatjupviewjupytuijutnbcatnbtuinbvRead-Jupyter-NotebookComplimentary toolsIf you're interested in complimentary tools
that help improve the terminal experience for notebooks,
there are many amazing projects out there.batis not a tool for notebooks specifically.
But similar to nbpreview,
it provides a rich output for many types of files on the terminal,
and is the primary inspiration for nbpreview.euporieis a really exciting project
that allows you to edit and run Jupyter notebooks on the terminal.nbclientis a library for executing notebooks from the command line.nbpreviewis another project that coincidentally shares a name with this one.
It allows for Jupyter notebooks to be rendered
without running a notebook server.nbqaallows the use of linters and formatters on notebooks.
It's also used by this project.jptermis and up-and-coming successor tonbtermwhich will be accompanied by a web client.
Looking forward to seeing this develop.nbtermixis an actively-developed fork ofnbterm.nbtermlets you edit and execute Jupyter Notebooks on the terminal.papermillallows the parameterization and execution of Jupyter Notebooks.Creditsnbpreview relies on a lot of fantastic projects.
Check out thedependenciesfor a complete list of libraries that are leveraged.Besides the direct dependencies,
there are some other projects that directly enabled the development of nbpreview.batis not explicitly used in this project,
but served as the primary inspiration.
This projects strives to bebat—but
for notebooks.
Many of nbpreview's features and command-line options are directly adopted frombat.Hypermodern Python Cookiecutteris the template this project was generated on.
It is a fantastic project that integratesPoetry,Nox,
andpre-commit.
It's responsible for most of this project's CI.justchartsis directly used by this project
to generate the Vega and Vega-Lite charts.