read_notebooks API¶
Reads all notebooks located in a given path into a Scrapbook object.
# create a scrapbook named `book`
book = sb.read_notebooks('path/to/notebook/collection/')
# get the underlying notebooks as a list
book.notebooks # Or `book.values`
The path reuses papermill’s registered iorw. to list and read files form various sources, such that non-local urls can load data.
# create a scrapbook named `book`
book = sb.read_notebooks('s3://bucket/key/prefix/to/notebook/collection/')
The Scrapbook (book in this example) can be used to recall all
scraps across the collection of notebooks:
book.notebook_scraps # Dict of shape `notebook` -> (`name` -> `scrap`)
book.scraps # merged dict of shape `name` -> `scrap`
scraps_report¶
The Scrapbook collection can be used to generate a scraps_report on
all the scraps from the collection as a markdown structured output.
book.scraps_report()
This display can filter on scrap and notebook names, as well as enable or disable an overall header for the display.
book.scraps_report(
scrap_names=["scrap1", "scrap2"],
notebook_names=["result1"], # matches `/notebook/collections/result1.ipynb` pathed notebooks
header=False
)
By default the report will only populate with visual elements. To also report on data elements set include_data.
book.scraps_report(include_data=True)
papermill support¶
Finally the scrapbook has two backwards compatible features for
deprecated papermill capabilities:
book.papermill_dataframe
book.papermill_metrics
