| Name | nise JSON |
| Version |
1.4.8
JSON |
| download |
| home_page | https://github.com/ni/nimi-python |
| Summary | NI Switch Executive Python API |
| upload_time | 2024-04-26 20:12:30 |
| maintainer | NI |
| docs_url | None |
| author | NI |
| requires_python | None |
| license | MIT |
| keywords |
nise
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
|
| coveralls test coverage |
No coveralls.
|
Overall Status
--------------
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| GitHub status | |OpenIssues| |OpenPullRequests| |
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
=========== ============================================================================================================================
Info Python bindings for NI Modular Instrument drivers. See `GitHub <https://github.com/ni/nimi-python/>`_ for the latest source.
Author NI
=========== ============================================================================================================================
.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg
:alt: Build Status - master branch
:target: https://travis-ci.org/ni/nimi-python
.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:alt: MIT License
:target: https://opensource.org/licenses/MIT
.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg
:alt: Test Coverage - master branch
:target: https://codecov.io/github/ni/nimi-python
.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg
:alt: Open Issues + Pull Requests
:target: https://github.com/ni/nimi-python/issues
.. |OpenPullRequests| image:: https://img.shields.io/github/issues-pr/ni/nimi-python.svg
:alt: Open Pull Requests
:target: https://github.com/ni/nimi-python/pulls
.. _about-section:
About
=====
The **nise** module provides a Python API for NI Switch Executive. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.
Support Policy
--------------
**nise** supports all the Operating Systems supported by NI Switch Executive.
It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.
NI Switch Executive Python API Status
-------------------------------------
+-------------------------------+---------------------+
| NI Switch Executive (nise) | |
+===============================+=====================+
| Driver Version Tested Against | 2023 Q1 |
+-------------------------------+---------------------+
| PyPI Version | |niseLatestVersion| |
+-------------------------------+---------------------+
| Supported Python Version | |nisePythonVersion| |
+-------------------------------+---------------------+
| Documentation | |niseDocs| |
+-------------------------------+---------------------+
| Open Issues | |niseOpenIssues| |
+-------------------------------+---------------------+
| Open Pull Requests | |niseOpenPRs| |
+-------------------------------+---------------------+
.. |niseLatestVersion| image:: http://img.shields.io/pypi/v/nise.svg
:alt: Latest NI Switch Executive Version
:target: http://pypi.python.org/pypi/nise
.. |nisePythonVersion| image:: http://img.shields.io/pypi/pyversions/nise.svg
:alt: NI Switch Executive supported Python versions
:target: http://pypi.python.org/pypi/nise
.. |niseDocs| image:: https://readthedocs.org/projects/nise/badge/?version=latest
:alt: NI Switch Executive Python API Documentation Status
:target: https://nise.readthedocs.io/en/latest
.. |niseOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nise.svg
:alt: Open Issues + Pull Requests for NI Switch Executive
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anise
.. |niseOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nise.svg
:alt: Pull Requests for NI Switch Executive
:target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anise
.. _nise_installation-section:
Installation
------------
As a prerequisite to using the **nise** module, you must install the NI Switch Executive runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the driver runtime for your devices.
The nimi-python modules (i.e. for **NI Switch Executive**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
$ python -m pip install nise~=1.4.8
Contributing
============
We welcome contributions! You can clone the project repository, build it, and install it by `following these instructions <https://github.com/ni/nimi-python/blob/master/CONTRIBUTING.md>`_.
Usage
------
The following is a basic example of using the **nise** module to open a session to a Switch Executive Virtual Device and connect a routegroup.
.. code-block:: python
import nise
with nise.Session('SwitchExecutiveExample') as session:
session.connect('DIOToUUT')
`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nise/examples>`_
.. _support-section:
Support / Feedback
==================
For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_.
For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums <https://forums.ni.com/>`_.
.. _bugs-section:
Bugs / Feature Requests
=======================
To report a bug or submit a feature request specific to Python API, please use the
`GitHub issues page <https://github.com/ni/nimi-python/issues>`_.
Fill in the issue template as completely as possible and we will respond as soon
as we can.
.. _documentation-section:
Documentation
=============
Documentation is available `here <http://nise.readthedocs.io>`_.
.. _license-section:
License
=======
**nimi-python** is licensed under an MIT-style license (`see
LICENSE <https://github.com/ni/nimi-python/blob/master/LICENSE>`_).
Other incorporated projects may be licensed under different licenses. All
licenses allow for non-commercial and commercial use.
**gRPC Features**
For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is
subject to the NI General Purpose EULA (`see NILICENSE <https://github.com/ni/nimi-python/blob/master/NILICENSE>`_).
Raw data
{
"_id": null,
"home_page": "https://github.com/ni/nimi-python",
"name": "nise",
"maintainer": "NI",
"docs_url": null,
"requires_python": null,
"maintainer_email": "opensource@ni.com",
"keywords": "nise",
"author": "NI",
"author_email": "opensource@ni.com",
"download_url": "https://files.pythonhosted.org/packages/86/3b/0670d61360ec1f72a3da6d4131c9e2461638fbf8ba3b1ddf62d13f73fab0/nise-1.4.8.tar.gz",
"platform": null,
"description": "Overall Status\n--------------\n\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n| GitHub status | |OpenIssues| |OpenPullRequests| |\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n\n=========== ============================================================================================================================\nInfo Python bindings for NI Modular Instrument drivers. See `GitHub <https://github.com/ni/nimi-python/>`_ for the latest source.\nAuthor NI\n=========== ============================================================================================================================\n\n.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg\n :alt: Build Status - master branch\n :target: https://travis-ci.org/ni/nimi-python\n\n.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :alt: MIT License\n :target: https://opensource.org/licenses/MIT\n\n.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg\n :alt: Test Coverage - master branch\n :target: https://codecov.io/github/ni/nimi-python\n\n.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg\n :alt: Open Issues + Pull Requests\n :target: https://github.com/ni/nimi-python/issues\n\n.. |OpenPullRequests| image:: https://img.shields.io/github/issues-pr/ni/nimi-python.svg\n :alt: Open Pull Requests\n :target: https://github.com/ni/nimi-python/pulls\n\n\n.. _about-section:\n\nAbout\n=====\n\nThe **nise** module provides a Python API for NI Switch Executive. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.\n\nSupport Policy\n--------------\n**nise** supports all the Operating Systems supported by NI Switch Executive.\n\nIt follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.\n\n\nNI Switch Executive Python API Status\n-------------------------------------\n\n+-------------------------------+---------------------+\n| NI Switch Executive (nise) | |\n+===============================+=====================+\n| Driver Version Tested Against | 2023 Q1 |\n+-------------------------------+---------------------+\n| PyPI Version | |niseLatestVersion| |\n+-------------------------------+---------------------+\n| Supported Python Version | |nisePythonVersion| |\n+-------------------------------+---------------------+\n| Documentation | |niseDocs| |\n+-------------------------------+---------------------+\n| Open Issues | |niseOpenIssues| |\n+-------------------------------+---------------------+\n| Open Pull Requests | |niseOpenPRs| |\n+-------------------------------+---------------------+\n\n\n.. |niseLatestVersion| image:: http://img.shields.io/pypi/v/nise.svg\n :alt: Latest NI Switch Executive Version\n :target: http://pypi.python.org/pypi/nise\n\n\n.. |nisePythonVersion| image:: http://img.shields.io/pypi/pyversions/nise.svg\n :alt: NI Switch Executive supported Python versions\n :target: http://pypi.python.org/pypi/nise\n\n\n.. |niseDocs| image:: https://readthedocs.org/projects/nise/badge/?version=latest\n :alt: NI Switch Executive Python API Documentation Status\n :target: https://nise.readthedocs.io/en/latest\n\n\n.. |niseOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nise.svg\n :alt: Open Issues + Pull Requests for NI Switch Executive\n :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anise\n\n\n.. |niseOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nise.svg\n :alt: Pull Requests for NI Switch Executive\n :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anise\n\n\n\n.. _nise_installation-section:\n\nInstallation\n------------\n\nAs a prerequisite to using the **nise** module, you must install the NI Switch Executive runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the driver runtime for your devices.\n\nThe nimi-python modules (i.e. for **NI Switch Executive**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::\n\n $ python -m pip install nise~=1.4.8\n\n\nContributing\n============\n\nWe welcome contributions! You can clone the project repository, build it, and install it by `following these instructions <https://github.com/ni/nimi-python/blob/master/CONTRIBUTING.md>`_.\n\nUsage\n------\n\nThe following is a basic example of using the **nise** module to open a session to a Switch Executive Virtual Device and connect a routegroup.\n\n.. code-block:: python\n\n import nise\n with nise.Session('SwitchExecutiveExample') as session:\n session.connect('DIOToUUT')\n\n`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nise/examples>`_\n\n.. _support-section:\n\nSupport / Feedback\n==================\n\nFor support specific to the Python API, follow the processs in `Bugs / Feature Requests`_.\nFor support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums <https://forums.ni.com/>`_.\n\n.. _bugs-section:\n\nBugs / Feature Requests\n=======================\n\nTo report a bug or submit a feature request specific to Python API, please use the\n`GitHub issues page <https://github.com/ni/nimi-python/issues>`_.\n\nFill in the issue template as completely as possible and we will respond as soon\nas we can.\n\n\n.. _documentation-section:\n\nDocumentation\n=============\n\nDocumentation is available `here <http://nise.readthedocs.io>`_.\n\n\n.. _license-section:\n\nLicense\n=======\n\n**nimi-python** is licensed under an MIT-style license (`see\nLICENSE <https://github.com/ni/nimi-python/blob/master/LICENSE>`_).\nOther incorporated projects may be licensed under different licenses. All\nlicenses allow for non-commercial and commercial use.\n\n\n**gRPC Features**\n\nFor driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is\nsubject to the NI General Purpose EULA (`see NILICENSE <https://github.com/ni/nimi-python/blob/master/NILICENSE>`_).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "NI Switch Executive Python API",
"version": "1.4.8",
"project_urls": {
"Homepage": "https://github.com/ni/nimi-python"
},
"split_keywords": [
"nise"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac9d73da072636aecbcbdeb103d2b8e65318dac3f7a2adc3565389f4e51b47b6",
"md5": "c62d63bc87d05d171a7669593ede282e",
"sha256": "43c5dbdfec8e244c927865f397d6f6e5e98325e4cf640b1abc993d9935671736"
},
"downloads": -1,
"filename": "nise-1.4.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c62d63bc87d05d171a7669593ede282e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22769,
"upload_time": "2024-04-26T20:12:15",
"upload_time_iso_8601": "2024-04-26T20:12:15.998852Z",
"url": "https://files.pythonhosted.org/packages/ac/9d/73da072636aecbcbdeb103d2b8e65318dac3f7a2adc3565389f4e51b47b6/nise-1.4.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "863b0670d61360ec1f72a3da6d4131c9e2461638fbf8ba3b1ddf62d13f73fab0",
"md5": "0988dfaf9ce29a43d42537efaa4ef9e9",
"sha256": "a1c05b1b7f249715a23cba318403e2a5979f1c27466e46d0a815f80fd8dd71fe"
},
"downloads": -1,
"filename": "nise-1.4.8.tar.gz",
"has_sig": false,
"md5_digest": "0988dfaf9ce29a43d42537efaa4ef9e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22623,
"upload_time": "2024-04-26T20:12:30",
"upload_time_iso_8601": "2024-04-26T20:12:30.265203Z",
"url": "https://files.pythonhosted.org/packages/86/3b/0670d61360ec1f72a3da6d4131c9e2461638fbf8ba3b1ddf62d13f73fab0/nise-1.4.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 20:12:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ni",
"github_project": "nimi-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "nise"
}
