Overview

This Page is the User Guide for the Connect - Python Capability. This includes details on how to get started and the available requests. For additional details, please review the Jupyter Notebook samples on the ICE Connect Python website. 

Getting Started!

Pre-Requisites  

  • Python - Version 3.4 or later  

  • ICE XL - Version 5.4 or later  

  • Python Library: pywin32 - Allows for the communication between Python and .Net Libraries  

  • Python Library: icepython - Connect Library for data requests  

Installation  

  • Ensure Python 3.4 (or later) is properly installed on the Client machine  

  • Ensure the latest ICE XL version is installed, v. 5.4 or later  

  • Install `using pip command  

    • Open command prompt  

    • Type: python -m pip install --user pywin32  

    • Note: “--user” is not needed if you’re an admin with an admin installation of python  

    • Confirm that the library has installed  

  • Install icepython library using pip command  

    • From command prompt go to your ICE XL directory  

    • Type: cd “%localappdata%\ICE Data Services\ICE XL\bin”  

    • Now install the icepython library  

    • Type: python -m pip install theice.com_ICEPython-0.0.6-py3-none-any.whl  

    • Confirm that the library has installed  

Importing the Library  

  • Within Python, import the icepython library  

  • Type: “import icepython as ice” from within Python 

  • Example:  
import

Additional Notes 

  • ICE XL must be installed and authenticated.  The Connect - Python functionality uses ICE XL for authentication 

  • Any data limits or entitlements are shared between ICE XL and Connect - Python 

  • All Python requests must happen locally to the machine running ICE XL 

  • The Python library is installed and updated through the ICE XL installer