---
name: pytest-notebook-policy
description: >
  Pytest plugin for notebook policy and quality checks. Use when writing Python code that uses the pytest_notebook_policy package.
license: MIT
compatibility: Requires Python >=3.12.
---

# pytest_notebook_policy

Pytest plugin for notebook policy and quality checks

## Installation

```bash
pip install pytest-notebook-policy
```

## API overview

### Dataclasses

Dataclass definitions

- `Violation`: Violation(path: 'Path', line: 'int', code: 'str', message: 'str')

### Functions

Utility functions

- `scan_file`

## Resources

- [Full documentation](https://databooth.github.io/pytest-notebook-policy/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs
- [Source code](https://github.com/DataBooth/pytest-notebook-policy)