TestBench Requirement Service

A lightweight REST API service for imbus TestBench that provides unified access to requirements from multiple data sources: Jira, Excel, and JSONL.

Features

• Multiple readers: JSONL files, Excel spreadsheets (.xlsx, .xls, .csv, .tsv, .txt), or Jira via REST API
• Unified REST API: one consistent API surface regardless of the underlying data source
• Interactive setup wizard: testbench-requirement-service init generates a complete configuration in seconds
• Swagger UI: built-in interactive API docs at /docs
• HTTPS & mTLS: optional TLS and mutual TLS for production deployments
• Windows service support: deploy as a service with NSSM, FireDaemon, or YAJSW
• Extensible: implement AbstractRequirementReader to connect any data source

Installation

With pip (Python 3.10–3.14 required):

pip install testbench-requirement-service

Optional extras for additional readers:

Reader	Data source	Install command
JSONL (default)	.jsonl files	included in base install
Excel	.xlsx, .xls, .csv, .tsv, .txt	pip install testbench-requirement-service[excel]
Jira	Jira REST API	pip install testbench-requirement-service[jira]

Standalone executable — no Python required. Download the pre-built binary from the GitHub releases page.

Quick start

# 1. Create a configuration interactively
testbench-requirement-service init

# 2. Start the service
testbench-requirement-service start

The service runs at http://127.0.0.1:8020 by default. Open /docs for the interactive Swagger UI.

Documentation

Full documentation is available on the TestBench Ecosystem documentation site:

• Introduction
• Installation
• Quickstart
• Configuration
• CLI Commands
• Readers overview
• TestBench Integration
• Windows Service Installation

Contributing

Contributions are welcome. See CONTRIBUTING.md for setup instructions and guidelines.

Changelog

See CHANGELOG.md for release history.

License

Apache 2.0 — see LICENSE for details.