Skip to main content

cat for jupyter notebooks

Project description

📦 nbcat

nbcat lets you preview Jupyter notebooks directly in your terminal. Think of it as cat, but for .ipynb files.

🚀 Features

  • Fast and lightweight with minimal external dependencies
  • Preview remote notebooks without downloading them
  • Supports for all Jupyter notebook versions - including legacy formats

📦 Installation

From the command line using pip:

pip install nbcat

🛠️ Quickstart

$ nbcat notebook.ipynb

You can pass URLs as well.

$ nbcat https://raw.githubusercontent.com/akopdev/nbcat/refs/heads/main/tests/assets/test4.ipynb

Example use case with fzf command that lists all .ipynb files and uses nbcat for previewing them:

find . -type f -name "*.ipynb" | fzf --preview 'nbcat {}'

🧪 Testing & Development

Run the tests:

make test

Check code quality:

make format lint

🙌 Contributing

Contributions are welcome! Please open an issue or pull request.

📄 License

Distributed under the MIT License. See LICENSE for more information.

🔗 Useful Links


Made with ❤️ by Akop Kesheshyan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbcat-0.9.2.tar.gz (58.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbcat-0.9.2-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file nbcat-0.9.2.tar.gz.

File metadata

  • Download URL: nbcat-0.9.2.tar.gz
  • Upload date:
  • Size: 58.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nbcat-0.9.2.tar.gz
Algorithm Hash digest
SHA256 e32e2272eaf71cb471a6818b193dd286539ac048d0b06b642446aa04c689e4b6
MD5 e91b40ed203469b7752f1cf17a2736a3
BLAKE2b-256 aaac624ea7a4c6c71a99d872c8f5f909e4205dbae1710e0ead1c703c52df5a92

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbcat-0.9.2.tar.gz:

Publisher: ci.yml on akopdev/nbcat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nbcat-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: nbcat-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nbcat-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 38db1ed3aca6bb16ed14e3e563b592fad598be5316ed12cff28e8280c70b8674
MD5 1f3b60c81238bcb44610dbb820598aa0
BLAKE2b-256 05d9b646ba7c67dfc11302b8bbc7aa9232743fe1e70e9179232de9be1fe78319

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbcat-0.9.2-py3-none-any.whl:

Publisher: ci.yml on akopdev/nbcat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page