Metadata-Version: 2.4
Name: nisystemlink-clients
Version: 2.19.1
Summary: NI-SystemLink Python API
License: MIT
License-File: LICENSE
Keywords: nisystemlink,systemlink
Author: National Instruments
Maintainer: Richard Bell
Maintainer-email: richard.bell@emerson.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Hardware
Provides-Extra: pyarrow
Requires-Dist: Events (>=0.4,<0.5)
Requires-Dist: aenum (>=3.1.11,<4.0.0)
Requires-Dist: httpx (>=0.28.1,<0.29.0)
Requires-Dist: pandas (>=2.1.0,<3.0.0)
Requires-Dist: pyarrow (>=21.0.0,<22.0.0) ; extra == "pyarrow"
Requires-Dist: pydantic (>=2.11.3,<3.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Requires-Dist: uplink (>=0.9.7,<0.10.0) ; python_version == "3.9"
Requires-Dist: uplink[pydantic] (>=0.10.0,<0.11.0) ; python_version >= "3.10"
Description-Content-Type: text/x-rst

===========  ====================================================
Info         NI SystemLink API Clients for Python
Author       National Instruments
===========  ====================================================

About
=====
The **nisystemlink-clients** package contains an API (Application Programming
Interface) for `SystemLink <https://ni.com/systemlink>`_ that uses HTTP to
interact with a SystemLink Server. The package is implemented in Python. NI
created and supports this package.

.. image:: https://badge.fury.io/py/nisystemlink-clients.svg
    :target: https://badge.fury.io/py/nisystemlink-clients

Requirements
============
**nisystemlink-clients** has the following requirements:

* Access to a SystemLink Server or SystemLink Enterprise installation
* CPython 3.9+

.. _installation_section:

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

1. `pip <https://pypi.python.org/pypi/pip>`_::

   $ python -m pip install nisystemlink-clients

2. **easy_install** from `setuptools <https://pypi.python.org/pypi/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_section:

Usage
=====
Refer to the `documentation <https://python-docs.systemlink.io>`_
for detailed information on how to use **nisystemlink-clients**.

.. _support_section:

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 <https://www.ni.com>`_.

Bugs / Feature Requests
=======================
To report a bug or submit a feature request, please use the
`GitHub issues page <https://github.com/ni/nisystemlink-clients-python/issues>`_.

Documentation
=============
To view the documentation, visit the
`nisystemlink.clients Documentation Page <https://python-docs.systemlink.io>`_.

Changelog
=============
To view the changelog, visit the
`GitHub repository CHANGELOG <https://github.com/ni/nisystemlink-clients-python/blob/master/CHANGELOG.md>`_.

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

