Add new QL endpoints of /v2/attr and /v2/attr/{attr_name}

.gitignore

@@ -8,7 +8,6 @@ __pycache__
 *.log
 .project
 .pydevproject
-
 *.yml
 # include issue branch workflows
 !.github/workflows/issue-tracker.yml
@@ -41,6 +40,6 @@ venv
 /filip/external_resources/unece-units-of-measure.hdf
 /external_resources/
 
-/examples/data_models/
+/examples/ngsi_v2/data_models/
 /tests/semantics/models.py
 /tests/semantics/models2.py

.gitlab-ci.yml

@@ -3,22 +3,29 @@ stages:
     - doc
     - code_quality
     - build
+    - release
     - deploy
 
 variables:
-    EXCLUDE_PYTHON: 36
+    EXCLUDE_PYTHON: 37
+    PYTHON_VERSION: "registry.git.rwth-aachen.de/ebc/ebc_all/gitlab_ci/templates:python_3.9"
     PAGES_BRANCH: master
+    GIT_REPO: "RWTH-EBC/FiLiP"
+    PYTHON_VERSION_NAME: "__version__"
+    PYTHON_PACKAGE_NAME: "filip"
 
 include:
     - project: 'EBC/EBC_all/gitlab_ci/templates'
       file: 'python/code-quality/pylint.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'
       file: 'python/doc/sphinxdoc.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'
-      file: 'pages/pages.gitlab-ci.yml'
+      file: 'pages/gl-pages.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'
-      file: 'python/unit-tests/unittest.gitlab-ci.yml'
+      file: 'python/tests/tests.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'
-      file: 'python/unit-tests/coverage.gitlab-ci.yml'
+      file: 'python/tests/coverage.gitlab-ci.yml'
+    - project: 'EBC/EBC_all/gitlab_ci/templates'
+      file: 'python/pypi-release/release.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'
       file: 'python/build/build.gitlab-ci.yml'

CHANGELOG.md

