Update/validator for Release v1.1.0 (#48)

Resolves #49
Resolves #46
Resolves #45
Resolves #44
Resolves #43
Resolves #42
Resolves #31

# Change Notes:
* remove doxygen xml support
* remove sqlite log processing only use plaint text for validation log output (simplification)
* move default rules into `rules` folder from `requirements-osi-3` folder
* replace progressbar with tqdm
* remove lzma decoding and encoding (simplification)
* bugfix: BaseMoving nested attribute validation
* bugfix: update yaml loading ruaml
* bugfix: setup.py fix the default rules folder copying into site-packages with different python versions
* remove protocpp from osi validator dependency
* Migrate pipeline from travisCI -> github workflow
* Remove kpi folder
* Remove pre-parsed rules in rules folder
* Remove lfs
* Remove lzma from docs
* Update test trace file
* Replace rules folder in docs
* Port rst to adoc
* Update links readme
* Added example command
* Update README.md
* update venv instructions
* Created requirements_develop.txt for workflow
* Pinned package versions
* Used Python 3.8 in workflow
* bump actions versions
* pin black to black==23.12.1
* removed unused packages
* Update OSI submodule to version 3.6.0 (#54)
* Use same protobuffer version as in OSI repository
* use protobuf 3.20.1 in ci workflow and pin version to the same version in requirements.txt and setup.py
* remove optional installation method in README
* allow higher package versions
* bump year in license
* add git+osi requirement
* add note about OSI CCB
* Fix parallel run
---------

Signed-off-by: Carlo van Driesten <[email protected]>
Signed-off-by: ClemensLinnhoff <[email protected]>
Co-authored-by: Viktor Kreschenski <[email protected]>
Co-authored-by: Carlo van Driesten <[email protected]>

.github/workflows/ci.yml

@@ -0,0 +1,106 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.8"
+
+    - name: Upgrade pip
+      run: python -m pip install --upgrade pip
+
+    - name: Install dependencies
+      run: pip install -r requirements_develop.txt
+
+    - name: Check black format 
+      run:  black --check --diff --exclude "(open-simulation-interface|proto2cpp|.venv)" .
+
+    - name: Check dead code with vulture
+      run: vulture *.py tests/ osivalidator/ --min-confidence 100
+
+  build-validator:
+    strategy:
+      fail-fast: false
+      matrix:
+        runs-on: [ubuntu-latest]
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+
+    name: "🐍 ${{ matrix.python-version  }} • ${{ matrix.runs-on }}"
+    runs-on: ${{ matrix.runs-on }}
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        lfs: true
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache Dependencies
+      id: cache-depends
+      uses: actions/cache@v3
+      with:
+        path: protobuf-3.20.1
+        key: ${{ runner.os }}-v2-depends
+
+    - name: Download ProtoBuf
+      if: steps.cache-depends.outputs.cache-hit != 'true'
+      run: curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.20.1/protobuf-all-3.20.1.tar.gz && tar xzvf protobuf-all-3.20.1.tar.gz
+
+    - name: Build ProtoBuf
+      if: steps.cache-depends.outputs.cache-hit != 'true'
+      working-directory: protobuf-3.20.1
+      run: ./configure DIST_LANG=cpp --prefix=/usr && make
+
+    - name: Install ProtoBuf
+      working-directory: protobuf-3.20.1
+      run: sudo make install && sudo ldconfig
+
+    - name: Install Open Simulation Interface
+      shell: bash
+      run: |
+        git submodule update --init
+        python -m venv .venv
+        source .venv/bin/activate
+        python -m pip install --upgrade pip
+        pip install -r requirements_develop.txt
+        cd open-simulation-interface && pip install . && cd .. 
+
+    - name: Generate parsed rules
+      run: |
+        source .venv/bin/activate
+        pip install -r requirements.txt
+        python rules2yml.py -d rules
+
+    - name: Check rule correctness with unittests
+      run: |
+        source .venv/bin/activate
+        python -m unittest discover tests
+    
+    - name: Run osi-validator
+      run: |
+        source .venv/bin/activate
+        pip install .
+        osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.txt -r rules
+        osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.txt -r rules --parallel
+        osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.osi -r rules
+        osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.osi -r rules --parallel

.gitignore

@@ -87,6 +87,7 @@ celerybeat-schedule
 .venv
 env/
 venv/
+.venv/
 ENV/
 env.bak/
 venv.bak/
@@ -117,4 +118,7 @@ output_logs/
 tests/overtake_right_straight_SensorView.txt
 
 # OSI Data Messages
-osi_message_data/
+osi_message_data/
+
+# OSI Rules
+rules/

.gitmodules

@@ -1,7 +1,3 @@
 [submodule "open-simulation-interface"]
 	path = open-simulation-interface
 	url = https://github.com/OpenSimulationInterface/open-simulation-interface.git
-
-[submodule "proto2cpp"]
-	path = proto2cpp
-	url = https://github.com/OpenSimulationInterface/proto2cpp.git