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.3.tar.gz (56.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.3-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbcat-0.9.3.tar.gz
  • Upload date:
  • Size: 56.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.3.tar.gz
Algorithm Hash digest
SHA256 fcbd32b4c54fcdf4a98c3367c09da4937eaed294570f924a00f18539f96e929f
MD5 98c92044b75e932e0fd64699855bea15
BLAKE2b-256 de6f0cba347d6c4e2da1b26c8c6a45267dac2f85b7aa1be397cd4655c4141238

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbcat-0.9.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: nbcat-0.9.3-py3-none-any.whl
  • Upload date:
  • Size: 7.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c11fdc4c9775bd967722ea3c1db412ecb2c4ef2fbc62b9ee8b42573a82878875
MD5 86ddd5284f1733d0dc49ec06e919f38b
BLAKE2b-256 51e2d67b75eb7c6a80c3e26f0dd039355459ee23142015a1b4eebf31af97f499

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbcat-0.9.3-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