Merge pull request #217 from RWTH-EBC/216-Release-v0-3-0

216 release v0 3 0

CHANGELOG.md

@@ -2,8 +2,11 @@
 - add tutorial for protected endpoint with bearer authentication ([#208](https://github.com/RWTH-EBC/FiLiP/issues/208))
 
 #### v0.3.0
-- fixed inconsistency of `entity_type` as required argument ([#188](https://github.com/RWTH-EBC/FiLiP/issues/188))
-- BREAKING CHANGE: Migration of pydantic v1 to v2 ([#199](https://github.com/RWTH-EBC/FiLiP/issues/199))
+- 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))

README.md

@@ -83,6 +83,13 @@ If you want to benefit from the latest changes, use the following command
 pip install -U git+git://github.com/RWTH-EBC/filip
 ```
 
+#### Install semantics module (optional)
+
+If you want to use the optional [semantics module](filip/semantics), use the following command (This will install the libraries that only required for the semantics module):
+````
+pip install -U filip[semantics]
+````
+
 ### Introduction to FIWARE
 
 The following section introduces FIWARE. If you are already familiar with 
@@ -212,14 +219,15 @@ how you can contribute to this project.
 
 ## Authors
 
-* [Thomas Storek](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Team2/~lhda/Thomas-Storek/?lidx=1) (corresponding)
+* [Thomas Storek](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Team2/~lhda/Thomas-Storek/?lidx=1) 
+* [Junsong Du](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Digitale-Energie-Quartiere/~trcib/Du-Junsong/lidx/1/) (corresponding)
 * [Saira Bano](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Systemadministration/~ohhca/Bano-Saira/)
-* [Daniel Nikolay](https://www.ebc.eonerc.rwth-aachen.de/cms/E-ON-ERC-EBC/Das-Institut/Mitarbeiter/Systemadministration/~qcqxq/Nikolay-Daniel/)
 
 ## Alumni
 
 * Jeff Reding
 * Felix Rehmann
+* Daniel Nikolay
 
 ## References
 

filip/__init__.py

@@ -4,4 +4,4 @@
 from filip.config import settings
 from filip.clients.ngsi_v2 import HttpClient
 
-__version__ = '0.2.4'
+__version__ = '0.3.0'

requirements.txt

@@ -1,23 +1,23 @@
-requests>=2.23.0
-python-dotenv>=0.19.1
-pydantic>=2.0.2
-pydantic-settings>=2.0.1
-aenum>=3.0.0
-pathlib>=1.0.1
-regex>=2021.3.17
-pytz>=2019.1
-rapidfuzz>=1.7.1
-pandas>=1.2.0
-setuptools>=40.6.0
-pandas_datapackage_reader>=0.18.0
-python-Levenshtein>=0.12.2
-numpy>=1.21
-rdflib~=6.0.0
-python-dateutil>=2.8.2
-wget >=3.2
-stringcase>=1.2.0
-igraph==0.9.8
-paho-mqtt>=1.6.1
-datamodel_code_generator[http]>=0.21.3
+requests~=2.31.0
+python-dotenv>=0.21.0
+pydantic~=2.5.2
+pydantic-settings~=2.0.0
+aenum~=3.1.15
+pathlib~=1.0.1
+regex~=2023.10.3
+pytz~=2023.3.post1
+rapidfuzz~=3.4.0
+pandas~=1.3.5
+setuptools~=68.0.0
+pandas_datapackage_reader~=0.18.0
+python-Levenshtein~=0.23.0
+python-dateutil~=2.8.2
+wget~=3.2
+stringcase~=1.2.0
+paho-mqtt~=1.6.1
+datamodel_code_generator[http]~=0.25.0
 # tutorials
-matplotlib>=3.5.1
+matplotlib~=3.5.3
+# semantics
+rdflib~=6.0.0
+# igraph~=0.9.8

setup.py

@@ -7,25 +7,23 @@
 readme_path = Path(__file__).parent.joinpath("README.md")
 LONG_DESCRIPTION = readme_path.read_text()
 
-INSTALL_REQUIRES = ['aenum',
-                    'datamodel_code_generator[http]>=0.11.16',
-                    'paho-mqtt>=1.6.1',
-                    'pandas>=1.2',
-                    'pandas-datapackage-reader>=0.18.0',
-                    'pydantic>=2.0.2',
-                    'pydantic-settings>=2.0.1',
-                    'PyYAML',
+INSTALL_REQUIRES = ['aenum~=3.1.15',
+                    'datamodel_code_generator[http]~=0.25.0',
+                    'paho-mqtt~=1.6.1',
+                    'pandas~=1.3.5',
+                    'pandas_datapackage_reader~=0.18.0',
+                    'pydantic~=2.5.2',
+                    'pydantic-settings~=2.0.0',
                     'stringcase>=1.2.0',
-                    'igraph==0.9.8',
                     'rdflib~=6.0.0',
-                    'regex',
-                    'requests',
-                    'rapidfuzz',
-                    'wget']
+                    'regex~=2023.10.3',
+                    'requests~=2.31.0',
+                    'rapidfuzz~=3.4.0',
+                    'wget~=3.2']
 
 SETUP_REQUIRES = INSTALL_REQUIRES.copy()
 
-VERSION = '0.2.5'
+VERSION = '0.3.0'
 
 setuptools.setup(
     name='filip',
@@ -62,6 +60,10 @@
                                                'tutorials']),
     package_data={'filip': ['data/unece-units/*.csv']},
     setup_requires=SETUP_REQUIRES,
+    # optional modules
+    extras_require={
+        "semantics": ["igraph~=0.9.8"]
+    },
     install_requires=INSTALL_REQUIRES,
     python_requires=">=3.7",