nislsc 0.1.0__tar.gz

nislsc-0.1.0/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2022, National Instruments Corp.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

nislsc-0.1.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.3
+Name: nislsc
+Version: 0.1.0
+Summary: NI-SLSC Python API
+License: MIT
+Keywords: nislsc,slsc
+Author: NI
+Author-email: opensource@ni.com
+Maintainer: Jun Ying Tan
+Maintainer-email: jun.ying.tan@emerson.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Project-URL: Repository, https://github.com/ni/nislsc-python
+Description-Content-Type: text/markdown
+
+# nislsc-python
+
+## About
+
+The **nislsc** package allows you to develop instrumentation, acquisition, and control applications with NI Switch Load and Signal Conditioning (SLSC) devices in Python.
+NI created and supports this package.
+
+<!--
+### Documentation
+
+- TODO: Add documentation here.
+-->
+
+### Implementation
+
+The package is implemented in Python as an object-oriented wrapper around the NI-SLSC C API using the [ctypes](https://docs.python.org/3/library/ctypes.html) Python Library.
+
+### Supported NI-SLSC Driver Versions
+
+This package requires the NI-SLSC C API, which was introduced in NI-SLSC 20.0.
+
+### Operating System Support
+
+**nislsc** supports Windows and Linux operating systems where the NI-SLSC driver is supported. Refer to [NI Hardware and Operating System Compatibility](https://www.ni.com/r/hw-support) for which versions of the driver support your hardware on a given operating system.
+
+### Python Version Support
+
+**nislsc** supports CPython 3.9+ and PyPy3.
+
+## Installation
+
+You can use [pip](http://pypi.python.org/pypi/pip>) to download **nislsc** from
+[PyPI](https://pypi.org/project/nislsc/) and install it:
+
+```bash
+$ python -m pip install nislsc
+```
+
+<!--
+## Getting Started
+
+- TODO: Insert getting started documentation here.
+-->
+
+## Python Examples
+
+You can find the examples for **NI-SLSC Python** in the [nislsc-python examples](https://github.com/ni/nislsc-python/tree/main/examples) directory. For best results, use the examples that correspond to your current **nislsc** version. For example, if you are using version 1.0.0, then check out the examples directory in the 1.0.0 tag. Newer examples may demonstrate features that are not available in previous versions of **nislsc**.
+
+<!--
+## Usage
+
+- TODO: Insert usage instructions here.
+-->
+
+## Bugs / Feature Requests
+
+To report a bug or submit a feature request, please use the [GitHub issues page](https://github.com/ni/nislsc-python/issues).
+
+### Information to Include When Asking for Help
+
+Please include **all** of the following information when opening an issue:
+
+- Detailed steps on how to reproduce the problem and full traceback, if applicable.
+- The Python version used:
+
+    ```bash
+    python -c "import sys; print(sys.version)"
+    ```
+
+- The version of the **nislsc** used:
+
+    ```bash
+    python -m pip list
+    ```
+
+- The version of the NI-SLSC driver used. Follow [this KB article](http://digital.ni.com/express.nsf/bycode/ex8amn) to determine the version of NI-SLSC you have installed.
+- The operating system and version, for example Windows 11, Ubuntu 24.04, ...
+
+## License
+
+**nislsc** is licensed under an MIT-style license (see [LICENSE](https://github.com/ni/nislsc-python/blob/master/LICENSE)). Other incorporated projects may be licensed under different licenses. All licenses allow for non-commercial and commercial use.
+

nislsc-0.1.0/README.md

@@ -0,0 +1,81 @@
+# nislsc-python
+
+## About
+
+The **nislsc** package allows you to develop instrumentation, acquisition, and control applications with NI Switch Load and Signal Conditioning (SLSC) devices in Python.
+NI created and supports this package.
+
+<!--
+### Documentation
+
+- TODO: Add documentation here.
+-->
+
+### Implementation
+
+The package is implemented in Python as an object-oriented wrapper around the NI-SLSC C API using the [ctypes](https://docs.python.org/3/library/ctypes.html) Python Library.
+
+### Supported NI-SLSC Driver Versions
+
+This package requires the NI-SLSC C API, which was introduced in NI-SLSC 20.0.
+
+### Operating System Support
+
+**nislsc** supports Windows and Linux operating systems where the NI-SLSC driver is supported. Refer to [NI Hardware and Operating System Compatibility](https://www.ni.com/r/hw-support) for which versions of the driver support your hardware on a given operating system.
+
+### Python Version Support
+
+**nislsc** supports CPython 3.9+ and PyPy3.
+
+## Installation
+
+You can use [pip](http://pypi.python.org/pypi/pip>) to download **nislsc** from
+[PyPI](https://pypi.org/project/nislsc/) and install it:
+
+```bash
+$ python -m pip install nislsc
+```
+
+<!--
+## Getting Started
+
+- TODO: Insert getting started documentation here.
+-->
+
+## Python Examples
+
+You can find the examples for **NI-SLSC Python** in the [nislsc-python examples](https://github.com/ni/nislsc-python/tree/main/examples) directory. For best results, use the examples that correspond to your current **nislsc** version. For example, if you are using version 1.0.0, then check out the examples directory in the 1.0.0 tag. Newer examples may demonstrate features that are not available in previous versions of **nislsc**.
+
+<!--
+## Usage
+
+- TODO: Insert usage instructions here.
+-->
+
+## Bugs / Feature Requests
+
+To report a bug or submit a feature request, please use the [GitHub issues page](https://github.com/ni/nislsc-python/issues).
+
+### Information to Include When Asking for Help
+
+Please include **all** of the following information when opening an issue:
+
+- Detailed steps on how to reproduce the problem and full traceback, if applicable.
+- The Python version used:
+
+    ```bash
+    python -c "import sys; print(sys.version)"
+    ```
+
+- The version of the **nislsc** used:
+
+    ```bash
+    python -m pip list
+    ```
+
+- The version of the NI-SLSC driver used. Follow [this KB article](http://digital.ni.com/express.nsf/bycode/ex8amn) to determine the version of NI-SLSC you have installed.
+- The operating system and version, for example Windows 11, Ubuntu 24.04, ...
+
+## License
+
+**nislsc** is licensed under an MIT-style license (see [LICENSE](https://github.com/ni/nislsc-python/blob/master/LICENSE)). Other incorporated projects may be licensed under different licenses. All licenses allow for non-commercial and commercial use.

nislsc-0.1.0/generated/nislsc/__init__.py

@@ -0,0 +1,23 @@
+"""Control NI SLSC hardware through Python.
+
+This package provides a Python interface for NI SLSC hardware. Import
+the main classes to interact with SLSC devices, sessions, properties,
+and commands.
+
+Aliases
+-------
+
+The top-level ``nislsc`` package provides aliases for commonly used classes:
+
+- :class:`nislsc.Command <nislsc.command.Command>`: Open and execute SLSC device and physical channel commands.
+- :class:`nislsc.Library <nislsc.library.Library>`: Initialize and manage the SLSC library interface.
+- :class:`nislsc.Property <nislsc.property.Property>`: Access SLSC property references and configuration settings.
+- :class:`nislsc.Session <nislsc.session.Session>`: Establish sessions with SLSC devices, channels, and NVMEM areas.
+"""
+
+from nislsc.command import Command
+from nislsc.library import Library
+from nislsc.property import Property
+from nislsc.session import Session
+
+__all__ = ["Command", "Library", "Property", "Session"]