Installation
============

Use of the SPy module requires Python 3.7 or later.

**IMPORTANT:**

This module does **NOT** follow semantic versioning.

The **Seeq** Python module's version number can have two forms:

 - For R60 and above, there are two Python libraries:
   - The SPy (``seeq-spy``) version is in the format of ``A.B``. This is referred to as the *SPy version* and
   denotes the level of functionality (and bug fixes) present in the package for the SPy module
   (with *A* and *B* being the major and minor SPy versions, respectively). For example ``186.4``.
   - Seeq SDK version (``seeq``) is of the form ``x.y.z`` and should match the Seeq Server version ``Rx.y.z`` you're
   using. For example the Seeq version ``60.1.0`` corresponds to Seeq Server ``R60.1.0``.
 - For Seeq Server version R59 and below, the SDK and SPy libraries are in a unified ``seeq`` package which use
   version the format of ``x.y.z.A.B``. The first three values (``x.y.z``) correspond to the Seeq Server SDK version.
   The last part (``A.B``) is the SPy version. For example, ``59.2.2.186.4`` and ``58.4.1.186.4`` have the same level
   of SPy functionality but are built for the respective versions of Seeq Server (R59.2.2 and R58.4.1).

You must use particular PIP commands to install a version of the **seeq** Python module that is compatible
with the version of Seeq Server you are using.

Here are some examples.

 =============== =============================== =================================================================
  Version         Install Command                 Description
 =============== =============================== =================================================================
  SPy 184.22+     ``spy.upgrade()``               From within SPy, automatically update to the latest version
  Seeq R55.4.12   ``pip install -U seeq~=55.4``   Install the unified SPy/Seeq library for R55
  Seeq R60.1.2    ``pip install -U seeq~=60.1``   Install Seeq SDK library for R60 without SPy
  Seeq R60+       ``pip install -U seeq-spy``     Install the latest SPy library version without updating the SDK
 =============== =============================== =================================================================

In order to keep the SPy testing and compatibility matrix manageable, there is a limited compatibility and publish
window for the ``seeq`` and ``seeq-spy`` modules.