Metadata-Version: 2.1
Name: niveristand
Version: 3.2.3
Summary: NI VeriStand Python API
Home-page: https://github.com/ni/niveristand-python
Author: National Instruments
Maintainer: Marcelo Izaguirre
Maintainer-email: marcelo.izaguirre@ni.com
License: MIT
Keywords: niveristand,veristand
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Testing
License-File: LICENSE
Requires-Dist: pythonnet~=3.0.1
Requires-Dist: PyYAML

===========  ====================================================
Info         VeriStand Python Support
Author       National Instruments
===========  ====================================================

About
=====
The **niveristand** package contains an API (Application Programming Interface) that interacts with VeriStand systems.
The package is implemented in Python. NI created and supports this package.

Requirements
============
**niveristand** requires the following to be installed:

* VeriStand 2021 or later
* CPython 3.8 or later (the standard Python, available on python.org and elsewhere)

.. _installation_section:

Recommended
-----------
NI recommends you use an editor with code completion, such as `Visual Studio Code <https://code.visualstudio.com/docs/languages/python/>`_, to make it easier to browse and use this code.

Installation
============

To install **niveristand**, use one of the following methods:

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

   $ python -m pip install niveristand

2. **easy_install** from `setuptools <http://pypi.python.org/pypi/setuptools>`_::

   $ python -m easy_install niveristand

3. Download the project source and run the following script::

   $ python setup.py install

.. _usage_section:

Usage
=====
Refer to the `System Definition Examples section <https://niveristand-python.readthedocs.io/en/latest/sysdef_examples.html>`_ for detailed examples of how to script a system definition file.

Refer to the `Basic Real-time Sequence Examples section <https://niveristand-python.readthedocs.io/en/latest/basic_rt_sequence_examples.html>`_
for detailed information on how to write a Python real-time sequence.

.. _support_section:

Support / Feedback
==================

The **niveristand** package is supported by NI. For support for **niveristand**, open
a request through the NI support portal at `ni.com <http://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/niveristand-python/issues>`_.

Documentation
=============

To view the documentation, visit the `VeriStand Python Documentation Page <http://niveristand-python.readthedocs.io>`_.

Additional Documentation
========================

Refer to the `VeriStand Help <http://digital.ni.com/express.nsf/bycode/ex9v46>`_
for detailed information on setting up a system and running real-time test scenarios.

VeriStand Help installs only with the full version of VeriStand.

License
=======

**niveristand** 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.
