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.1.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.1.0-py3-none-any.whl (603.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for testbench_requirement_service-1.1.0.tar.gz
Algorithm Hash digest
SHA256 706aed79b9310d8dc4ad85c21410dcf0ae3bd3dcf0cbce1d93559133f4c32058
MD5 46cb61d55931c1e76cb5652803561741
BLAKE2b-256 8a5e4b5df82ffc2a29b4958596c83934316c0968a77d6b349cf666d8969a01d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for testbench_requirement_service-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f967afd711c566def95458700eea9d5d0943344c708c8d058ef0989eb48c217
MD5 2282f173fcb8f808eb1d7afce64b50a8
BLAKE2b-256 4544bbddeefe098e3e3ef65c302344025f6f20e97f7a66c75b18ccbf68235c65

See more details on using hashes here.

Release history Release notifications | RSS feed

1.2.0

2 files

This release

1.1.0 This release

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