Skip to content

Commit

Permalink
Update distribution package name to asam-qc-openscenarioxml (#44)
Browse files Browse the repository at this point in the history
Signed-off-by: patrickpa <patrick@ivex.ai>
  • Loading branch information
patrickpa authored Aug 19, 2024
1 parent d660e2f commit 38addd0
Show file tree
Hide file tree
Showing 6 changed files with 610 additions and 8 deletions.
49 changes: 45 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,33 @@ This project implements the OpenScenario Checker for the ASAM Quality Checker pr

## Installation

There are two options of usage of the project:

1. Default python on the machine
2. [Poetry](https://python-poetry.org/)

To install the project, run:

**Default python**

```
pip install -r requirements.txt
```

This will install the needed dependencies to your local Python.

**Poetry**

```
poetry install
```

## Usage

The checker can be used as a Python script:

**Default python**

```
python main.py --help
usage: QC OpenScenario Checker [-h] (-d | -c CONFIG_PATH)
Expand All @@ -26,6 +41,18 @@ options:
-c CONFIG_PATH, --config_path CONFIG_PATH
```

**Poetry**

```
poetry run python main.py --help
usage: QC OpenScenario Checker [-h] (-d | -c CONFIG_PATH)
This is a collection of scripts for checking validity of OpenScenario (.xosc) files.
options:
-h, --help show this help message and exit
-d, --default_config
-c CONFIG_PATH, --config_path CONFIG_PATH
```

### Example

- No issues found
Expand All @@ -40,7 +67,6 @@ asam.net:xosc:0.9.0:is_an_xml_document
2024-06-12 15:14:11,865 - Done
```


- Issues found on file

```
Expand All @@ -54,24 +80,39 @@ asam.net:xosc:0.9.0:is_an_xml_document
```


## Tests

To run the tests, you need to have installed the main dependencies mentioned
at [Installation](#installation).

Install Python tests and development dependencies:
**Install Python tests and development dependencies:**

**Default python**

```
pip install -r requirements-tests.txt
```

Execute tests:
**Poetry**

```
poetry install --with dev
```

**Execute tests:**

**Default python**

```
python -m pytest -vv
```

**Poetry**

```
poetry run pytest -vv
```

They should output something similar to:

```
Expand Down
Loading

0 comments on commit 38addd0

Please sign in to comment.