=========== ====================================================
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/ni/niveristand-python",
"name": "niveristand",
"maintainer": "Marcelo Izaguirre",
"docs_url": null,
"requires_python": null,
"maintainer_email": "marcelo.izaguirre@ni.com",
"keywords": "niveristand, veristand",
"author": "National Instruments",
"author_email": null,
"download_url": null,
"platform": null,
"description": "=========== ====================================================\r\nInfo VeriStand Python Support\r\nAuthor National Instruments\r\n=========== ====================================================\r\n\r\nAbout\r\n=====\r\nThe **niveristand** package contains an API (Application Programming Interface) that interacts with VeriStand systems.\r\nThe package is implemented in Python. NI created and supports this package.\r\n\r\nRequirements\r\n============\r\n**niveristand** requires the following to be installed:\r\n\r\n* VeriStand 2021 or later\r\n* CPython 3.8 or later (the standard Python, available on python.org and elsewhere)\r\n\r\n.. _installation_section:\r\n\r\nRecommended\r\n-----------\r\nNI 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.\r\n\r\nInstallation\r\n============\r\n\r\nTo install **niveristand**, use one of the following methods:\r\n\r\n1. `pip <http://pypi.python.org/pypi/pip>`_::\r\n\r\n $ python -m pip install niveristand\r\n\r\n2. **easy_install** from `setuptools <http://pypi.python.org/pypi/setuptools>`_::\r\n\r\n $ python -m easy_install niveristand\r\n\r\n3. Download the project source and run the following script::\r\n\r\n $ python setup.py install\r\n\r\n.. _usage_section:\r\n\r\nUsage\r\n=====\r\nRefer 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.\r\n\r\nRefer to the `Basic Real-time Sequence Examples section <https://niveristand-python.readthedocs.io/en/latest/basic_rt_sequence_examples.html>`_\r\nfor detailed information on how to write a Python real-time sequence.\r\n\r\n.. _support_section:\r\n\r\nSupport / Feedback\r\n==================\r\n\r\nThe **niveristand** package is supported by NI. For support for **niveristand**, open\r\na request through the NI support portal at `ni.com <http://www.ni.com>`_.\r\n\r\nBugs / Feature Requests\r\n=======================\r\n\r\nTo report a bug or submit a feature request, please use the\r\n`GitHub issues page <https://github.com/ni/niveristand-python/issues>`_.\r\n\r\nDocumentation\r\n=============\r\n\r\nTo view the documentation, visit the `VeriStand Python Documentation Page <http://niveristand-python.readthedocs.io>`_.\r\n\r\nAdditional Documentation\r\n========================\r\n\r\nRefer to the `VeriStand Help <http://digital.ni.com/express.nsf/bycode/ex9v46>`_\r\nfor detailed information on setting up a system and running real-time test scenarios.\r\n\r\nVeriStand Help installs only with the full version of VeriStand.\r\n\r\nLicense\r\n=======\r\n\r\n**niveristand** is licensed under an MIT-style license (see `LICENSE\r\n<LICENSE>`_). Other incorporated projects may be licensed under different\r\nlicenses. All licenses allow for non-commercial and commercial use.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "NI VeriStand Python API",
"version": "3.2.2",
"project_urls": {
"Homepage": "https://github.com/ni/niveristand-python"
},
"split_keywords": [
"niveristand",
" veristand"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0e4d18e9eb654d39b813feb06381f17805e5e66ef7243db32123d6a16186076",
"md5": "9230ce0e8247ad1f02af5ff2a57905f9",
"sha256": "bcbf95b900565d87ab4876411832a77cae1ad7921c61cc8346becc81c19597c8"
},
"downloads": -1,
"filename": "niveristand-3.2.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9230ce0e8247ad1f02af5ff2a57905f9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 185603,
"upload_time": "2024-10-25T11:03:12",
"upload_time_iso_8601": "2024-10-25T11:03:12.013963Z",
"url": "https://files.pythonhosted.org/packages/b0/e4/d18e9eb654d39b813feb06381f17805e5e66ef7243db32123d6a16186076/niveristand-3.2.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 11:03:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ni",
"github_project": "niveristand-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pytest",
"specs": []
},
{
"name": "pythonnet",
"specs": [
[
"~=",
"3.0.1"
]
]
},
{
"name": "tox",
"specs": []
},
{
"name": "pyyaml",
"specs": []
}
],
"tox": true,
"lcname": "niveristand"
}
JSON
