Skip to main content

The Seeq SDK for Python

Project description

The seeq Python module is used to interface with Seeq Server (http://www.seeq.com).

Documentation can be found at https://python-docs.seeq.com.

IMPORTANT:

This module mirrors the versioning of Seeq Server, such that the version of this module reflects the version of the Seeq Server from which the Seeq SDK was generated.

For Seeq Server version R60 and later, the SPy module is in its own namespace package called seeq-spy with its own versioning scheme. (Prior to R60, the SPy module was bundled into this main seeq module.)

Upgrade Considerations

When using Seeq Data lab:

If you are using Seeq Data Lab, you should not upgrade or otherwise affect the pre-installed version of the seeq module, as the pre-installed version correctly matches the version of Seeq Server that Data Lab is tied to.

Older than R60

However, in older versions of Seeq Server, you must follow the (more complex) instructions on the corresponding PyPI pages for that version:

https://pypi.org/project/seeq/55.4.9.183.34/ https://pypi.org/project/seeq/56.1.9.184.21/ https://pypi.org/project/seeq/57.2.7.184.22/ https://pypi.org/project/seeq/58.1.3.184.22/ https://pypi.org/project/seeq/59.0.1.184.25/

When NOT using Seeq Data Lab:

If you are not using Seeq Data Lab, you should install the version of the seeq module that corresponds to the first two numbers in the version of Seeq you are interfacing with. E.g.: pip install -U seeq~=56.2. You should then upgrade SPy separately via pip install -U seeq-spy.

seeq.spy

The SPy module is the recommended programming interface for interacting with the Seeq Server. See https://pypi.org/project/seeq-spy/ for more information on the SPy module.

For more advanced tasks than what the SPy module can provide, you may with to use the SDK module described below.

seeq.sdk

The Seeq SDK module is a set of Python bindings for the Seeq Server REST API. You can experiment with the REST API by selecting the API Reference menu item in the upper-right "hamburger" menu of Seeq Workbench.

The SDK module supports both Python 2.x and Python 3.x, but it is strongly recommended that you use Python 3.x (or later) as Python 2.x is end-of-life.

Login is accomplished with the following pattern:

import seeq
import getpass

api_client = seeq.sdk.ApiClient('http://localhost:34216/api')

# Change this to False if you're getting errors related to SSL
seeq.sdk.Configuration().verify_ssl = True

auth_api = seeq.sdk.AuthApi(api_client)
auth_input = seeq.sdk.AuthInputV1()

# Use raw_input() instead of input() if you're using Python 2
auth_input.username = input('Username:').rstrip().lower()
auth_input.password = getpass.getpass()
auth_input.auth_provider_class = "Auth"
auth_input.auth_provider_id = "Seeq"
auth_api.login(body=auth_input)

The api_client object is then used as the argument to construct any API object you need, such as seeq.sdk.ItemsApi. Each of the root endpoints that you see in the API Reference webpage corresponds to a seeq.sdk.XxxxxApi class.


In case you are looking for the Gencove package, it is available here: https://pypi.org/project/gencove/

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

seeq-61.1.7.tar.gz (355.5 kB view details)

Uploaded Source

Built Distribution

seeq-61.1.7-py3-none-any.whl (818.4 kB view details)

Uploaded Python 3

File details

Details for the file seeq-61.1.7.tar.gz.

File metadata

  • Download URL: seeq-61.1.7.tar.gz
  • Upload date:
  • Size: 355.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.9.6 requests/2.31.0 setuptools/65.7.0 requests-toolbelt/0.10.1 tqdm/4.65.0 CPython/3.7.8

File hashes

Hashes for seeq-61.1.7.tar.gz
Algorithm Hash digest
SHA256 bd80542772e4a737b7378c355da1bf9b6aa0f1c2cfbaf75ab503548716e476ad
MD5 eeda2550e462d31c20e7f1bfb5aa33f8
BLAKE2b-256 325b46592149e0b4829354e8d1b2485beab7495d6ccf640d4ed7295dde5eb099

See more details on using hashes here.

File details

Details for the file seeq-61.1.7-py3-none-any.whl.

File metadata

  • Download URL: seeq-61.1.7-py3-none-any.whl
  • Upload date:
  • Size: 818.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.9.6 requests/2.31.0 setuptools/65.7.0 requests-toolbelt/0.10.1 tqdm/4.65.0 CPython/3.7.8

File hashes

Hashes for seeq-61.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8a9333dfe764a66f609d70bfc499e1a9f13fb1d3d16397b24cd28aad7b024a74
MD5 af0edc97ab9dcde9390aeca424c806d8
BLAKE2b-256 249ee3979c30f46fb67486134eb8308573e6ed2b26fb2961f5bc759b1b84695d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page