Metadata-Version: 2.1
Name: nbmake
Version: 0.1
Summary: Pytest plugin for testing notebooks
Home-page: https://github.com/treebeardtech/nbmake
License: Apache-2.0
Author: alex-treebeard
Author-email: alex@treebeard.io
Requires-Python: >=3.6.1,<4.0.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: html
Requires-Dist: PyYAML (>=5.3.1,<6.0.0)
Requires-Dist: Pygments (>=2.7.3,<3.0.0)
Requires-Dist: ipykernel (>=5.4.0,<6.0.0)
Requires-Dist: jupyter-book (>=0.8.3,<0.9.0); extra == "html"
Requires-Dist: nbclient (<0.4)
Requires-Dist: nbformat (>=5.0.8,<6.0.0)
Requires-Dist: pathlib (>=1.0.1,<2.0.0)
Requires-Dist: pydantic (>=1.7.2,<2.0.0)
Requires-Dist: pytest (>=6.1.2,<7.0.0)
Description-Content-Type: text/markdown

# nbmake [Under Construction]
[![codecov](https://codecov.io/gh/treebeardtech/nbmake/branch/main/graph/badge.svg?token=9GuDM35FuO)](https://codecov.io/gh/treebeardtech/nbmake)
[![PyPI version](https://badge.fury.io/py/nbmake.svg)](https://badge.fury.io/py/nbmake)

Pytest plugin for testing notebooks

## Functionality

1. Executes notebooks using pytest and nbclient, allowing parallel notebook testing
2. Lets you automate release processes from your laptop or in the cloud
3. Optionally builds an HTML report using [jupyter-book](https://github.com/executablebooks/jupyter-book) of the test run which can be uploaded to hosting providers such as Netlify.

See [docs](https://treebeardtech.github.io/nbmake) to get started.

### HTML Report Example

![HTML Report](docs/screen.png)


## Developing

### Install local package
```
poetry install -E html
```

### Activate shell
```
poetry shell
```

### Run static checks
```
pre-commit run --all-files
pre-commit install
```

### Run tests
```
pytest
```


