Skip to main content

TestBench Requirement Service

PyPI version Python versions License

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:

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

testbench_requirement_service-1.2.0.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

testbench_requirement_service-1.2.0-py3-none-any.whl (607.6 kB view details)

Uploaded Python 3

File details

Details for the file testbench_requirement_service-1.2.0.tar.gz.

File metadata

File hashes

Hashes for testbench_requirement_service-1.2.0.tar.gz
Algorithm Hash digest
SHA256 f218bc696c077d4a85882229a6cb4ca263bae5ae108f899bf5e281663c54445c
MD5 e8a3cb7d45cb2e9acdd3e088215688de
BLAKE2b-256 074f41762cfeb821356fa4383103668334508651a693545845abc6e3090067b5

See more details on using hashes here.

File details

Details for the file testbench_requirement_service-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for testbench_requirement_service-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a695462e24b556f1fe1e089ae439b216bbac1ce06d1c02082de8586e7040f583
MD5 87fde59fa639c5902a8f56f61be2d0ce
BLAKE2b-256 881fb8850eadbb7327416be3eca1d83cf1a7e292d14f1b578668cedd6f9a1de5

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 files

1.1.0

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page