User Mode API
The user mode API comes in two pieces, both of which must be deployed with the application:
- A Python module named cbfsconnect.py.
- A native library (unmanaged), named pycbfsconnect20.dll, available for both 32-bit (x86) and 64-bit (x64) processor architectures.
Both of these are included in the product's Python package, <install_dir>\cbfsconnect-20.0.xxxx.tar.gz, which should be installed using pip:
cd C:\path\to\install_dir python -m pip install cbfsconnect-20.0.xxxx.tar.gz
Once the product's Python package has been installed, the module can be imported and used: from cbfsconnect import *. Nothing else is required to deploy the application.
As an alternative to installing the module using pip, you can utilize the built-in setuptools module to package the module for deployment or install it to the machine.
python setup.py build --build-lib=<app_dir>The above setup command packages the module and native library for deployment. A folder is created in the app_dir directory with the module and the native library packaged inside.
Remember to deploy the drivers and supplementary DLLs too, as they are an integral part of CBFS Connect.