Metadata-Version: 2.3
Name: nbconvert-a11y
Version: 2024.3.25
Summary: nbconvert templates using modern standards
Author-email: tonyfast <tony.fast@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Requires-Dist: accessible-pygments
Requires-Dist: exceptiongroup; python_version < '3.12'
Requires-Dist: html5lib
Requires-Dist: markdown-it-py[linkify,plugins]
Requires-Dist: nbconvert
Requires-Dist: python-slugify
Provides-Extra: audit
Requires-Dist: playwright; extra == 'audit'
Requires-Dist: requests; extra == 'audit'
Requires-Dist: requests-cache; extra == 'audit'
Provides-Extra: docs
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Provides-Extra: task
Requires-Dist: doit; extra == 'task'
Requires-Dist: pandas; extra == 'task'
Requires-Dist: tabulate; extra == 'task'
Requires-Dist: tomli; extra == 'task'
Provides-Extra: test
Requires-Dist: beautifulsoup4; extra == 'test'
Requires-Dist: ipywidgets; extra == 'test'
Requires-Dist: matplotlib; extra == 'test'
Requires-Dist: numpy; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-html; extra == 'test'
Requires-Dist: pytest-playwright; extra == 'test'
Requires-Dist: pytest-sugar; extra == 'test'
Requires-Dist: pytest-xdist; extra == 'test'
Requires-Dist: scipy; extra == 'test'
Description-Content-Type: text/markdown

# `nbconvert-a11y`

`nbconvert-a11y` contains templates for accessible notebook representations and accessibility tests for Jupyter notebook products.

```bash
pip install nbconvert-a11y
```

`nbconvert-a11y` can be used with the [`nbconvert` command line tool](https://nbconvert.readthedocs.io/en/latest/usage.html).
it provides the `a11y` exporter with several variants that can be used. the default theme uses a flexible table representation

```bash
jupyter nbconvert --to a11y Untitled.ipynb           # flexible table navigation
jupyter nbconvert --to a11y-table Untitled.ipynb     # a11y is an alias for a11y-table
jupyter nbconvert --to a11y-landmark Untitled.ipynb  # cells are section landmarks
jupyter nbconvert --to a11y-list Untitled.ipynb      # cells are list items
```

```python
from nbconvert_a11y.exporter import A11y, Table, Section, List
```

A an example of the canonical Lorenz differential differential equations can be viewed @ https://deathbeds.github.io/nbconvert-a11y/exports/html/lorenz-executed-a11y.html

## History

the `nbconvert-a11y` project is forked from initial development in the [`notebook-for-all`]() repository. 
this collaboration between [Space Telescope Science Institute](https://www.stsci.edu/), [Iota School](https://iotaschool.com/) and [Quansight Labs](https://www.quansight.com/labs)
brought input from blind and visual impaired notebook users as to what their most assistive experiences could be.

## License
Licensed under a [3-Clause BSD license](LICENSE).
