LOBSTER
The Lightweight Open BMW Software Traceability Evidence Report allows you to demonstrate software traceability and requirements coverage, which is essential for meeting standards such as ISO 26262.
This package contains a tool to interface with the proprietary requirements management tool Codebeamer.
Tools
lobster-codebeamer: Extract requirements from codebeamer.
Configuration
The tool requires a YAML configuration file to define its settings. You must provide this file when running the tool to specify parameters to process.
It allows to configure the following features:
References
Codebeamer items can reference other items through
Reference Fields.
This piece of information can be extracted by the tool, and serialized into the
LOBSTER output file.
It only needs to know which fields to take into account.
Following the LOBSTER yaml schema, the item references will be added to the
refs property of the LOBSTER item.
Accordingly, the configuration parameter to specify the codebeamer field names
is called refs, too.
It can contain a single field name, or a list of field names.
Field IDs cannot be used, only the field names.
Examples:
refs : "cb-fieldname"
or
refs : ["cb-fieldname"]
or
refs : ["cb-fieldname1", "cb-fieldname2"]
Bearer Authentication Token
Define the Bearer authentication token in the configuration file as follows
token : "your-codebeamer-Bearer-token"
Note:
- If
--cb-useror--cb-passis given together with a Bearer token (through the configuration file), then the Bearer authentication method is used, and the username and/or password are ignored. - If neither a token nor a username or password are given, then the tool tries
to read the username and password from the
.netrcfile in the user's home directory. - If value of root in config file is
https://codebeamer.bmwgroup.net, then value of machine in .netrc will becodebeamer.bmwgroup.net.
.netrc Configuration for Codebeamer
machine your.codebeamer.url
login your_username
password your_password
Example Configuration
Here is an example of a configuration file:
refs : ["derived from", "satisfied by"]
token : "SomeTokenStringABC123"
Is it also possible to define the codebeamer token in this file:
refs : "cb-fieldname"
token : "your cb-token"
Schema
You can also specify the type of schema for the resulting output file. The supported values for the schema field are:
- Activity: Sets the schema to lobster-act-trace.
- Implementation: Sets the schema to lobster-imp-trace.
- Requirement: Sets the schema to lobster-req-trace.
If the schema is not specified, the tool will default to Requirement, and the schema lobster-req-trace will be used.
Here is an example of a configuration file:
schema: "Activity", // Specifies schema
refs : ["cb-fieldname1", "cb-fieldname2"] // Specifies references
If an invalid schema is provided, the tool will raise an exception. Supported schema values are Activity, Implementation, and Requirement.
Usage
There are two ways you can use this tool:
-
Download all requirements mentioned by another lobster trace (this way you do not get a completeness check) (using
--import-tagged) -
Download all requirements generated by a saved codebeamer query ID OR a codebeamer query string (cbQL query) (using
--import-query- accepts the query ID as well as query string)
-
Configure the 'refs' upstream reference (this parameter is optional)
-
Additionally, you can specify the schema and references:
-
Specify the schema of the trace to be generated (optional, defaults to "Requirement"). You can set it in the configuration file.
-
Configure the 'refs' upstream reference (optional).
-
For example:
python lobster_codebeamer.py --config codebeamer-config.yamlThis command will extract activity traces (lobster-act-trace) with specified references.
-
Limitations
The key limitation is item text, which is currently not imported. However, we do plan to also import item text eventually.
Copyright & License information
The copyright holder of LOBSTER is the Bayerische Motoren Werke Aktiengesellschaft (BMW AG), and LOBSTER is published under the GNU Affero General Public License, Version 3.
This tool has no actual dependency on, or with, Codebeamer. It just talks the API as described here: https://codebeamer.com/cb/wiki/117612
Release files for bmw-lobster-tool-codebeamer 1.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bmw_lobster_tool_codebeamer-1.0.6-py3-none-any.whl | Python 3 | none | any | Details |
Release files / bmw_lobster_tool_codebeamer-1.0.6-py3-none-any.whl
| Download URL | bmw_lobster_tool_codebeamer-1.0.6-py3-none-any.whl |
|---|---|
| Size | 12.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9dd4ec1b0f42e83d5a7e78cea63155fa989062a3933f4345b2e2b6b26ab3e9f8
|
|
BLAKE2b-256 checksum How to use checksums |
7f7c78928debd15ca0231da23b6a61e6556c943bead7df327f3ed58d5f9643c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.
Transparency logSecurity for bmw-lobster-tool-codebeamer 1.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 1 file in this release has been uploaded with provenance metadata.
Attestation for bmw_lobster_tool_codebeamer-1.0.6-py3-none-any.whl
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
