vantiqservicesdk 0.3.0

SDK for building Vantiq service connectors in Python

Repository Contents

This repository contains an SDK for building Vantiq Service Connectors in Python. Service connectors allow some of all of a Vantiq service to be implemented outside the Vantiq platform. The typical use case for this is to leverage a language other than VAIl (in this case Python). One major use case for Python is to take advantage of its broad support for ML/Generative AI libraries.

Overview of a Service Connector

TBD... Python Service Connectors are only used internally by Vantiq at this point.

Building a Service Connector

Running this code required Python 3.8 or later.

To use the SDK, install it into your Python environment. Using pip,

pip install vantiqservicesdk

Other Python environment tools may use different commands.

Once it is installed, you can import it.

from vantiqservicesdk import BaseVantiqServiceConnector

More details TBD...

The MIT License (MIT)

Copyright (c) 2023 Vantiq, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.