Installation

To install from PyPi:

>> pip install pytest-notebook

To install from Conda:

>> conda install -c conda-forge pytest-notebook

To install the development version:

>> git clone https://github.com/chrisjsewell/pytest-notebook .
>> cd pytest-notebook
>> pip install --group test --group pre_commit -e ".[docs]"

Development

Testing

It is recommended to use tox to run tests.

>> tox

Coding Style Requirements

The code style is tested and formatted using ruff, with the configuration set in pyproject.toml.

Installing the pre_commit dependency group (pip install --group pre_commit -e .) makes the pre-commit package available, which will ensure these tests are passed by reformatting the code and testing for lint errors before submitting a commit. It can be set up by:

>> pre-commit run --all
>> pre-commit install

Editors like VS Code also have automatic code reformat utilities, which can check and adhere to this standard.

Documentation

The documentation can be created locally by:

>> tox -e docs-clean
>> tox -e docs-update