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 |
nisystemlink-clients has the following requirements:
- Access to a SystemLink Server or SystemLink Enterprise installation
- CPython 3.11+ (tested on 3.11-3.15)
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.
To install nisystemlink-clients, use one of the following methods:
pip:
$ python -m pip install nisystemlink-clients
easy_install from setuptools:
$ python -m easy_install nisystemlink-clients
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.
Refer to the documentation for detailed information on how to use nisystemlink-clients.
The nisystemlink-clients package is supported by NI. For support for nisystemlink-clients, open a request through the NI support portal at ni.com.
To report a bug or submit a feature request, please use the GitHub issues page.
To view the documentation, visit the nisystemlink.clients Documentation Page.
To view the changelog, visit the GitHub repository CHANGELOG.
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.