https://github.com/tsvikas/nbcat
display jupyter notebooks in the terminal
https://github.com/tsvikas/nbcat
cli jupyter-notebooks previewer
Last synced: over 1 year ago
JSON representation
display jupyter notebooks in the terminal
- Host: GitHub
- URL: https://github.com/tsvikas/nbcat
- Owner: tsvikas
- License: mit
- Created: 2024-04-09T18:10:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T16:57:40.000Z (over 1 year ago)
- Last Synced: 2025-03-11T17:50:01.464Z (over 1 year ago)
- Topics: cli, jupyter-notebooks, previewer
- Language: Jupyter Notebook
- Homepage:
- Size: 1.54 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nbcat
[![Tests][tests-badge]][tests-link]
[![uv][uv-badge]][uv-link]
[![Ruff][ruff-badge]][ruff-link]
[![Black][black-badge]][black-link]
\
[![Made Using tsvikas/python-template][template-badge]][template-link]
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
[![PRs Welcome][prs-welcome-badge]][prs-welcome-link]
## Overview
display your notebooks, in the terminal 
## Installation
use pipx to install:
```bash
pipx install git+https://github.com/tsvikas/nbcat.git
```
## Usage
```bash
nbcat FILENAME -R | less -R
```
use `-f FORMAT` to specify the output format, default is `markdown`
## Development
### Getting started
- install [git][install-git], [uv][install-uv].
- git clone this repo: `git clone tsvikas/nbcat.git`
- run `uv run just prepare`
### Tests and code quality
- use `uv run just format` to format the code.
- use `uv run just lint` to see linting errors.
- use `uv run just test` to run tests.
- use `uv run just check` to run all the checks (format, lint, test, and pre-commit).
- Run a specific tool directly, with `uv run pytest`/`ruff`/`mypy`/`black`/...
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]: https://github.com/psf/black
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]: https://github.com/tsvikas/nbcat/discussions
[install-git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
[install-uv]: https://docs.astral.sh/uv/getting-started/installation/
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs-welcome-link]: http://makeapullrequest.com
[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
[ruff-link]: https://github.com/astral-sh/ruff
[template-badge]: https://img.shields.io/badge/%F0%9F%9A%80_Made_Using-tsvikas%2Fpython--template-gold
[template-link]: https://github.com/tsvikas/python-template
[tests-badge]: https://github.com/tsvikas/nbcat/actions/workflows/ci.yml/badge.svg
[tests-link]: https://github.com/tsvikas/nbcat/actions/workflows/ci.yml
[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
[uv-link]: https://github.com/astral-sh/uv