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 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. Eventually it will also contain a powerful linter to find issues with types and 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 users
- Tutorial (read this as a first introduction)
- Release Notes (read this to find out whats new)
- Language Reference Manual (for language lawyers)
- License
For developers
- Python API Documentation (API reference)
- AST Hierarchy (overview over all classes in the AST)
Dependencies
Run-time
- Python3 >= 3.7
Development tools
- GNU Make
- 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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.