Metadata-Version: 2.4
Name: nbcat
Version: 0.9.2
Summary: cat for jupyter notebooks
Project-URL: Homepage, https://github.com/akopdev/nbcat
Project-URL: Repository, https://github.com/akopdev/nbcat
Author-email: Akop Kesheshyan <devnull@akop.dev>
Maintainer-email: Akop Kesheshyan <devnull@akop.dev>
License: MIT License
        
        Copyright (c) 2025 Akop Kesheshyan
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: argcomplete
Requires-Dist: pydantic
Requires-Dist: requests
Requires-Dist: rich
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-mock; extra == 'dev'
Requires-Dist: pytest-responses; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

# 📦 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:

```bash
pip install nbcat
```

## 🛠️ Quickstart

```bash
$ nbcat notebook.ipynb
```

You can pass URLs as well.

```bash
$ 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:

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

## 🧪 Testing & Development

Run the tests:

```bash
make test
```

Check code quality:

```bash
make format lint
```

## 🙌 Contributing

Contributions are welcome! Please open an issue or [pull request](https://github.com/akopdev/nbcat/pulls).

## 📄 License

Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.

## 🔗 Useful Links

- 📘 Documentation: _coming soon_
- 🐛 Issues: [GitHub Issues](https://github.com/akopdev/nbcat/issues)
- 🚀 Releases: [GitHub Releases](https://github.com/akopdev/nbcat/releases)

---

Made with ❤️ by [Akop Kesheshyan](https://github.com/akopdev)
