NI System Configuration Python API
==================================
Python bindings for NI System Configuration. See `GitHub <https://github.com/tkrebes/nisyscfg-python/>`_ for the latest source.
Author: National Instruments
About
=====
The **nisyscfg** package contains an API (Application Programming Interface)
for interacting with NI System Configuration. The package is implemented in Python.
This package was created by NI. The package is implemented as a complex, highly
object-oriented wrapper around the NI System Configuration C API using the
`ctypes <https://docs.python.org/2/library/ctypes.html>`_ Python library.
**nisyscfg** supports only the Windows and Linux operating systems.
**nisyscfg** supports CPython 3.7+.
Installation
============
Note: Running **nisyscfg** requires the NI System Configuration Runtime. Visit the
`ni.com/downloads <http://www.ni.com/downloads/>`_ to download the latest version
of NI System Configuration.
Install **nisyscfg** from PyPI:
.. code-block:: bash
$ pip install nisyscfg
Or, install **nisyscfg** by cloning the main branch and running the following command in the directory of setup.py:
.. code-block:: bash
$ pip install --pre .
.. _usage-section:
Usage
=====
The following is a basic example of using an **nisyscfg.Session** object.
.. code-block:: python
>>> import nisyscfg
>>> with nisyscfg.Session() as session:
>>> # Print user aliases for all National Instruments devices in the local system
>>> filter = session.create_filter()
>>> filter.is_present = True
>>> filter.is_ni_product = True
>>> filter.is_device = True
>>> for resource in session.find_hardware(filter):
>>> print(resource.expert_user_alias[0])
Raw data
{
"_id": null,
"home_page": "https://github.com/tkrebes/nisyscfg-python",
"name": "nisyscfg",
"maintainer": "Tyler Krehbiel",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "tyler.krehbiel@ni.com",
"keywords": "nisyscfg,syscfg",
"author": "National Instruments",
"author_email": "",
"download_url": "",
"platform": null,
"description": "NI System Configuration Python API\n==================================\nPython bindings for NI System Configuration. See `GitHub <https://github.com/tkrebes/nisyscfg-python/>`_ for the latest source.\n\nAuthor: National Instruments\n\nAbout\n=====\n\nThe **nisyscfg** package contains an API (Application Programming Interface)\nfor interacting with NI System Configuration. The package is implemented in Python.\nThis package was created by NI. The package is implemented as a complex, highly\nobject-oriented wrapper around the NI System Configuration C API using the\n`ctypes <https://docs.python.org/2/library/ctypes.html>`_ Python library.\n\n**nisyscfg** supports only the Windows and Linux operating systems.\n\n**nisyscfg** supports CPython 3.7+.\n\nInstallation\n============\n\nNote: Running **nisyscfg** requires the NI System Configuration Runtime. Visit the\n`ni.com/downloads <http://www.ni.com/downloads/>`_ to download the latest version\nof NI System Configuration.\n\nInstall **nisyscfg** from PyPI:\n\n.. code-block:: bash\n\n $ pip install nisyscfg\n\nOr, install **nisyscfg** by cloning the main branch and running the following command in the directory of setup.py:\n\n.. code-block:: bash\n\n $ pip install --pre .\n\n.. _usage-section:\n\nUsage\n=====\nThe following is a basic example of using an **nisyscfg.Session** object.\n\n.. code-block:: python\n\n >>> import nisyscfg\n >>> with nisyscfg.Session() as session:\n >>> # Print user aliases for all National Instruments devices in the local system\n >>> filter = session.create_filter()\n >>> filter.is_present = True\n >>> filter.is_ni_product = True\n >>> filter.is_device = True\n >>> for resource in session.find_hardware(filter):\n >>> print(resource.expert_user_alias[0])\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "NI System Configuration Python API",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/tkrebes/nisyscfg-python"
},
"split_keywords": [
"nisyscfg",
"syscfg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39a2b90aaa4733a92388d89645c31f0afd2ee1322b461c6220b9bb60f501e75b",
"md5": "199d91d4c97d8fe27947a30ad453cf09",
"sha256": "bd6ce4e9b315a643c32cba88bb90b1b31b88fce94a628158d4b9b0e96cbbb0d6"
},
"downloads": -1,
"filename": "nisyscfg-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "199d91d4c97d8fe27947a30ad453cf09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 48465,
"upload_time": "2023-07-12T21:54:40",
"upload_time_iso_8601": "2023-07-12T21:54:40.571128Z",
"url": "https://files.pythonhosted.org/packages/39/a2/b90aaa4733a92388d89645c31f0afd2ee1322b461c6220b9bb60f501e75b/nisyscfg-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 21:54:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tkrebes",
"github_project": "nisyscfg-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "nisyscfg"
}
JSON
