Contents

• Features

• Installation

• Quick Start

• Robot Framework Integration

• Documentation

• License

Features

• Traceability reports in console or JSON format.

• Robot Framework support via output.xml parsing.

• Import/export requirements in YAML and ReqIF formats.

• YAML-based requirements files that fit cleanly in Git workflows.

• SQLite-backed requirements database for fast CLI operations.

Installation

pip install raiz

Quick Start

Download the example.

NOTE: If you use nix develop ., you should use python -m raiz.cli instead of raiz in the commands below. —

cd example
make robot
raiz import --format yaml --file requirements/requirements.yaml
raiz show all
raiz add
raiz update 3
raiz rm 5
raiz trace --fmt json --output trace_report
raiz export --format reqif
raiz export --format yaml

Requirements are stored under requirements/ by default, and temporary files are written to .req_cache/.

Robot Framework Integration

Tests should be tagged with requirement IDs:

*** Test Cases ***
Test BLE Connection
    [Tags]    REQ-001
    Do Something

After executing tests (which generates output.xml), you can trace coverage.

Documentation

• docs/support_reqif.rst - ReqIF support and import/export details.

• docs/contributing.rst - How to contribute, including testing.

• docs/release.rst - Release process for new versions.

License

Apache License 2.0