Merge pull request #24 from PTCInc/1.2.0-dev

Kepconfig 1.2.0 release

Author: rlabbeptc

README.md

@@ -1,12 +1,12 @@
 # Kepware Configuration API SDK for Python
 
-[![PyPI version](https://badge.fury.io/py/kepconfig.svg)](https://badge.fury.io/py/kepconfig)
+[![Released Version](https://img.shields.io/pypi/v/kepconfig)](https://pypi.org/project/kepconfig) [![Supported Versions](https://img.shields.io/pypi/pyversions/kepconfig)](https://pypi.org/project/kepconfig) ![PyPI - Downloads](https://img.shields.io/pypi/dm/kepconfig) ![PyPI - License](https://img.shields.io/pypi/l/kepconfig)
 
-This is a package SDK to create Python modules to conduct operations with the Kepware Configuration API. This package is designed to work with all versions of Kepware that support the Configuration API including Thingworx Kepware Server (TKS), Thingworx Kepware Edge (TKE) and KEPServerEX (KEP).
+This is a package to help create Python applications to conduct operations with the Kepware Configuration API. This package is designed to work with all versions of Kepware that support the Configuration API including Thingworx Kepware Server (TKS), Thingworx Kepware Edge (TKE) and KEPServerEX (KEP).
 
 ## Prerequisites
 
-The client libraries are supported on Python 3.6 or later. All HTTP communication is handled by the [urllib](https://docs.python.org/3.6/library/urllib.html#module-urllib) Python standard library.
+Package supported and tested on Python 3.9 or later. Older versions support earlier Python 3 environments but have less functionality. All HTTP communication is handled by the [urllib](https://docs.python.org/3/library/urllib.html#module-urllib) Python standard library.
 
 ## Features
 
@@ -21,14 +21,17 @@ SDK allows for *GET*, *ADD*, *DELETE*, and *MODIFY* functions for the following
 | **IoT Gateway** <br /> *(Agents, IoT Items)* | Y | Y |
 | **Datalogger** <br /> *(Log Groups, Items, Mapping, Triggers, Reset Mapping Service)* | Y | Y |
 | **Administration** <br /> *(User Groups, Users, UA Endpoints, Local License Server)* | Y* | Y |
+| **Product Info and Health Status\*\*** | Y | Y |
 
-Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only
+- Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only
+- Note (**) - Added to Kepware Server v6.13 / Kepware Edge v1.5 and later builds
 
 Driver specific features:
 
 | Driver          | Features       |
 | :----------:  | :----------:  |
 |GE Ethernet Global Data|Exchanges, Ranges and Name Resolutions|
+|Universal Device Driver|Profile Library|
 
 Methods to read the following logs:
 
@@ -41,16 +44,19 @@ Configuration API *Services* implemented:
 
 | Services      | TKS/KEP       | TKE           |
 | :----------:  | :----------:  | :----------:  |
-| **TagGeneration** <br /> *(for supported drivers)* | Y | Y |
+| **TagGeneration**<br />*(for supported drivers)* | Y | Y |
 | **ReinitializeRuntime** | Y* | Y |
+| **ProjectLoad and ProjectSave**| Y | Y |
 
 Note (*) - Reinitialize service was implemented for Kepware Server v6.8+
 
-Generic REST methods are provided to use for functions not developed in SDK package. These are found in the Server Class in [connection.py](/kepconfig/connection.py)
+Filtering, sorting and pagination query options are added for any collections methods (ex: get_all_devices() or get_all_channel()).
+
+Generic REST methods are provided to use for functions not developed in SDK package. These are found in the Server Class in [connection.py](./kepconfig/connection.py)
 
 ## Known Limitations
 
-- Other property configuration for more complex drivers with objects besides channels, devices, tags and tag groups are not explicitly defined
+- Other property configuration for more complex drivers with objects besides channels, devices, tags and tag groups are not always explicitly defined
 - Other supported plug-ins (EFM Exporter, Scheduler, etc) are not defined
 - When using hostnames (not IP addresses) for connections, delays may occur under certain network configurations as the connection may attempt IPv6 connections first. IPv6 is not supported by Kepware servers at this time.
 
@@ -64,7 +70,7 @@ Package can be installed with `pip` using the following:
 
 ## Key Concepts
 
-NOTE: Samples can also be found in the [samples](samples) folder.
+NOTE: Detailed examples can also be found in the [examples](./examples/) folder.
 
 ### Create server connection
 
@@ -74,7 +80,7 @@ import kepconfig.connection
 server = connection.server(host = '127.0.0.1', port = 57412, user = 'Administrator', pw = '')
 
 # For HTTPS connections:
-server = connection.server(host = '127.0.0.1', port = 57412, user = 'Administrator', pw = '', https=True)
+server = connection.server(host = '127.0.0.1', port = 57512, user = 'Administrator', pw = '', https=True)
 
 ```
 
@@ -124,5 +130,4 @@ result = tag.add_tag(server, tag_path, tag_info))
 **Visit:**
 
 - [Kepware.com](https://www.kepware.com/)
-- [Configuration API Info](https://www.kepware.com/en-us/products/kepserverex/features/configuration-api/)
 - [PTC.com](https://www.ptc.com/)

samples/GE EGD exchanges example.py renamed to examples/GE EGD exchanges example.py

@@ -10,7 +10,7 @@
 
 
 from kepconfig import connection, error
-from kepconfig.connectivity import channel, device, tag, egd
+from kepconfig.connectivity import channel, egd
 
 # Channel and Device name to be used
 ch_name = 'EGD'
@@ -27,17 +27,17 @@
 
 def ErrorHandler(err):
     # Generic Handler for exception errors
-    if err.__class__ is error.KepError:
-        print(err.msg)
-    elif err.__class__ is error.KepHTTPError:
+    if isinstance(err,  error.KepHTTPError):
         print(err.code)
         print(err.msg)
         print(err.url)
         print(err.hdrs)
         print(err.payload)
-    elif err.__class__ is error.KepURLError:
+    elif isinstance(err,  error.KepURLError):
         print(err.url)
         print(err.reason)
+    elif isinstance(err, error.KepError):
+        print(err.msg)
     else:
         print('Different Exception Received: {}'.format(err))
 
@@ -94,7 +94,7 @@ def ErrorHandler(err):
 # Modify an Exchange
 try:
     print("{} - {}".format("Modify Consumer Exchange:", egd.exchange.modify_exchange(server, ch_name + '.' + dev_name, egd.CONSUMER_EXCHANGE, 
-        {"ge_ethernet_global_data.CONSUMER_EXCHANGE_NUMBER": 2}, consumer_exchange['common.ALLTYPES_NAME'])))
+        {"ge_ethernet_global_data.CONSUMER_EXCHANGE_NUMBER": 2},exchange_name= consumer_exchange['common.ALLTYPES_NAME'])))
 except Exception as err:
     ErrorHandler(err)
 

samples/README.md renamed to examples/README.md

@@ -24,23 +24,23 @@
 
 import csv
 import json
-import kepconfig
-from kepconfig.connectivity import channel, device, tag
+from kepconfig import error, connection
+from kepconfig.connectivity import channel, device
 import kepconfig.iot_gateway as IoT
 
 def ErrorHandler(err):
     # Generic Handler for exception errors
-    if err.__class__ is kepconfig.error.KepError:
-        print(err.msg)
-    elif err.__class__ is kepconfig.error.KepHTTPError:
+    if isinstance(err,  error.KepHTTPError):
         print(err.code)
         print(err.msg)
         print(err.url)
         print(err.hdrs)
         print(err.payload)
-    elif err.__class__ is kepconfig.error.KepURLError:
+    elif isinstance(err,  error.KepURLError):
         print(err.url)
         print(err.reason)
+    elif isinstance(err, error.KepError):
+        print(err.msg)
     else:
         print('Different Exception Received: {}'.format(err))
 
@@ -211,7 +211,7 @@ def make_tags(master_list, device, ttag, limit, titem):
 
     print ("-- Channel and devices and agent creation attempt")
     for Kepware_IP in Kepware_IP_Array:
-        server = kepconfig.connection.server(Kepware_IP, Kepware_Port, user, passw)
+        server = connection.server(Kepware_IP, Kepware_Port, user, passw)
         try:
             print("{} - {}".format("Adding all devices", channel.add_channel(server,all_devices_JSON)))
         except Exception as err: