Installation

Use of the SPy library requires Python 3.8 or later.

Overview

The Seeq Python module is comprised of two Python libraries:

  • The SPy library (seeq-spy) provides an interface for interacting with the Seeq server. This library acts as a more stable and abstracted way to search, pull, push, and manage items in Seeq. SPy’s version is in the format of MAJOR.MINOR and denotes the level of functionality and included bug fixes present when calling SPy functions. For example 195.1.

  • The Seeq SDK library (seeq) is the interface that SPy uses to communicate with the Seeq Server’s API. This library is tied directly to the Seeq Server API version and manages the underlying HTTP requests and responses. The SDK uses the format of MAJOR.MINOR.PATCH and should match the version displayed at the top of the API Reference page. For example 65.1.9.

See the Compatibility section below for more details on the relationship between the API, SDK, and SPy versions.

Installation Commands

When installing the SDK and SPy, please take care that the seeq and seeq-spy Python libraries are compatible with the version of Seeq Server you are using. If you are using a version of Seeq that is on a continuous delivery cadence, you can install the most up-to-date version of the SDK and SPy libraries at the same time with the following command:

pip install -U seeq seeq-spy[all]

Below are further examples.

Install Command

Description

spy.upgrade()

From within SPy, automatically update to the latest compatible SPy and SDK versions

pip install -U seeq-spy[all]

Install the latest SPy version and all dependencies

pip install -U seeq-spy

Install the latest SPy version and only dependencies required for core functionality

pip install -U seeq-spy==195.1

Install SPy version 195.1 without updating the SDK

pip install -U seeq~=65.1

Install the SDK library for R65 without SPy

Extras

seeq-spy’s dependencies have been organized into extras beginning in SPy version 193.0. Install only specific extras to reduce install size if you do not need full SPy functionality. The following extras are available:

  • seeq-spy[all]: The entire SPy library with all extra dependencies below.

  • seeq-spy: The core SPy library needed to use common functionality such as login, search, pull, push, swap, archive, as well as interact with Workbooks, Worksheets and Worksteps using spy.workbooks to push, pull, search, save, load, and swap.

  • seeq-spy[widgets]: Interactive features in an IPython environment.

  • seeq-spy[templates]: Templatization of workbooks.

  • seeq-spy[jobs]: Scheduling and job management of automated Data Lab notebooks.

  • seeq-spy[jupyter]: Interactions between Jupyter notebooks and SPy.

To install the entire SPy library, run: pip install -U seeq-spy[all].
An example of installing specific extras, such as widgets and templates, would be to run: pip install -U seeq-spy[widgets,templates].

Compatibility

It is recommended that customers regularly monitor their log output for any DeprecationWarning from SPy or the SDK. These warnings identify which functions or endpoints are planned for removal and provide guidance on alternatives. Additionally, Seeq’s and SPy’s release notes will highlight version-specific changes and deprecations. Automation or client libraries that integrate with Seeq outside of Data Lab should upgrade their seeq and seeq-spy libraries at least once per quarter to stay ahead of upcoming breaking changes.

SDK

For best results, use the identical seeq SDK version as the API version that is reported on the Seeq API Reference page of the server you are connecting to. The SDK follows semantic versioning. Any version with the same MAJOR number as the Seeq Server API is considered compatible, but may not have the latest features and bugfixes.

As part of our continuous delivery process, all public-facing functions will be maintained under a deprecation flag for a minimum of one year before being removed or undergoing breaking changes such as altered input/output types. Breaking changes in the SDK will be denoted by an incremented MAJOR version.

spy.login() will automatically check the compatibility of the SDK and the server. If the versions are not compatible, it will raise an error unless spy.options.allow_version_mismatch = True is used.

SPY

For best results, use the latest version of seeq-spy that is available. SPy is tested to be compatible with all versions of Seeq Server that are in Sustainment at the time of release. Newer SPy versions will likely work with any R60 or above Seeq Server, but this is not guaranteed outside of the Sustainment window.

SPy also follows semantic versioning, where an incremented MAJOR version indicates a possible compatibility break in behavior. Use spy.options.compatibility to maintain the behavior of previous versions of SPy across updates. Deprecated public-facing functions will also be maintained for a minimum of one year before being removed.

Legacy Versions

For Seeq Server version R59 and below, the SDK and SPy libraries were one unified seeq package which used the version format of x.y.z.A.B. The first three values (x.y.z) corresponded to the Seeq Server SDK version. The last part (A.B) was the SPy version. For example, 59.3.5.190.9 and 58.8.8.190.9 had the same level of SPy functionality but were built for the respective versions of Seeq Server (R59.3.5 and R58.8.8). To install the unified Seeq SDK and SPy library for R58, use the command pip install -U seeq~=58.8.