Dev/platform v3.0.0 (#43)

*  support write-functionalities in KType
*  support new webform and custom properties in platform version 3.0.0
*  remove old custom property validation again new webform schema
*  update docs for KTypes
*  improve pretty printing
*  make upper restriction for pydantic
*  set max length of string-field names
*  add schema transformation function for backwards compability
*  add compability matrix
*  change context variable to session variable
*  remove 'NumericalDatatype' for unit conversion, make it compatiable with new webform version
*  add function to reorganize custom properties on demand
*  add pagination for kitem list and search
*  add validation of kitems in the custom property fields of type kitem
*  remove unneeded pytests
*  move cls of properties to self globally
*  make ktype_id strictly a str
*  update README
---------

Co-authored-by: Arjun Gopalakrishnan <[email protected]>

.gitignore

@@ -161,3 +161,6 @@ cython_debug/
 
 .vscode/
 examples/basic_usage.ipynb
+
+#Test files
+test.py

.pylintrc

@@ -77,6 +77,9 @@ disable= no-name-in-module,
     too-many-public-methods,
     too-many-locals,
     no-value-for-parameter,
+    too-many-branches,
+    too-many-lines,
+    too-many-statements,
 
 
 

README.md

@@ -37,6 +37,16 @@ The SDK provides a general Python interface to a remote DSMS deployment, allowin
 Please have a look at our documentation on _readthedocs_:
 https://dsms-python-sdk.readthedocs.io
 
+## Compatibility
+
+Please take the compability of the SDK version with the DSMS version into account:
+
+| SDK Version | DSMS Version |
+| --- | --- |
+| <2.0.0 | <2.0.0 |
+| >=2.0.0, <3.0.0 | >=2.0.0, <3.0.0 |
+| >=3.0.0 | >=3.0.0 |
+
 ## Tutorials
 
 Please have a look at our tutorials on _readthedocs_:
@@ -48,12 +58,13 @@ Please have a look at our tutorials on _readthedocs_:
 * [6. Apps](https://dsms-python-sdk.readthedocs.io/en/latest/dsms_sdk/tutorials/6_apps.html)
 
 Or try our Jupyter Notebooks:
-* [1. Introduction](examples/tutorials/1_introduction.ipynb)
-* [2. Creation](examples/tutorials/2_creation.ipynb)
-* [3. Updation](examples/tutorials/3_updation.ipynb)
-* [4. Deletion](examples/tutorials/4_deletion.ipynb)
-* [5. Search](examples/tutorials/5_search.ipynb)
-* [6. Apps](examples/tutorials/6_apps.ipynb)
+* [1. Introduction](docs/dsms_sdk/tutorials/1_introduction.ipynb)
+* [2. Creation](docs/dsms_sdk/tutorials/2_creation.ipynb)
+* [3. Updation](docs/dsms_sdk/tutorials/3_updation.ipynb)
+* [4. Deletion](docs/dsms_sdk/tutorials/4_deletion.ipynb)
+* [5. Search](docs/dsms_sdk/tutorials/5_search.ipynb)
+* [6. Apps](docs/dsms_sdk/tutorials/6_apps.ipynb)
+* [7. KTypes](docs/dsms_sdk/tutorials/7_ktypes.ipynb)
 
 ## Authors
 
@@ -65,6 +76,8 @@ Or try our Jupyter Notebooks:
 
 [Priyabrat Mishra](mailto:[email protected]) (Fraunhofer Institute for Mechanics of Materials IWM)
 
+[Arjun Gopalakrishnan](mailto:[email protected]) (Fraunhofer Institute for Mechanics of Materials IWM)
+
 ## License
 
 This project is licensed under the BSD 3-Clause. See the LICENSE file for more information.

docs/dsms_sdk/dsms_sdk.md

@@ -48,6 +48,16 @@ Before using DSMS-SDK make sure to register an account in a DSMS Instance of you
 
 After following the above steps, you could use either of the two ways to install DSMS-SDK to your machine.
 
+### Compatibility
+
+Please take the compability of the SDK version with the DSMS version into account:
+
+| SDK Version | DSMS Version |
+| --- | --- |
+| <2.0.0 | <2.0.0 |
+| >=2.0.0, <3.0.0 | >=2.0.0, <3.0.0 |
+| >=3.0.0 | >=3.0.0 |
+
 #### Method 1: Via PyPI
 
 To install the [DSMS Python SDK](https://pypi.org/project/dsms-sdk/), you can use the Python Package Index (PyPI). Copy the below command to install DSMS SDK from PyPI: