Skip to main content

Treat Requirements Like Code

Project description

Treat Requirements Like Code (TRLC)

TRLC is a domain-specific language developed at BMW for writing (and linking) requirements with meta-data.

The repository contains:

The implementation is not very fast, but designed to be pedantically correct in following the language definition. The tools also include a powerful static analysis tool to find issues with types and user-defined check rules.

The Python implementation can be used for several purposes:

  • It can be used to validate other TRLC implementations.

  • It can be used to validate a body of requirements (e.g. a CI check that all requirements are well formed)

  • The API can be used to write other tools based on TRLC (for example a tool to render the requirements in HTML, a tool to diff requirements or perform an impact analysis, or a tool to perform software traceability, etc.)

Documentation

For normal users

For API users

For TRLC developers

Dependencies

Run-time

  • 3.8 <= Python3 <= 3.10

Optional dependencies (they are not installed automatically):

  • PyVCG (Linux or OSX only, required when using the --verify option)

Development tools

  • GNU Make
  • Graphviz
  • PyCodeStyle (from PyPI, for basic checking of source code style)
  • PyLint (from PyPI, for basic bug finding)
  • Coverage (from PyPI, to perform branch coverage when running the test suite)
  • Sphinx (from PyPI, for building the documentation)
  • PyVCG (from PyPI, for building verification conditions)
  • CVC5 (from PyPI, for discharging verification conditions)

You can install all Python dependencies by doing:

pip3 install -r requirements.txt

When building the traceability report you also need to install two lobster packages. Since there is a circular dependency, please install like this:

pip3 install bmw-lobster-core bmw-lobster-tool-python
pip3 install --no-deps bmw-lobster-tool-trlc

The most important make targets when developing TRLC are:

  • lint (runs pycodestyle and pylint)
  • test (performs unit and system tests and shows coverage)
  • tracing (generates traceability report)

Project details


Download files

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

Source Distribution

trlc-1.1.8.tar.gz (68.7 kB view hashes)

Uploaded Source

Built Distributions

trlc-1.1.8-py3-none-manylinux2014_x86_64.whl (74.8 kB view hashes)

Uploaded Python 3

trlc-1.1.8-py3-none-any.whl (74.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page