Metadata-Version: 2.1
Name: ecmind-blue-client
Version: 0.2.1
Summary: A client wrapper for blue
Home-page: https://gitlab.ecmind.ch/open/ecmind_blue_client
Author: Ulrich Wohlfeil, Roland Koller
Author-email: info@ecmind.ch
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: XmlElement (>=0.1.5)
Provides-Extra: comclient
Requires-Dist: comtypes ; extra == 'comclient'
Provides-Extra: soapclient
Requires-Dist: zeep ; extra == 'soapclient'
Provides-Extra: tcpclient
Requires-Dist: protlib ; extra == 'tcpclient'

# ECMind blue client

A client wrapper for blue.

## Installation

`pip install ecmind_blue_client`

## Usage

The workflow consists roughly of the following:

- Create a new Client() connection using a client implementation. There are three implementations:
    - `SoapClient()` in the module `ecmind_blue_client.soap_client`
    - `ComClient()` in the module `ecmind_blue_client.com_client`
    - `TcpClient()` in the module `ecmind_blue_client.tcp_client`
- Create a new Job() with a job name and provide/add job input parameters and optional job input file parameters
- Execute the Job() with the Client() instance and consume the result 
   - `result.result_code` returns the blue result code
   - `result.values` is a dict of output parameters
   - `result.files` is a list of output file parameters
   - `result.error_messages` is a string of the servers error response or None if `result_code` == 0

```
>>> from ecmind_blue_client.soap_client import SoapClient
>>> client = SoapClient(self.endpoint, 'TestApp', 'root', 'optimal')
>>> test_job = Job('krn.GetServerInfo', Flags=0, Info=6)
>>> result = client.execute(test_job)
>>> print(result.values['Value'])
oxtrodbc.dll
```

