Skip to content

Commit

Permalink
Update README with latest version
Browse files Browse the repository at this point in the history
Signed-off-by: patrickpa <[email protected]>
  • Loading branch information
patrickpa committed Jun 11, 2024
1 parent 7a15d37 commit 12167dc
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ From Pypi:
pip install qc_baselib
```

From Github repository:

```bash
pip install qc_baselib @ git+https://github.com/asam-ev/qc-baselib-py@main
```

Locally for developing using [Poetry](https://python-poetry.org/):

```bash
Expand Down Expand Up @@ -187,12 +193,22 @@ def main():
summary="Executed evaluation",
)

rule_uid = result.register_rule(
checker_bundle_name="TestBundle",
checker_id="TestChecker",
emanating_entity="test.com",
standard="qc",
definition_setting="1.0.0",
rule_full_name="qwerty.qwerty",
)

result.register_issue(
checker_bundle_name="TestBundle",
checker_id="TestChecker",
issue_id=0,
description="Issue found at odr",
level=IssueSeverity.INFORMATION,
rule_uid=rule_uid,
)

result.add_file_location(
Expand All @@ -204,7 +220,6 @@ def main():
file_type="odr",
description="Location for issue",
)
# xml location are also supported

result.write_to_file("testResults.xqar")

Expand Down

0 comments on commit 12167dc

Please sign in to comment.