Skip to main content

execnb

Install

Either:

pip install execnb

or if you use conda:

conda install -c fastai execnb

(You can replace conda with mamba in the line above if you have mamba installed.)

How to use

Use CaptureShell to run Jupyter code and capture notebook outputs, without running a Jupyter server (or even having it installed). The API is async, so await the run from a notebook or async code, or wrap it in asyncio.run at a sync entry point:

from execnb.shell import *
from fastcore.utils import *
from fastcore.nbio import *
s = CaptureShell()
await s.run('1+1')
[{'data': {'text/plain': ['2']},
  'metadata': {},
  'output_type': 'execute_result',
  'execution_count': None}]

To execute a notebook and save it with outputs filled in, use CaptureShell.execute:

try:
    await s.execute('../tests/clean.ipynb', 'tmp.ipynb')
    print(read_nb('tmp.ipynb').cells[1].outputs)
finally: Path('tmp.ipynb').unlink()
[{'name': 'stdout', 'output_type': 'stream', 'text': '1\n'}, {'data': {'text/plain': '2'}, 'execution_count': None, 'metadata': {}, 'output_type': 'execute_result'}]

You can also execute notebooks from the command line with exec_nb:

!exec_nb --help
usage: exec_nb [-h] [--dest DEST] [--exc_stop] [--inject_code INJECT_CODE]
               [--inject_path INJECT_PATH] [--inject_idx INJECT_IDX] [--verbose]
               src

Execute notebook from `src` and save with outputs to `dest`

positional arguments:
  src                        Notebook path to read from

options:
  -h, --help                 show this help message and exit
  --dest DEST                Notebook path to write to (default: )
  --exc_stop                 Stop on exceptions? (default: False)
  --inject_code INJECT_CODE  Code to inject into a cell
  --inject_path INJECT_PATH  Path to file containing code to inject into a cell
  --inject_idx INJECT_IDX    Cell to replace with `inject_code` (default: 0)
  --verbose                  Show stdout/stderr during execution (default:
                             False)

Download files

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

Source Distribution

execnb-0.3.2.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

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

execnb-0.3.2-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file execnb-0.3.2.tar.gz.

File metadata

  • Download URL: execnb-0.3.2.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.2

File hashes

Hashes for execnb-0.3.2.tar.gz
Algorithm Hash digest
SHA256 723d01cb6388c112ad0eba1424637c105ad2fbed95c789baff7216078fae41da
MD5 3e50d742aa6d95fcdce0c1f15c965d06
BLAKE2b-256 d8c82ebd2be77cd8da38738971b8bc7a9041e50b9c34f1e1adf4e13130faa03d

See more details on using hashes here.

File details

Details for the file execnb-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: execnb-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.2

File hashes

Hashes for execnb-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b1a9663426d8bcb795dc9d3efe14b060838dd4f3389354c228ca8aae3e4ad8f5
MD5 058f6d2ad0c2b151edc1cce672ad6463
BLAKE2b-256 a5020f11fb9ee789b23fd3c3a235ea08ca9ebb80e5369a7e7849b4120a57c843

See more details on using hashes here.

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