Metadata-Version: 2.4
Name: jupycat
Version: 0.1.0
Summary: Read Jupyter notebook cells from the command line
Author: Ebin Joseph
License: MIT
Project-URL: Repository, https://github.com/ebin7joseph/jupycat
Project-URL: Documentation, https://github.com/ebin7joseph/jupycat/tree/main/docs
Keywords: jupyter,notebook,cli,cat
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: mkdocs; extra == "dev"
Requires-Dist: mkdocs-material; extra == "dev"
Dynamic: license-file

# jupycat

`cat` for Jupyter notebooks. Read cells, outputs, and images from the command line.

```
$ jupycat notebook.ipynb
  0 [mark] (a1b2c3d4)  # My Analysis
  1 [code] (e5f6g7h8)  import pandas as pd
  2 [code] (i9j0k1l2)  df = pd.read_csv("data.csv")
```

## Install

```bash
pip install jupycat
```

**Zero dependencies** · Python 3.8+

## Quick start

```bash
jupycat notebook.ipynb              # list all cells
jupycat notebook.ipynb 5            # show cell 5
jupycat notebook.ipynb 5 -o         # show cell 5 with outputs
jupycat notebook.ipynb -s "def foo" # search cell source for pattern
jupycat notebook.ipynb 7 --img      # extract images to temp dir
jupycat notebook.ipynb 7 --img .    # extract images to current directory
jupycat notebook.ipynb --fix-ids    # add missing cell IDs
```

## Docs

[Usage](docs/usage.md) · [AI Agents](docs/ai-agents.md) · [Contributing](docs/contributing.md)

## License

MIT
