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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbcat-0.9.4.tar.gz
  • Upload date:
  • Size: 61.3 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.4.tar.gz
Algorithm Hash digest
SHA256 1eb8eea20822ed783e32287b68b7c3b1db22fd435d1ba8053eee70dee8104de6
MD5 280eef005c8d03e4a3690e585ff55152
BLAKE2b-256 6aa6ef50ee2fa7c86d12b690b1e13e65cf3ba920869deca3bb8641ededce63df

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: nbcat-0.9.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 62e0c791b4064955b065dadbbba40116403a8e1287883e49117709d46f1630f1
MD5 c692c6a19307843400093dbf5cfeb728
BLAKE2b-256 56836748bea32e6bb5092470df83309df9290e706540563935018573413b0715

See more details on using hashes here.

Provenance

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