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 initgenerates 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
AbstractRequirementReaderto 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.
Release files for testbench-requirement-service 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| testbench_requirement_service-1.3.0.tar.gz | 592.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| testbench_requirement_service-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / testbench_requirement_service-1.3.0.tar.gz
| Download URL | testbench_requirement_service-1.3.0.tar.gz |
|---|---|
| Size | 592.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e074dda2718d8351ff9d2eea41e831195bbf5fa1647c6ae90328d50df44ca830
|
|
BLAKE2b-256 checksum How to use checksums |
3fac6d90e27a71e96a17b20c41522f5f3d08b3ad1ad02ced5c19c0c05d2f39b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
Release files / testbench_requirement_service-1.3.0-py3-none-any.whl
| Download URL | testbench_requirement_service-1.3.0-py3-none-any.whl |
|---|---|
| Size | 617.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
13122ccea5bf0cc7d739c5c0486435529f6ad5683b9ca49492c9bb845b32109d
|
|
BLAKE2b-256 checksum How to use checksums |
85bf97947390c5ef2c247cdcae500c0562b3d01c9c249f8ede4e38cabe4d9777
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
