Dependencies

The only dependencies required by the python connectors are an existing python distribution, whether version 3.7, 3.8, 3.9, or 3.10. Other version 3 distributions may need to create a virtual environment to accommodate the version dependency.

Installation

The CData Python Connector for SuiteCRM setup ZIP contains versions of the connector for each compatible operating system (Windows, Mac, and Linux).

Python versions 3.7, 3.8, 3.9, and 3.10 are supported, though only 3.8, 3.9, and 3.10 are supported on Mac environments.

For Windows environments, the whl file of the appropriate python version and bitness should be used with the "pip install" command. For example, once your command prompt is in the pertinent directory, the following command would be appropriate for a 64-bit Python 3.7 distribution on a Windows environment, once the version number is adjusted accordingly:

pip install cdata_suitecrm_connector-22.0.xxxx-cp37-cp37-win_amd64.whl

For Linux or Mac environments, the package will be a tar.gz file instead. Once again, the "pip install" command will be used via the terminal. For example, the following command is appropriate to install the connector for a python 3.7 distribution in a Linux environment, once the version number is adjusted accordingly:

pip install cdata-suitecrm-connector-22.0.xxxx-python3.tar.gz

Regardless of the environment, certain distributions may require that the "pip3 install" command be used instead, to differentiate from a Python 2 distribution that may exist already. After installation, you can confirm whether the connector is successfully installed by running the "pip list" command. If "cdata-suitecrm-connector" is present in the list output by the command, then the installation was successful.

Licensing

After the installation is complete, a separate step is needed to activate a license for the connector. Among the CData assets in the distribution's site packages, there should be an install-license tool that will activate this license. From within the distribution's site-packages folder, after navigating to the "cdata/installlic_suitecrm" folder, simply use a command like the below to activate the license. Omitting the <key> argument will activate a trial license:

• Windows:
  

  ./install-license.exe <key>

• Linux / Mac:
  

  ./install-license.sh <key>

Uninstallation

Should the connector need to be uninstalled for any reason, you can do so by running the pip uninstall command, as in the example below:

pip uninstall cdata-suitecrm-connector