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 **niswitch** module provides a Python API for NI-SWITCH. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.
Support Policy
--------------
**niswitch** supports all the Operating Systems supported by NI-SWITCH.
It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.
NI-SWITCH Python API Status
---------------------------
+-------------------------------+-------------------------+
| NI-SWITCH (niswitch) | |
+===============================+=========================+
| Driver Version Tested Against | 2023 Q4 |
+-------------------------------+-------------------------+
| PyPI Version | |niswitchLatestVersion| |
+-------------------------------+-------------------------+
| Supported Python Version | |niswitchPythonVersion| |
+-------------------------------+-------------------------+
| Documentation | |niswitchDocs| |
+-------------------------------+-------------------------+
| Open Issues | |niswitchOpenIssues| |
+-------------------------------+-------------------------+
| Open Pull Requests | |niswitchOpenPRs| |
+-------------------------------+-------------------------+
.. |niswitchLatestVersion| image:: http://img.shields.io/pypi/v/niswitch.svg
:alt: Latest NI-SWITCH Version
:target: http://pypi.python.org/pypi/niswitch
.. |niswitchPythonVersion| image:: http://img.shields.io/pypi/pyversions/niswitch.svg
:alt: NI-SWITCH supported Python versions
:target: http://pypi.python.org/pypi/niswitch
.. |niswitchDocs| image:: https://readthedocs.org/projects/niswitch/badge/?version=latest
:alt: NI-SWITCH Python API Documentation Status
:target: https://niswitch.readthedocs.io/en/latest
.. |niswitchOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/niswitch.svg
:alt: Open Issues + Pull Requests for NI-SWITCH
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Aniswitch
.. |niswitchOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/niswitch.svg
:alt: Pull Requests for NI-SWITCH
:target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Aniswitch
.. _niswitch_installation-section:
Installation
------------
As a prerequisite to using the **niswitch** module, you must install the NI-SWITCH 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**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
$ python -m pip install niswitch~=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 **niswitch** module to open a session to a Switch and connect channels.
.. code-block:: python
import niswitch
with niswitch.Session("Dev1") as session:
session.connect(channel1='r0', channel2='c0')
`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/niswitch/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://niswitch.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": "niswitch",
"maintainer": "NI",
"docs_url": null,
"requires_python": null,
"maintainer_email": "opensource@ni.com",
"keywords": "niswitch",
"author": "NI",
"author_email": "opensource@ni.com",
"download_url": "https://files.pythonhosted.org/packages/e4/22/360054b231e4ccf6374603354a90f6bb5360f7a4ff82652e807ae654bbd9/niswitch-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 **niswitch** module provides a Python API for NI-SWITCH. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.\n\nSupport Policy\n--------------\n**niswitch** supports all the Operating Systems supported by NI-SWITCH.\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 Python API Status\n---------------------------\n\n+-------------------------------+-------------------------+\n| NI-SWITCH (niswitch) | |\n+===============================+=========================+\n| Driver Version Tested Against | 2023 Q4 |\n+-------------------------------+-------------------------+\n| PyPI Version | |niswitchLatestVersion| |\n+-------------------------------+-------------------------+\n| Supported Python Version | |niswitchPythonVersion| |\n+-------------------------------+-------------------------+\n| Documentation | |niswitchDocs| |\n+-------------------------------+-------------------------+\n| Open Issues | |niswitchOpenIssues| |\n+-------------------------------+-------------------------+\n| Open Pull Requests | |niswitchOpenPRs| |\n+-------------------------------+-------------------------+\n\n\n.. |niswitchLatestVersion| image:: http://img.shields.io/pypi/v/niswitch.svg\n :alt: Latest NI-SWITCH Version\n :target: http://pypi.python.org/pypi/niswitch\n\n\n.. |niswitchPythonVersion| image:: http://img.shields.io/pypi/pyversions/niswitch.svg\n :alt: NI-SWITCH supported Python versions\n :target: http://pypi.python.org/pypi/niswitch\n\n\n.. |niswitchDocs| image:: https://readthedocs.org/projects/niswitch/badge/?version=latest\n :alt: NI-SWITCH Python API Documentation Status\n :target: https://niswitch.readthedocs.io/en/latest\n\n\n.. |niswitchOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/niswitch.svg\n :alt: Open Issues + Pull Requests for NI-SWITCH\n :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Aniswitch\n\n\n.. |niswitchOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/niswitch.svg\n :alt: Pull Requests for NI-SWITCH\n :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Aniswitch\n\n\n\n.. _niswitch_installation-section:\n\nInstallation\n------------\n\nAs a prerequisite to using the **niswitch** module, you must install the NI-SWITCH 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**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::\n\n $ python -m pip install niswitch~=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 **niswitch** module to open a session to a Switch and connect channels.\n\n.. code-block:: python\n\n import niswitch\n with niswitch.Session(\"Dev1\") as session:\n session.connect(channel1='r0', channel2='c0')\n\n`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/niswitch/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://niswitch.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 Python API",
"version": "1.4.8",
"project_urls": {
"Homepage": "https://github.com/ni/nimi-python"
},
"split_keywords": [
"niswitch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d864823ef2c70c719cdfbb46642df7e52106923bd64838da198bea55690dff57",
"md5": "b9ed464a5647c13f8ee6e93d1bee9b5e",
"sha256": "a5c8926d2d06f5f595898799e3e29d5be4682c3c99b3b7ced4806c37eca8d546"
},
"downloads": -1,
"filename": "niswitch-1.4.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9ed464a5647c13f8ee6e93d1bee9b5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 61110,
"upload_time": "2024-04-26T20:12:06",
"upload_time_iso_8601": "2024-04-26T20:12:06.512854Z",
"url": "https://files.pythonhosted.org/packages/d8/64/823ef2c70c719cdfbb46642df7e52106923bd64838da198bea55690dff57/niswitch-1.4.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e422360054b231e4ccf6374603354a90f6bb5360f7a4ff82652e807ae654bbd9",
"md5": "a6c4d10263a6d5f9c5f8ecadfb13d983",
"sha256": "f53b10ef33b33f54000f96064c3e901d77b01c387cb7e8a7ea2d763f89616dfc"
},
"downloads": -1,
"filename": "niswitch-1.4.8.tar.gz",
"has_sig": false,
"md5_digest": "a6c4d10263a6d5f9c5f8ecadfb13d983",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58949,
"upload_time": "2024-04-26T20:12:24",
"upload_time_iso_8601": "2024-04-26T20:12:24.053661Z",
"url": "https://files.pythonhosted.org/packages/e4/22/360054b231e4ccf6374603354a90f6bb5360f7a4ff82652e807ae654bbd9/niswitch-1.4.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 20:12:24",
"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": "niswitch"
}
JSON
