| Info | NI SystemLink API Clients for Python |
| Author | National Instruments |
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.
nisystemlink-clients has the following requirements:
- Access to a SystemLink Server or SystemLink Enterprise installation
- CPython 3.9+
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.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
