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 language reference manual for TRLC. Previous versions are also available.
-
A pure Python reference implementation of TRLC.
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
- Tutorial (read this as a first introduction)
- Bazel integration (how to use TRLC inside a Bazel build)
- User manual: TRLC linter (the user manual for the TRLC static analysis and linter)
- Release Notes (read this to find out whats new)
- License
For advanced users
- Language Reference Manual (for language lawyers)
- Python API Documentation (API reference for end-users)
- AST Hierarchy (overview over all classes in the AST)
For TRLC developers
- Set up development environment
- Lexer/Parser Hierarchy (overview over all classes releated to the lexing and parsing of TRLC)
- Tool Architecture Overview
- TRLC Static Checker Slides (Kinda incomplete, designed to go along with a code walkthrough)
- Requirements Coverage Report
- Code Coverage Report
Tools Available
- TRLC_RST: Convert TRLC Requirements for Sphinx Build
- Converters: Multiple converters from TRLC to other file formats. The tool suite is maintained by NewTec GmbH.
Dependencies
Run-time
Acknowledgements
Special thanks to Florian Schanda for his many valuable contributions to this repository.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file trlc-3.0.1-py3-none-any.whl.
File metadata
- Download URL: trlc-3.0.1-py3-none-any.whl
- Upload date:
- Size: 99.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
93621d8a856c63adec3ff588033c7649f635cca2305048ea7cc53bdcb6a0de18
|
|
| MD5 |
63ba7707030f316c37a6f7010289e14a
|
|
| BLAKE2b-256 |
cd0eeceed2de48be29c40408fb752e705915952827f93a8d32748e11d3604f28
|
Provenance
The following attestation bundles were made for trlc-3.0.1-py3-none-any.whl:
Publisher:
package.yml on bmw-software-engineering/trlc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
trlc-3.0.1-py3-none-any.whl -
Subject digest:
93621d8a856c63adec3ff588033c7649f635cca2305048ea7cc53bdcb6a0de18 - Sigstore transparency entry: 2370289087
- Sigstore integration time:
-
Permalink:
bmw-software-engineering/trlc@8f369f1208598c2e75f44a77a98d244634ed482a -
Branch / Tag:
refs/tags/trlc-3.0.1 - Owner: https://github.com/bmw-software-engineering
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
package.yml@8f369f1208598c2e75f44a77a98d244634ed482a -
Trigger Event:
release
-
Statement type:
