Metadata-Version: 1.1
Name: nixnet
Version: 0.2.1
Summary: NI-XNET Python API
Home-page: https://github.com/ni/nixnet-python
Author: Ed Page, Ajay Jashnani
Author-email: ed.page@ni.com, ajay.jashnani@ni.com
License: MIT
Description: ===========  =============================================================
        Info         Communicate over CAN or LIN via NI-XNET hardware with Python.
        Author       National Instruments
        ===========  =============================================================
        
        .. image:: https://img.shields.io/pypi/v/nixnet.svg
            :target: https://pypi.python.org/pypi/nixnet
            :alt: PyPI
        
        .. image:: https://readthedocs.org/projects/nixnet/badge/?version=latest
            :target: http://nixnet.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation
        
        .. image:: https://img.shields.io/pypi/l/nixnet.svg
            :target: https://github.com/ni/nixnet-python/blob/master/LICENSE
            :alt: License
        
        .. image:: https://img.shields.io/pypi/pyversions/nixnet.svg
            :target: https://pypi.python.org/pypi/nixnet
            :alt: Language versions
        
        .. image:: https://travis-ci.org/ni/nixnet-python.svg?branch=master
            :target: https://travis-ci.org/ni/nixnet-python
            :alt: Build
        
        .. image:: https://coveralls.io/repos/github/ni/nixnet-python/badge.svg?branch=master
            :target: https://coveralls.io/github/ni/nixnet-python?branch=master
            :alt: Unit-test Coverage
        
        .. code-block:: python
        
           >>> import nixnet
           >>> with nixnet.FrameInStreamSession('CAN1') as input_session:
           >>>     input_session.intf.can_term = constants.CanTerm.ON
           >>>     input_session.intf.baud_rate = 125000
        
           >>>     frames = input_session.frames.read(count)
           >>>     for frame in frames:
           >>>         print('Received frame:')
           >>>         print(frame)
        
        Quick Start
        ===========
        
        Running **nixnet** requires NI-XNET or NI-XNET Runtime. Visit the
        `ni.com/downloads <http://www.ni.com/downloads/>`__ to download the latest version
        of NI-XNET.
        
        **nixnet** can be installed with `pip <http://pypi.python.org/pypi/pip>`__::
        
          $ python -m pip install nixnet
        
        Now you should be able to move onto the `Examples <https://github.com/ni/nixnet-python/tree/master/nixnet_examples>`__.
        
        Resources
        =========
        
        * `Documentation <http://nixnet.readthedocs.io>`__.
        * `Source <https://github.com/ni/nixnet-python>`__.
        
        Product Support
        ---------------
        
        The **nixnet** package and NI-XNET are supported by NI. For support, open
        a request through the NI support portal at `ni.com <http://www.ni.com>`__.
        
        Bugs / Feature Requests
        -----------------------
        
        We welcome all kinds of contributions.  If you have a bug to report or a feature
        request for **nixnet**, feel free to `open an issue on Github
        <https://github.com/ni/nixnet-python/issues>`__ or `contribute the change yourself
        <https://github.com/ni/nixnet-python/blob/master/CONTRIBUTING.rst>`__.
        
        Status
        ======
        
        **nixnet** package is created and maintained by National Instruments.
        
        * The following is support is included:
           * CAN and LIN protocol
           * Frames, Signals, and frame/signal conversion
           * Database import
           * For a complete list of supported features and functions, see the `documentation <http://nixnet.readthedocs.io>`__.
        * See the `enhancement issues <https://github.com/ni/nixnet-python/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement>`__ for potential future work.
        * Breaking API changes will be kept to a minimum. If a breaking change is made, it will be planned through
          `breaking-change isssues <https://github.com/ni/nixnet-python/issues?q=is%3Aissue+is%3Aopen+label%3Abreaking-change>`__
          and communicated via `semver <http://semver.org/>`__ and the `release notes <https://github.com/ni/nixnet-python/releases>`__.
        * `Known issues <https://github.com/ni/nixnet-python/issues?q=is%3Aissue+is%3Aopen+label%3Abug>`__.
        
        **nixnet** currently supports
        
        * Windows operating system.
        * CPython 2.7.0+, 3.4+, PyPy2, and PyPy3.
        * NI-XNET 15.5+
        
        License
        =======
        
        **nixnet** is licensed under an MIT-style license (see
        `LICENSE <https://github.com/ni/nixnet-python/blob/master/LICENSE>`__).
        Other incorporated projects may be licensed under different licenses. All
        licenses allow for non-commercial and commercial use.
        
Keywords: nixnet
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
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 :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: System :: Hardware :: Hardware Drivers
