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 **nimodinst** module provides a Python API for NI-ModInst. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.
Support Policy
--------------
**nimodinst** supports all the Operating Systems supported by NI-ModInst.
It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.
NI-ModInst Python API Status
----------------------------
+-------------------------------+--------------------------+
| NI-ModInst (nimodinst) | |
+===============================+==========================+
| Driver Version Tested Against | 2024 Q2 |
+-------------------------------+--------------------------+
| PyPI Version | |nimodinstLatestVersion| |
+-------------------------------+--------------------------+
| Supported Python Version | |nimodinstPythonVersion| |
+-------------------------------+--------------------------+
| Documentation | |nimodinstDocs| |
+-------------------------------+--------------------------+
| Open Issues | |nimodinstOpenIssues| |
+-------------------------------+--------------------------+
| Open Pull Requests | |nimodinstOpenPRs| |
+-------------------------------+--------------------------+
.. |nimodinstLatestVersion| image:: http://img.shields.io/pypi/v/nimodinst.svg
:alt: Latest NI-ModInst Version
:target: http://pypi.python.org/pypi/nimodinst
.. |nimodinstPythonVersion| image:: http://img.shields.io/pypi/pyversions/nimodinst.svg
:alt: NI-ModInst supported Python versions
:target: http://pypi.python.org/pypi/nimodinst
.. |nimodinstDocs| image:: https://readthedocs.org/projects/nimodinst/badge/?version=latest
:alt: NI-ModInst Python API Documentation Status
:target: https://nimodinst.readthedocs.io/en/latest
.. |nimodinstOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nimodinst.svg
:alt: Open Issues + Pull Requests for NI-ModInst
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Animodinst
.. |nimodinstOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nimodinst.svg
:alt: Pull Requests for NI-ModInst
:target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Animodinst
.. _nimodinst_installation-section:
Installation
------------
As a prerequisite to using the **nimodinst** module, you must install the NI-ModInst 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-ModInst**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
$ python -m pip install nimodinst~=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 **nimodinst** module to retrieve information on all High Speed Digitizers currently in the system.
.. code-block:: python
import nimodinst
with nimodinst.Session("niscope") as session:
for device in session:
print("{: >20} {: >15} {: >10}".format(device.device_name, device.device_model, device.serial_number))
`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nimodinst/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://nimodinst.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": "nimodinst",
"maintainer": "NI",
"docs_url": null,
"requires_python": null,
"maintainer_email": "opensource@ni.com",
"keywords": "nimodinst",
"author": "NI",
"author_email": "opensource@ni.com",
"download_url": "https://files.pythonhosted.org/packages/8c/bf/f22a2617080f1b7cfaeede3e43985cc7ad213a6c69d6d1c90f85265383f8/nimodinst-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 **nimodinst** module provides a Python API for NI-ModInst. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.\n\nSupport Policy\n--------------\n**nimodinst** supports all the Operating Systems supported by NI-ModInst.\n\nIt follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.\n\n\nNI-ModInst Python API Status\n----------------------------\n\n+-------------------------------+--------------------------+\n| NI-ModInst (nimodinst) | |\n+===============================+==========================+\n| Driver Version Tested Against | 2024 Q2 |\n+-------------------------------+--------------------------+\n| PyPI Version | |nimodinstLatestVersion| |\n+-------------------------------+--------------------------+\n| Supported Python Version | |nimodinstPythonVersion| |\n+-------------------------------+--------------------------+\n| Documentation | |nimodinstDocs| |\n+-------------------------------+--------------------------+\n| Open Issues | |nimodinstOpenIssues| |\n+-------------------------------+--------------------------+\n| Open Pull Requests | |nimodinstOpenPRs| |\n+-------------------------------+--------------------------+\n\n\n.. |nimodinstLatestVersion| image:: http://img.shields.io/pypi/v/nimodinst.svg\n :alt: Latest NI-ModInst Version\n :target: http://pypi.python.org/pypi/nimodinst\n\n\n.. |nimodinstPythonVersion| image:: http://img.shields.io/pypi/pyversions/nimodinst.svg\n :alt: NI-ModInst supported Python versions\n :target: http://pypi.python.org/pypi/nimodinst\n\n\n.. |nimodinstDocs| image:: https://readthedocs.org/projects/nimodinst/badge/?version=latest\n :alt: NI-ModInst Python API Documentation Status\n :target: https://nimodinst.readthedocs.io/en/latest\n\n\n.. |nimodinstOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nimodinst.svg\n :alt: Open Issues + Pull Requests for NI-ModInst\n :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Animodinst\n\n\n.. |nimodinstOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nimodinst.svg\n :alt: Pull Requests for NI-ModInst\n :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Animodinst\n\n\n\n.. _nimodinst_installation-section:\n\nInstallation\n------------\n\nAs a prerequisite to using the **nimodinst** module, you must install the NI-ModInst 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-ModInst**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::\n\n $ python -m pip install nimodinst~=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 **nimodinst** module to retrieve information on all High Speed Digitizers currently in the system.\n\n.. code-block:: python\n\n import nimodinst\n with nimodinst.Session(\"niscope\") as session:\n for device in session:\n print(\"{: >20} {: >15} {: >10}\".format(device.device_name, device.device_model, device.serial_number))\n\n`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nimodinst/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://nimodinst.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-ModInst Python API",
"version": "1.4.8",
"project_urls": {
"Homepage": "https://github.com/ni/nimi-python"
},
"split_keywords": [
"nimodinst"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6b21ee232c304ae8165e50701606f32df3a23956e8a5ed622ef1347f343f692",
"md5": "34a8966b99658ff37e029510c3864e5b",
"sha256": "3a704dfd8e4a033ec483cc69cf31568889e445cb796216b823d8350da9b132c3"
},
"downloads": -1,
"filename": "nimodinst-1.4.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "34a8966b99658ff37e029510c3864e5b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17531,
"upload_time": "2024-04-26T20:12:08",
"upload_time_iso_8601": "2024-04-26T20:12:08.193691Z",
"url": "https://files.pythonhosted.org/packages/c6/b2/1ee232c304ae8165e50701606f32df3a23956e8a5ed622ef1347f343f692/nimodinst-1.4.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8cbff22a2617080f1b7cfaeede3e43985cc7ad213a6c69d6d1c90f85265383f8",
"md5": "4d88c39e158560e3ca6fb84523e76f9d",
"sha256": "21498ab3e06ebc2a643df0b60c97692046a7d5e77037bb50fe089a135e00109a"
},
"downloads": -1,
"filename": "nimodinst-1.4.8.tar.gz",
"has_sig": false,
"md5_digest": "4d88c39e158560e3ca6fb84523e76f9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17515,
"upload_time": "2024-04-26T20:12:25",
"upload_time_iso_8601": "2024-04-26T20:12:25.217056Z",
"url": "https://files.pythonhosted.org/packages/8c/bf/f22a2617080f1b7cfaeede3e43985cc7ad213a6c69d6d1c90f85265383f8/nimodinst-1.4.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 20:12:25",
"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": "nimodinst"
}
JSON
