Metadata-Version: 1.1
Name: nixnet
Version: 0.1.0.dev4
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://img.shields.io/pypi/pyversions/nixnet.svg
            :target: https://pypi.python.org/pypi/nixnet
            :alt: Language versions
        
        .. 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://travis-ci.org/ni/nixnet-python.svg?branch=master
            :target: https://travis-ci.org/ni/nixnet-python
            :alt: Build
        
        .. image:: https://pyup.io/repos/github/ni/nixnet-python/shield.svg
            :target: https://pyup.io/repos/github/ni/nixnet-python/
            :alt: Dependencies
        
        .. 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_can(count)
           >>>     for frame in frames:
           >>>         print('Received frame:')
           >>>         print(frame)
        
        Installation
        ============
        
        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
        
        Or **easy_install** from
        `setuptools <http://pypi.python.org/pypi/setuptools>`_::
        
          $ python -m easy_install nixnet
        
        You also can download the project source and run::
        
          $ python setup.py install
        
        Resources
        =========
        
        - `Examples <https://github.com/ni/nixnet-python/tree/master/nixnet_examples>`_.
        - `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** is still early in its development with all the bugs, unimplemented
        features, and API changes that go along with that.
        
        The areas that are more mature include:
        
        - ``FrameInStreamSession`` with reading and writing bytes, raw frames, and can frames.
        - ``FrameOutStreamSession`` with writing bytes, raw frames, and can frames.
        - ``FrameInQueuedSession`` with reading bytes, raw frames, and can frames.
        - ``FrameOutQueuedSession`` with writing bytes, raw frames, and can frames.
        - ``FrameInSinglePointSession`` with reading bytes, raw frames, and can frames.
        - ``FrameOutSinglePointSession`` with writing bytes, raw frames, and can frames.
        - ``SignalInSinglePointSession`` with reading values (timestamps are available but less mature).
        - ``SignalOutSinglePointSession`` with writing values.
        
        **nixnet** currently supports
        
        - Windows operating system.
        - CPython 2.7.7+, 3.4+, PyPy2, and PyPy3.
        
        You can checkout the `issues page <https://github.com/ni/nixnet-python/issues>`_ for more details.
        
        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
