Metadata-Version: 2.4
Name: jamb
Version: 1.3.0
Summary: IEC 62304 requirements traceability for pytest
Author-email: Andrew Van <vanandrew77@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Andrew Van
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: click>=8.0
Requires-Dist: jinja2>=3.0
Requires-Dist: openpyxl>=3.0
Requires-Dist: pytest>=7.0
Requires-Dist: python-docx>=1.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: tomli>=2.0; python_version < '3.11'
Requires-Dist: tomlkit>=0.12
Description-Content-Type: text/markdown

[![CI](https://github.com/vanandrew/jamb/actions/workflows/ci.yml/badge.svg)](https://github.com/vanandrew/jamb/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/vanandrew/jamb/graph/badge.svg?token=RL7H4DG3YO)](https://codecov.io/gh/vanandrew/jamb)
[![PyPI - Version](https://img.shields.io/pypi/v/jamb?style=flat)](https://pypi.org/project/jamb/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/jamb?style=flat)](https://pypi.org/project/jamb/)
[![PyPI - License](https://img.shields.io/pypi/l/jamb?style=flat)](https://pypi.org/project/jamb/)
[![Docs](https://readthedocs.org/projects/jamb/badge/?version=latest)](https://jamb.readthedocs.io)

# jamb

IEC 62304 requirements traceability for pytest.

jamb links your pytest tests to requirements, generating traceability matrices for regulatory submissions. It's designed for medical device software and other regulated industries where you need to prove every requirement has been tested.

## Installation

```bash
pip install jamb
```

## Quick Example

```bash
# Initialize a project with IEC 62304 documents
jamb init

# Add and link requirements
jamb item add SRS
jamb item edit SRS001
jamb link add SRS001 SYS001
```

```python
import pytest

@pytest.mark.requirement("SRS001")
def test_valid_credentials():
    assert authenticate("admin", "secret") is True
```

```bash
# Generate traceability matrix
pytest --jamb --jamb-matrix matrix.html
```

## Documentation

Full documentation is available at [jamb.readthedocs.io](https://jamb.readthedocs.io).

- [Quickstart](https://jamb.readthedocs.io/en/latest/getting-started/quickstart.html) -- get up and running
- [Concepts](https://jamb.readthedocs.io/en/latest/user-guide/concepts.html) -- suspect links, review cycles, document hierarchy
- [Configuration](https://jamb.readthedocs.io/en/latest/user-guide/configuration.html) -- `pyproject.toml` and document settings
- [pytest Integration](https://jamb.readthedocs.io/en/latest/user-guide/pytest-integration.html) -- markers, options, and matrix formats
- [CI/CD](https://jamb.readthedocs.io/en/latest/user-guide/ci-cd.html) -- GitHub Actions, pre-commit hooks