@@ -1,4 +1,59 @@
+### v0.4.2
+- 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))
+- fix: rework tutorials for pydantic v2 ([#259](https://github.com/RWTH-EBC/FiLiP/pull/259))
+
+### v0.4.1
+- fix: Session added as optional parameter to enable tls communication with clients ([#249](https://github.com/RWTH-EBC/FiLiP/pull/249))
+- fix: add missing package ``geojson_pydantic`` in setup.py ([#276](https://github.com/RWTH-EBC/FiLiP/pull/276))
+- add: support entity creation with keyvalues ([#264](https://github.com/RWTH-EBC/FiLiP/pull/264))
+
+#### v0.4.0
+- add tutorial for protected endpoint with bearer authentication ([#208](https://github.com/RWTH-EBC/FiLiP/issues/208))
+- add internal mqtt url for unittests @djs0109 ([#239](https://github.com/RWTH-EBC/FiLiP/pull/239))
+- fix: compare subscriptions to prevent duplicated notifications @FWuellhorst, @RCX112 ([#138](https://github.com/RWTH-EBC/FiLiP/pull/138))
+- update pandas version to `~=2.1.4` for `python>=3.9` ([#231](https://github.com/RWTH-EBC/FiLiP/pull/231))
+- fix: wrong msg in iotac post device ([#214](https://github.com/RWTH-EBC/FiLiP/pull/214))
+- add support to update entities with keyValues @djs0109 ([#245](https://github.com/RWTH-EBC/FiLiP/pull/245))
+- add function to override the existing entity ([#232 ](https://github.com/RWTH-EBC/FiLiP/pull/232 ))
+- fix: remove root slash from paths ([#251](https://github.com/RWTH-EBC/FiLiP/issues/251))
+- fix: include headers in some requests ([#250](https://github.com/RWTH-EBC/FiLiP/issues/250))
+- add: `forcedUpdate` and missing `overrideMetadata` in request parameters ([#236](https://github.com/RWTH-EBC/FiLiP/pull/236))
+- feat: make context-entity more customizable ([#225](https://github.com/RWTH-EBC/FiLiP/issues/225))
+- feat: add geojson support to context-entity ([#226](https://github.com/RWTH-EBC/FiLiP/issues/226))
+
+BREAKING CHANGE:
+- feat: make context-entity more customizable ([#225](https://github.com/RWTH-EBC/FiLiP/issues/225)) enforces stricter type validation as before. This might lead to errors in your code if you are not using the correct types. Please check the documentation for the correct types.
+
+#### v0.3.0
+- fix: bug in typePattern validation @richardmarston ([#180](https://github.com/RWTH-EBC/FiLiP/pull/180))
+- add: add messages to all KeyErrors @FWuellhorst ([#192](https://github.com/RWTH-EBC/FiLiP/pull/192))
+- add: optional module `semantics` in setup tool @djs0109
+- fix: get() method of Units dose not work properly by @djs0109 ([#193](https://github.com/RWTH-EBC/FiLiP/pull/193))
+- BREAKING CHANGE: Migration of pydantic v1 to v2 @djs0109 ([#199](https://github.com/RWTH-EBC/FiLiP/issues/199))
+
+#### v0.2.5
+- fixed service group edition not working ([#170](https://github.com/RWTH-EBC/FiLiP/issues/170))
+- fixed service group can not be retrieved by apikey and resource ([#169](https://github.com/RWTH-EBC/FiLiP/issues/169))
+- add new argument `strict_data_type` to entity.get_attributes to allow disabling the validator of data types ([#182](https://github.com/RWTH-EBC/FiLiP/issues/182))
+
+#### v0.2.4
+- fixed ContextAttribute: wrong type conversion for value ([#173](https://github.com/RWTH-EBC/FiLiP/issues/173))
+- fixed Change does_entity_exists create error message if entity does not exist ([#167](https://github.com/RWTH-EBC/FiLiP/issues/167))
+- fixed remove additional escape chars when sending a string ([#163](https://github.com/RWTH-EBC/FiLiP/issues/163))
+
 #### v0.2.3
+- added `override_metadata` argument according to new metadata update semantics in orion (https://fiware-orion.readthedocs.io/en/master/user/metadata.html#updating-metadata) ([#157](https://github.com/RWTH-EBC/FiLiP/issues/157))
+- fixed test for patch_entity ([#157](https://github.com/RWTH-EBC/FiLiP/issues/157))
+- added flag to ntoify only changed attributes ([#154](https://github.com/RWTH-EBC/FiLiP/issues/154))
+- fixed issue of client generation when multiple clients are required ([#151](https://github.com/RWTH-EBC/FiLiP/issues/151))
+- fixed throttling=0 is not working when posting a subscription ([#148](https://github.com/RWTH-EBC/FiLiP/issues/148))
+- added filter functions for better subscription handling ([#141](https://github.com/RWTH-EBC/FiLiP/issues/141))
+- added filter functions for better device handling ([#143](https://github.com/RWTH-EBC/FiLiP/issues/143))
+- fixed coupled delete of devices and entities ([#143](https://github.com/RWTH-EBC/FiLiP/issues/143))
 - Add images to tutorials ([#139](https://github.com/RWTH-EBC/FiLiP/issues/139))
 
 #### v0.2.2

CONTRIBUTING.md

@@ -1,44 +1,46 @@
 # Contribute as a user
 
 The documentation, examples and tutorials should be understandable and the code bug-free.
-As all user's have different backgrounds, you may not understand everything or encounter bugs.
-In that case, PLEASE raise an issue [here](https://github. com/RWTH-EBC/filip/issues/new).
+As all users have different backgrounds, you may not understand everything or encounter bugs.
+In that case, PLEASE raise an issue [here](https://github.com/RWTH-EBC/filip/issues/new).
 
-Consider labeling the issue using the flag `bug` or `documentation` / `question`.
+Consider labeling the issue with an [appropriate label](https://github.com/RWTH-EBC/FiLiP/labels).
 
 # Contribute as a developer
 
 If you instead want to contribute new features or fix bugs yourself, we are more than happy.
 
-Please also [raise an issue](https://github.com/RWTH-EBC/filip/issues/new) 
-create a new branch labeled `XY_some_name`.
-Here, `XY` is the number of your issue and `some_name` is a meaningful 
-description.
-Alternatively and preferred, issue branches are created automatically on issue 
-assignment with [robvanderleek/create-issue-branch](https://github.com/robvanderleek/create-issue-branch).
+Please [raise an issue](https://github.com/RWTH-EBC/filip/issues/new).
+Issue branches are created automatically on issue assignments.
 
 See [workflow definition](.github/workflows/issue-tracker.yml) and 
 [configuration file](.github/issue-branch.yml) for customization.
 
-Branch creation is skipped for issues with label "question".
+Branch creation is skipped for issues with the label "question".
 
-Once you're feature is ready, create a pull request and check if the pipeline succeeds.
+Once your feature is ready, create a pull request and check if the pipeline succeeds.
 Assign a reviewer before merging. 
 Once review is finished, you can merge.
 
 **Before** implementing or modifying modules, classes or functions, please read the following page.
 
-## Styleguide
+## Style guides
 
-We use PEP8 as a styleguide. Some IDEs (like PyCharm) automatically show you code that is not in PEP8. If you don't have such an IDE, please read [this page](https://pep8.org/) to get a better understanding of it.
+### Coding style guide
+
+We use PEP8 as a coding style guide. Some IDEs (like PyCharm) automatically show you code that is not in PEP8. If you don't have such an IDE, please read [this page](https://pep8.org/) to get a better understanding of it.
+
+### Committing style guide
+
+For committing style guide please use Conventional Commits 1.0.0. For more details how to structure your commits please visit this [page](https://www.conventionalcommits.org/en/v1.0.0/).
 
 ## Documentation
 
-All created or modified function should be documented properly. 
+All created or modified functions should be documented properly. 
 Try to follow the structure already present. 
-If possible, write a little doctest example into the docstring to make clear to user's what the desired output of your function is. 
+If possible, write a little doctest example into the docstring to make clear to the user what the desired output of your function is. 
 All non-self-explanatory lines of code should include a comment. 
-Although you will notice that not all docstring are already in this style we use the google-style for docstrings, e.g.
+Although you will notice that not all docstring are already in this style, we use the google-style for docstrings, e.g.
 
 ```python
 
@@ -57,23 +59,25 @@ def foo(dummy: str , dummy2: Union[str, int]):
 
 Furthermore, we use type annotations as this helps users to automatically 
 identify wrong usage of functions. 
-In a further step type annotations may also help to accelerate your code. 
-For further details please check the official [documentation on type hints](https://docs.python.org/3/library/typing.html).
+In a further step, type annotations may also help to accelerate your code. 
+For more details please check the official [documentation on type hints](https://docs.python.org/3/library/typing.html).
 
 ## Unit-Tests
-Espacially when creating new functions or classes, you have to add a unit-test function.
-Open the `test_module.py` file in the `\tests`-directory and add a function to the class `TestModule`with a name like `test_my_new_function`. If you create a new module, you have to create a new `test_my_new_module.py` file and follow the existing structure of the 
-other test-files.
+Especially when creating new functions or classes, you have to add a unit-test function.
+Tests are located in the `\tests` directory. Every file that includes tests has a `test_` prefix. 
+Open the appropriate module where you want to write a test and add an appropriate function.
+When you are adding tests to an existing test file, it is also recommended that you study the other tests in that file; it will teach you which precautions you have to take to make your tests robust and portable.
+If the corresponding module does not exist, then you should create a new module with `test_` prefix and appropriate name. 
 
 If you are not familiar with unit-tests, here is a quick summary:
-- Test as many things as possible. Even seemingly silly tests like correct input-format help prevent future problems for new users
-- use the `self.assertSOMETHING` functions provided by `unittest`. This way a test failure is presented correctly An error inside your test function will not be handeled as a failure but an error.
-- If the success of your test depends on the used device, you can use decorators like `skip()`, `skipif(numpy.__version__<(1, 0), "not supported with your numpy version")`, etc. 
-- `setUp()` and `tearDown()` are called before and after each test. Use this functions to define parameters used in every test, or to close applications like Dymola once a test is completed.
-- See the [unittest-documentation](https://docs.python.org/3/library/unittest.html#organizing-tests) for further information
+- Test as many things as possible. Even seemingly silly tests like correct input-format help prevent future problems for new users.
+- Use the `self.assertSOMETHING` functions provided by `unittest`. This way a test failure is presented correctly. An error inside your test function will not be handled as a failure but as an error.
+- If the success of your test depends on the used development environment, you can use decorators like `skip()`, `skipif(numpy.__version__<(1, 0), "not supported with your numpy version")`, etc. 
+- `setUp()` and `tearDown()` are called before and after each test. Use these functions to define parameters used in every test, or to close applications like Dymola once a test is completed.
+- See the [unittest-documentation](https://docs.python.org/3/library/unittest.html#organizing-tests) for further information.
 
-You can check your work by running all tests before commiting to git. 
+You can check your work by running all tests before committing to git. 
 
 ## Pylint
 With pylint we try to keep our code clean.  
-See the description in [this repo](https://git.rwth-aachen.de/EBC/EBC_all/gitlab_ci/templates/tree/master/pylint) on information on what pylint is and how to use it.
+[Here](https://pypi.org/project/pylint/) you can read more about Pylint and how to use it.

LICENSE.md

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2021
+Copyright (c) 2021-2022
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without