update version

.coveragerc

@@ -4,6 +4,8 @@ omit =
     */test*
 	# omit deprecated code
 	*/deprecated*
+	# omit semantics module
+	filip/semantics/*
 source =
 	filip
 [report]

.env.filip.EXAMPLE

@@ -0,0 +1,9 @@
+# Global settings for filip
+# If needed (for example for running examples) copy the content to another
+# local file `.env.filip` in the root folder, i.e., ".../FiLiP/.env.filip"
+# Do not add the created `.env.filip` to the git
+CB_URL="http://localhost:1026"
+LD_CB_URL="http://localhost:1027"
+IOTA_URL="http://localhost:4041/"
+QL_URL="http://localhost:8668"
+MQTT_BROKER_URL="mqtt://localhost:1883"

.github/ISSUE_TEMPLATE/release_prepare.md

@@ -0,0 +1,29 @@
+---
+name: Release Preparation
+about: Track tasks for preparing a new release
+title: 'Release Preparation: vX.X.X'
+labels: release
+assignees: ''
+
+---
+
+**Release Version**
+Specify the version number for the release (e.g., v0.7.1):
+
+**What is changed?**
+TODO: please at least copy the release note here, afterwards
+
+**Checklist**
+Following steps will be checked:
+- [ ] Revise the changelog if necessary
+- [ ] Update the version tag in:
+  - [ ] `filip/__init__.py`
+  - [ ] `Changelog`
+- [ ] Check dependencies in `setup.py`, especially when a new library is introduced
+- [ ] Check other information in `setup.py`
+
+After that, create a pull request and merge it (merge commit) to `master` branch with a commit message containing `[PYPI-RELEASE]`.
+
+
+**Additional Context**
+Add any other context or notes related to the release preparation here.

.github/dependabot.yml

@@ -0,0 +1,29 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  # Enable version updates for Python dependencies
+  - package-ecosystem: "pip"
+    directory: "/" # location of the setup.py
+    schedule:
+      interval: "monthly"
+    allow:
+      # Allow updates on explicit dependency
+      - dependency-type: "direct"
+    ignore:
+      # Ignore updates for specific dependencies
+      - dependency-name: "sphinx"
+      - dependency-name: "autodoc-pydantic"
+      - dependency-name: "sphinx-autobuild"
+      - dependency-name: "m2r2"
+      - dependency-name: "sphinx-rtd-theme"
+      - dependency-name: "igraph"
+      - dependency-name: "plotly"
+      - dependency-name: "matplotlib"
+      - dependency-name: "pre-commit"
+    commit-message:
+      prefix: "[pip dependency]"
+    open-pull-requests-limit: 5

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: Python CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  ci:
+    uses: RWTH-EBC/ci_templates/.github/workflows/ci_pipeline.yml@main
+    secrets:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
+      PYPI_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+    with:
+      PYTHON_VERSION: "3.10"
+      USE_PYLINT: true
+      BUILD_PACKAGE: true
+      GENERATE_DOCUMENTATION: true
+      GH_PAGES: true
+      FIWARE_TESTS: true
+      FIWARE_COVERAGE: true
+      FIWARE_DIRECTORY: './filip_unittest/docker'
+      PYTHON_PACKAGE_NAME: 'filip'
+      PYPI_RELEASE: true
+      TEST_PATH: './tests'
+      TEST_ENV_VARS: '["CB_URL=http://localhost:1026","ORION_LD_URL=http://localhost:1027","IOTA_URL=http://localhost:4041","IOTA_JSON_URL=http://localhost:4041","IOTA_UL_URL=http://localhost:4061","QL_URL=http://localhost:8668","MQTT_BROKER_URL=mqtt://localhost:1883","MQTT_BROKER_URL_INTERNAL=mqtt://mqtt-broker:1883","LD_MQTT_BROKER_URL=mqtt://localhost:1883","LD_MQTT_BROKER_URL_INTERNAL=mqtt://mqtt-broker:1883","FIWARE_SERVICE=filip","FIWARE_SERVICEPATH=/"]'
+      PYTHON_TEST_MATRIX: '["3.9", "3.10", "3.11", "3.12"]'    #List of Python versions to run tests against as a matrix
+      HEALTHCHECK_URLS: "http://localhost:1026/version http://localhost:1027/version http://localhost:4041/version http://localhost:4061/version http://localhost:8668/version http://localhost:4200"

.github/workflows/compatibility-test.yml

@@ -0,0 +1,99 @@
+name: Matrix Tests for Orion and IoT-Agent-JSON
+
+on:
+  push:
+    branches:
+      - "418-update-versions-for-fiware-ges"
+  workflow_dispatch:
+
+jobs:
+  matrix-test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        orion_version: ["4.1.0", "4.0.0", "3.12.0", "3.11.0", "3.10.0", "3.9.0", "3.8.0", "3.7.0", "3.6.0"]
+        iot_json_version: ["3.7.0", "3.6.0", "3.5.0", "3.4.0", "3.3.0", "3.2.0", "3.1.0", "3.0.2", "2.4.2", "2.3.0",
+                    "1.26.0", "1.25.0"]
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Debug - Verify Repository Structure
+        run: |
+          pwd
+          ls -la
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Create .env file
+        run: |
+          cat <<EOF > .env
+          LOG_LEVEL="INFO"
+          CB_URL=http://localhost:1026
+          ORION_LD_URL=http://localhost:1027
+          IOTA_JSON_URL=http://localhost:4041
+          IOTA_UL_URL=http://localhost:4061
+          QL_URL=http://localhost:8668
+          MQTT_BROKER_URL=mqtt://localhost:1883
+          MQTT_BROKER_URL_INTERNAL=mqtt://mqtt-broker:1883
+          LD_MQTT_BROKER_URL=mqtt://localhost:1883
+          LD_MQTT_BROKER_URL_INTERNAL=mqtt://mqtt-broker:1883
+          FIWARE_SERVICE=filip
+          FIWARE_SERVICEPATH=/
+          STATIC_RECORDS=1000
+          EOF
+
+      - name: Verify .env file
+        run: cat .env
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel
+          pip install .
+          pip install jinja2 pytest
+
+      - name: Generate docker-compose.yml
+        run: |
+          cd filip_unittest/docker
+          python generate-compose.py ${{ matrix.orion_version }} ${{ matrix.iot_json_version }}
+
+      - name: Start containers
+        run: |
+          cd filip_unittest/docker
+          docker compose up -d
+
+      - name: Wait for FIWARE Services
+        run: |
+          for i in {1..30}; do
+            curl -s http://localhost:1026/version && \
+            curl -s http://localhost:1027/version && \
+            curl -s http://localhost:4061/version && \
+            curl -s http://localhost:4041/version && \
+            curl -s http://localhost:8668/version && break || sleep 5
+          done
+
+      - name: Debug - Show Running Docker Containers
+        run: docker ps -a
+
+      - name: Navigate to Tests Folder
+        run: |
+          cd $GITHUB_WORKSPACE
+          ls -la
+
+      - name: Run Pytest
+        run: |
+          python -m unittest tests/clients/test_ngsi_v2_cb.py
+          python -m pytest tests
+
+      - name: Tear down containers
+        if: always()
+        run: |
+          cd filip_unittest/docker
+          docker compose down -v

.gitignore

@@ -12,8 +12,11 @@ __pycache__
 # include issue branch workflows
 !.github/workflows/issue-tracker.yml
 !.github/issue-branch.yml
+!.github/workflows/unittest.yml
+!filip_unittest/docker/docker-compose.yml
 
 *.yaml
+!.pre-commit-config.yaml
 
 # pip install #
 #####################
@@ -23,13 +26,14 @@ __pycache__
 dist
 *.pypirc
 build
+requirements.txt
 
 # PyCharm #
 #####################
 .idea
 .cache
 venv
-
+.venv
 # Unittest #
 #####################
 .pytest_cache
@@ -43,3 +47,4 @@ venv
 /examples/ngsi_v2/data_models/
 /tests/semantics/models.py
 /tests/semantics/models2.py
+/.env.filip

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+  # Using black mirror since it's 2x faster https://black.readthedocs.io/en/stable/integrations/source_version_control.html
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.10.0
+    hooks:
+      - id: black
+        # Specifying the latest version of Python supported by Filip
+        language_version: python

CHANGELOG.md

@@ -1,6 +1,98 @@
-### v0.4.2
+### v0.7.5
+- fix: allow dynamic header composition in v2 http client ([#493](https://github.com/RWTH-EBC/FiLiP/pull/493))
+- fix: allow non-standard attribute types when updating ContextEntity ([#497](https://github.com/RWTH-EBC/FiLiP/pull/497))
+
+### v0.7.4
+- fix: various bug fixes regarding query string and its regex ([#469](https://github.com/RWTH-EBC/FiLiP/pull/469))
+- fix: fixed outdated module overview diagram ([#467](https://github.com/RWTH-EBC/FiLiP/pull/467))
+- fix: ignore password field while checking duplicated subscription ([#471](https://github.com/RWTH-EBC/FiLiP/pull/471))
+- fix: make unit model hashable ([#479](https://github.com/RWTH-EBC/FiLiP/pull/479))
+- update: ignore difference of the order of list elements while checking duplicated subscription ([#474](https://github.com/RWTH-EBC/FiLiP/pull/474))
+
+### v0.7.3
+- update: error handling for get devices list ([#451](https://github.com/RWTH-EBC/FiLiP/pull/451))
+- update: link FIWARE badges in README.md ([#463](https://github.com/RWTH-EBC/FiLiP/pull/463))
+- fix: falsy value handling on update_entity_attribute ([#454](https://github.com/RWTH-EBC/FiLiP/pull/454))
+- add: warning if ``Orion`` version is not supported ([#200](https://github.com/RWTH-EBC/FiLiP/issues/200))
+- add: support pagination for get_entity_list of NGSI-LD ([#456](https://github.com/RWTH-EBC/FiLiP/pull/457))
+- add: version checker for correct cb version ([#200](https://github.com/RWTH-EBC/FiLiP/pull/200))
+- add: pagination for get entity list in NGSI-LD client ([#457](https://github.com/RWTH-EBC/FiLiP/pull/457))
+- add: new example for uploading existing dataset ([#453](https://github.com/RWTH-EBC/FiLiP/pull/453))
+
+### v0.7.2
+- update: move rdflib requirement to ``semantics`` extras
+
+### v0.7.1
+- update: relax rdflib requirements to allow rdflib<=6.1.1 ([#446](https://github.com/RWTH-EBC/FiLiP/issues/446))
+
+### v0.7.0
+- add: flag to decide on whether ignore invalid entities in get_entity_list ([#416](https://github.com/RWTH-EBC/FiLiP/pull/416))
+- add: system params like ``lastSuccess`` to notification model ([#441](https://github.com/RWTH-EBC/FiLiP/pull/441))
+- add: NGSI-LD convertion functions between keyvalues and normal entity format ([#443](https://github.com/RWTH-EBC/FiLiP/pull/443))
+- add: flag to decide on whether ignore invalid entities in get_entity_list ([#416](https://github.com/RWTH-EBC/FiLiP/pull/416))
+- add: NGSI-LD examples ([#432](https://github.com/RWTH-EBC/FiLiP/pull/432))
+- fix: handle large amount of data in clear context broker ([#419](https://github.com/RWTH-EBC/FiLiP/pull/419))
+- update: allow UTF-8 characters in attribute values ([#437](https://github.com/RWTH-EBC/FiLiP/pull/437))
+- update: stop testing python 3.8 in workflow ([#441](https://github.com/RWTH-EBC/FiLiP/pull/441))
+- update: adapt the behavior of `patch_entity` to align with the API specification ([#429](https://github.com/RWTH-EBC/FiLiP/pull/429))
+
+### v0.6.3
+- add: Unittest workflow via Github actions ([#388](https://github.com/RWTH-EBC/FiLiP/pull/388))
+- add: Context conversion methods to_keyvalues() and to_normalized() ([#393](https://github.com/RWTH-EBC/FiLiP/pull/393))
+- fix: relationship validation can not handle empty attributes ([#411](https://github.com/RWTH-EBC/FiLiP/pull/411))
+- fix:relationship and properties cannot be created via predefined models ([#412](https://github.com/RWTH-EBC/FiLiP/pull/412))
+- fix: LD entity model ignore unset properties ([#402](https://github.com/RWTH-EBC/FiLiP/pull/402))
+
+### v0.6.2
+- add: New features to validate and update relationships for V2 entities ([#380](https://github.com/RWTH-EBC/FiLiP/pull/380))
+- add: ngsi-ld support for entity creation and update with keyvalues format ([#394](https://github.com/RWTH-EBC/FiLiP/pull/394))
+- fix: exception handling for special characters in attribute value  ([#381](https://github.com/RWTH-EBC/FiLiP/pull/381))
+- update: relax pydantic requirements ([#390](https://github.com/RWTH-EBC/FiLiP/pull/390))
+- update: pandas requirement from ~=1.3.5 to >=1.3.5,<2.3.0 ([#396](https://github.com/RWTH-EBC/FiLiP/pull/396))
+
+### v0.6.1
+- add: Tutorial for saving live timeseries data (e.g., forecast) in context broker and timeseries database ([#363](https://github.com/RWTH-EBC/FiLiP/pull/363))
+- add: Tutorial for using session object ([#370](https://github.com/RWTH-EBC/FiLiP/pull/370))
+- add: Validation of quotation mark in ``q`` strings for NGSI-LD ``get_entities_list`` ([#383](https://github.com/RWTH-EBC/FiLiP/pull/383/files))
+- fix: Addition of trailing slash if missing from base url ([#371](https://github.com/RWTH-EBC/FiLiP/pull/371))
+- fix: Serialization error for custom datamodels during batch operation ([#376](https://github.com/RWTH-EBC/FiLiP/pull/376))
+- update: omit invalid entities in `get_entity_list` ([#375](https://github.com/RWTH-EBC/FiLiP/pull/375))
+
+### v0.6.0
+- add: Tutorial for connecting with secured endpoints ([#319](https://github.com/RWTH-EBC/FiLiP/pull/319))
+- add: Example for notification based command ([#332](https://github.com/RWTH-EBC/FiLiP/pull/332))
+- add: tests for clear functions ([#336](https://github.com/RWTH-EBC/FiLiP/pull/336))
+- 🚀 **add: API client for NGSI-LD context broker** ([#338](https://github.com/RWTH-EBC/FiLiP/pull/338)
+,[#356](https://github.com/RWTH-EBC/FiLiP/pull/356)
+,[#327](https://github.com/RWTH-EBC/FiLiP/pull/327)
+,[#300](https://github.com/RWTH-EBC/FiLiP/pull/300)
+,[#301](https://github.com/RWTH-EBC/FiLiP/pull/301)
+,[#212](https://github.com/RWTH-EBC/FiLiP/pull/212)
+,[#222](https://github.com/RWTH-EBC/FiLiP/pull/222)
+,[#221](https://github.com/RWTH-EBC/FiLiP/pull/221)
+  )
+- fix: clear functions for context broker ([#336](https://github.com/RWTH-EBC/FiLiP/pull/336))
+- fix: validation error of ``ngsipayloadattr`` when the attribute substitution is used([#351](https://github.com/RWTH-EBC/FiLiP/pull/351))
+- update: integrate the key-values endpoints with normalized endpoints ([#318](https://github.com/RWTH-EBC/FiLiP/pull/318))
+- remove: ``update_entity_attributes_key_values`` and ``update_entity_key_values`` are removed ([#318](https://github.com/RWTH-EBC/FiLiP/pull/318))
+
+
+### v0.5.0
+- update: allow duplicated name in device, check uniqueness of object_id ([#279](https://github.com/RWTH-EBC/FiLiP/pull/279))
+- update: upgrade dependency of `paho-mqtt` to v2 ([#273](https://github.com/RWTH-EBC/FiLiP/pull/273/))
+- add: `json` and `ngsi` as payload format in custom notification model ([#296](https://github.com/RWTH-EBC/FiLiP/pull/296))
+- add: support alterationTypes in subscription model ([#293](https://github.com/RWTH-EBC/FiLiP/pull/293))
 - add: validation for JEXL based expression ([#260](https://github.com/RWTH-EBC/FiLiP/pull/260))
 - add: tutorials for multi-entity ([#260](https://github.com/RWTH-EBC/FiLiP/pull/260))
+- add: add ``update_entity_relationships`` to allow relationship update ([#271](https://github.com/RWTH-EBC/FiLiP/pull/271))
+- add: timeseries query with all attrs and specific attr name ([#16](https://github.com/RWTH-EBC/FiLiP/pull/16))
+- add: flag to determine the deletion of registration when clearing the CB ([#267](https://github.com/RWTH-EBC/FiLiP/pull/267))
+- add: ``covered`` flag in notification model ([#310](https://github.com/RWTH-EBC/FiLiP/pull/310))
+- fix: rework tutorials for pydantic v2 ([#259](https://github.com/RWTH-EBC/FiLiP/pull/259))
+- fix: inconsistency of `entity_type` as required argument ([#188](https://github.com/RWTH-EBC/FiLiP/pull/188))
+- fix: allow empty string in attribute value validation ([#311](https://github.com/RWTH-EBC/FiLiP/pull/311))
+
+BREAKING CHANGE: upgrade dependency of `paho-mqtt` to v2 ([#273](https://github.com/RWTH-EBC/FiLiP/pull/273/))
 
 ### v0.4.1
 - fix: Session added as optional parameter to enable tls communication with clients ([#249](https://github.com/RWTH-EBC/FiLiP/pull/249))