nisystemlink.clients

User Documentation

• Getting Started
  • Alarm API
  • Tag API
  • Product API
  • DataFrame API
  • Spec API
  • File API
  • Feeds API
  • TestMonitor API (Results and Steps)
  • Notebook API
  • Asset Management API
  • Systems API
  • WorkItem API
  • TestPlan API
  • Notification API
• API Reference
  • nisystemlink.clients.core
  • nisystemlink.clients.alarm
  • nisystemlink.clients.tag
  • nisystemlink.clients.product
  • nisystemlink.clients.testmonitor
  • nisystemlink.clients.dataframe
  • nisystemlink.clients.spec
  • nisystemlink.clients.file
  • nisystemlink.clients.notebook
  • nisystemlink.clients.feeds
  • nisystemlink.clients.assetmanagement
  • nisystemlink.clients.systems
  • nisystemlink.clients.work_item
  • nisystemlink.clients.test_plan
  • nisystemlink.clients.artifact
  • nisystemlink.clients.notification
  • Indices and tables

Package Info

About

The nisystemlink-clients package contains an API (Application Programming Interface) for SystemLink that uses HTTP to interact with a SystemLink Server. The package is implemented in Python. NI created and supports this package.

Info	NI SystemLink API Clients for Python
Author	National Instruments

Requirements

nisystemlink-clients has the following requirements:

• Access to a SystemLink Server or SystemLink Enterprise installation

• CPython 3.11+ (tested on 3.11-3.15)

DataFrame compatibility

Python 3.11-3.14 uses pandas 2; Python 3.15+ uses pandas 3. DataFrame conversion helpers follow the installed pandas version’s native behavior. Moving to Python 3.15 can therefore change inferred string dtypes, timestamp units (for example, microseconds instead of nanoseconds), and missing-value representations. Review downstream dtype assumptions and serialization when upgrading.

Installation

To install nisystemlink-clients, use one of the following methods:

1. pip:

   $ python -m pip install nisystemlink-clients
   

2. easy_install from setuptools:

   $ python -m easy_install nisystemlink-clients
   

Optional Arrow (pyarrow) Support

The base install does not pull in pyarrow. Arrow RecordBatch ingestion via DataFrameClient.append_table_data is available starting in nisystemlink-clients version 2.19.0. Install that version (or newer) with the optional extra:

$ python -m pip install “nisystemlink-clients[pyarrow]>=2.19.0”

If you already have an older version installed, upgrade with:

$ python -m pip install –upgrade “nisystemlink-clients[pyarrow]>=2.19.0”

Without the extra (or when using a package version earlier than 2.19.0), Arrow-specific code paths will raise a RuntimeError when attempting to append pyarrow.RecordBatch instances.

Usage

Refer to the documentation for detailed information on how to use nisystemlink-clients.

Support / Feedback

The nisystemlink-clients package is supported by NI. For support for nisystemlink-clients, open a request through the NI support portal at ni.com.

Bugs / Feature Requests

To report a bug or submit a feature request, please use the GitHub issues page.

Documentation

To view the documentation, visit the nisystemlink.clients Documentation Page.

Changelog

To view the changelog, visit the GitHub repository CHANGELOG.

License

nisystemlink-clients is licensed under an MIT-style license (see LICENSE). Other incorporated projects may be licensed under different licenses. All licenses allow for non-commercial and commercial use.