Installation and Versioning

Installation and Versioning#

Installation of the IBM watsonx.data intelligence SDK for Python is managed through pip or from source.

Installation via pip#

Once the package is published to PyPI, you can install the latest release:

$ pip install data-intelligence-sdk

Installation from Source#

To install the SDK from source (recommended for development or pre-release versions):

$ git clone https://github.com/IBM/data-intelligence-sdk.git
$ cd data-intelligence-sdk
$ pip install -e .

Installing with Optional Dependencies#

The SDK supports optional dependencies for different use cases:

Pandas Support#

To use the SDK with Pandas DataFrames:

$ pip install -e ".[pandas]"

PySpark Support#

To use the SDK with PySpark DataFrames:

$ pip install -e ".[spark]"

Both DataFrame Libraries#

To install support for both Pandas and PySpark:

$ pip install -e ".[dataframes]"

Development Installation#

To install all dependencies including development tools:

$ pip install -e ".[dev]"

Complete Installation#

To install everything (all optional dependencies and development tools):

$ pip install -e ".[all]"

Verifying Installation#

To verify that the SDK is installed correctly:

>>> import wxdi.dq_validator
>>> from wxdi.common.auth import AuthProvider
>>> print(dq_validator.__version__)
2.1.0

Versioning#

The IBM watsonx.data intelligence SDK for Python adheres to Semantic Versioning.

Version numbers follow the format MAJOR.MINOR.PATCH:

  • MAJOR version increments indicate incompatible API changes

  • MINOR version increments add functionality in a backward-compatible manner

  • PATCH version increments include backward-compatible bug fixes

Current Version#

The current version of the SDK is 2.1.0.

Checking Your Version#

To check which version of the SDK you have installed:

$ pip show data-intelligence-sdk

Or programmatically:

>>> import wxdi.dq_validator
>>> print(dq_validator.__version__)
2.1.0

Upgrading#

To upgrade to the latest version:

$ pip install --upgrade data-intelligence-sdk

Or if installing from source:

$ cd data-intelligence-sdk
$ git pull
$ pip install -e . --upgrade

Uninstalling#

To uninstall the SDK:

$ pip uninstall data-intelligence-sdk

Next Steps#

Now that you have the SDK installed, check out the Overview section to learn about the SDK’s features, or jump straight to the Common Modules section to set up authentication.