Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paw-lu/nbpreview
A terminal viewer for Jupyter notebooks. It's like cat for ipynb files.
https://github.com/paw-lu/nbpreview
Last synced: 3 months ago
JSON representation
A terminal viewer for Jupyter notebooks. It's like cat for ipynb files.
- Host: GitHub
- URL: https://github.com/paw-lu/nbpreview
- Owner: paw-lu
- License: mit
- Created: 2021-03-18T03:05:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-28T16:17:50.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T11:49:52.348Z (3 months ago)
- Language: Python
- Homepage: https://nbpreview.readthedocs.io/
- Size: 5.01 MB
- Stars: 168
- Watchers: 5
- Forks: 7
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README

# nbpreview
[](http://mypy-lang.org/)
[](https://pypi.org/project/nbpreview/)
[](https://pypi.org/project/nbpreview/)
[](https://pypi.org/project/nbpreview)
[](https://opensource.org/licenses/MIT)
[][documentation]
[](https://github.com/paw-lu/nbpreview/actions?workflow=Tests)
[](https://codecov.io/gh/paw-lu/nbpreview)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://github.com/PyCQA/bandit)A terminal viewer for Jupyter notebooks.
It's like [cat](https://man7.org/linux/man-pages/man1/cat.1.html) for ipynb files.[documentation]: https://nbpreview.readthedocs.io/

## Documentation
nbpreview's [documentation] contains
a detailed breakdown of its [features],
[command-line usage][usage],
and [instructions on how to configure][configure] the tool.## Requirements
- Python 3.8+
## Installation
nbpreview can be installed through [pipx] or [pip] from [PyPI](https://pypi.org/).
[pipx] provides an easy way to install Python applications in isolated environments.
[See the documentation for how to install pipx.](https://pypa.github.io/pipx/installation/#install-pipx)```console
% pipx install nbpreview
```If [pipx] is not installed,
nbpreview may also be installed via [pip]:```console
% python -m pip install nbpreview
```[pipx]: https://pypa.github.io/pipx/
[pip]: https://pip.pypa.io/## Features
### [Syntax highlight code cells](https://nbpreview.readthedocs.io/en/latest/features.html#syntax-highlighting)

### [Render markdown](https://nbpreview.readthedocs.io/en/latest/features.html#markdown-rendering)

### [Draw images](https://nbpreview.readthedocs.io/en/latest/features.html#images)

### [Render DataFrame](https://nbpreview.readthedocs.io/en/latest/features.html#dataframe-rendering)

### [Create previews for Vega charts](https://nbpreview.readthedocs.io/en/latest/features.html#vega-and-vegalite-charts)

### [Render LaTeX](https://nbpreview.readthedocs.io/en/latest/features.html#latex)

### [Parse HTML](https://nbpreview.readthedocs.io/en/latest/features.html#html)

### [Create hyperlinks for complex content](https://nbpreview.readthedocs.io/en/latest/features.html#hyperlinks)

### [Render stderr output](https://nbpreview.readthedocs.io/en/latest/features.html#stderr)

### [Render tracebacks](https://nbpreview.readthedocs.io/en/latest/features.html#tracebacks)

### [Use Nerd Font icons](https://nbpreview.readthedocs.io/en/latest/features.html#nerd-fonts)
## Try it out
Assuming [curl] and [pipx] are installed,
nbpreview may be tried out on the terminal by running:```console
% curl https://raw.githubusercontent.com/paw-lu/nbpreview/main/docs/example_notebook_cells/hero_notebook.ipynb | pipx run nbpreview
```## Usage
To use nbpreview,
type `nbpreview` into your terminal followed by the path of the notebook you wish to view.```console
% nbpreview notebook.ipynb
```See the [command-line reference][usage] for details on options.
## Contributing
Contributions are very welcome.
To learn more, see the [contributor guide][contributing].## License
Distributed under the terms of the [MIT license][license],
_nbpreview_ is free and open source software.## Issues
If you encounter any problems,
please [file an issue][issues] along with a detailed description.## Prior art
### Similar tools
Thanks to [@joouha] for [maintaining a list of these tools][euporie_similar_tools].
Many of the projects here were found directly on their page.- [ipynb-term](https://github.com/PaulEcoffet/ipynbviewer)
- [ipynbat](https://github.com/edgarogh/ipynbat)
- [ipynbviewer](https://github.com/edgarogh/ipynbat)
- [jcat](https://github.com/ktw361/jcat)
- [jupview](https://github.com/Artiomio/jupview)
- [jupytui](https://github.com/mosiman/jupytui)
- [jut](https://github.com/kracekumar/jut)
- [nbcat](https://github.com/jlumpe/nbcat)
- [nbtui](https://github.com/chentau/nbtui)
- [nbv](https://github.com/lepisma/nbv)
- [Read-Jupyter-Notebook](https://github.com/qcw171717/Read-Jupyter-Notebook)[@joouha]: https://github.com
[euporie_similar_tools]: https://euporie.readthedocs.io/en/latest/pages/related.html#notebook-viewers### Complimentary tools
If you're interested in complimentary tools
that help improve the terminal experience for notebooks,
there are many amazing projects out there.- **[bat](https://github.com/sharkdp/bat)**
is 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.
- **[euporie]**
is a really exciting project
that allows you to edit and run Jupyter notebooks on the terminal.
- **[nbclient]**
is a library for executing notebooks from the command line.
- **[nbpreview]**
is another project that coincidentally shares a name with this one.
It allows for Jupyter notebooks to be rendered
without running a notebook server.
- **[nbqa]**
allows the use of linters and formatters on notebooks.
It's also used by this project.
- **[jpterm]**
is and up-and-coming successor to [nbterm]
which will be accompanied by a web client.
Looking forward to seeing this develop.
- **[nbtermix]**
is an actively-developed fork of [nbterm].
- **[nbterm]**
lets you edit and execute Jupyter Notebooks on the terminal.
- **[papermill]**
allows the parameterization and execution of Jupyter Notebooks.[nbterm]: https://github.com/davidbrochart/nbterm
[euporie]: https://github.com/joouha/euporie
[nbclient]: https://github.com/jupyter/nbclient
[nbpreview]: https://github.com/jsvine/nbpreview
[nbqa]: https://github.com/nbQA-dev/nbQA
[jpterm]: https://github.com/davidbrochart/jpterm
[nbtermix]: https://github.com/mtatton/nbtermix
[papermill]: https://github.com/nteract/papermill## Credits
nbpreview relies on a lot of fantastic projects.
Check out the [dependencies] for a complete list of libraries that are leveraged.Besides the direct dependencies,
there are some other projects that directly enabled the development of nbpreview.- **[bat]**
is not explicitly used in this project,
but served as the primary inspiration.
This projects strives to be [bat]—but
for notebooks.
Many of nbpreview's features and command-line options are directly adopted from [bat].
- **[Hypermodern Python Cookiecutter]**
is the template this project was generated on.
It is a fantastic project that integrates [Poetry],
[Nox],
and [pre-commit].
It's responsible for most of this project's CI.
- **[justcharts]**
is directly used by this project
to generate the Vega and Vega-Lite charts.[bat]: https://github.com/sharkdp/bat
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[justcharts]: https://github.com/koaning/justcharts
[nox]: https://nox.thea.codes/en/stable/
[poetry]: https://python-poetry.org/
[pre-commit]: https://pre-commit.com/[configure]: https://nbpreview.readthedocs.io/configure.html
[contributing]: https://github.com/paw-lu/nbpreview/blob/main/CONTRIBUTING.md
[curl]: https://curl.se/docs/
[dependencies]: https://github.com/paw-lu/nbpreview/blob/main/pyproject.toml
[exporting_rich_console]: https://rich.readthedocs.io/en/stable/console.html#exporting
[features]: https://nbpreview.readthedocs.io/features.html
[furo]: https://pradyunsg.me/furo/quickstart/
[issues]: https://github.com/paw-lu/nbpreview/issues
[license]: https://opensource.org/licenses/MIT
[myst]: https://myst-parser.readthedocs.io/en/latest/
[usage]: https://nbpreview.readthedocs.io/en/latest/usage.html