Metadata-Version: 1.1
Name: ingenialink
Version: 5.2.1
Summary: IngeniaLink Communications Library
Home-page: https://www.ingeniamc.com
Author: Ingenia Motion Control
Author-email: support@ingeniamc.com
License: UNKNOWN
Description: ==================
        ingenialink-python
        ==================
        
        .. image:: https://travis-ci.org/ingeniamc/ingenialink-python.svg?branch=master
            :target: https://travis-ci.org/ingeniamc/ingenialink-python
            :alt: Build Status
        
        .. image:: https://ci.appveyor.com/api/projects/status/evmgqlo3r0i6fr1d?svg=true
            :target: https://ci.appveyor.com/project/gmarull/ingenialink-python
            :alt: Build Status
        
        .. image:: https://readthedocs.org/projects/ingenialink/badge/?version=latest
            :target: http://ingenialink.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/pypi/v/ingenialink.svg
            :target: https://pypi.python.org/pypi/ingenialink
            :alt: PyPI Version
        
        .. image:: https://api.codacy.com/project/badge/Grade/6bccc35bdbdb474c8fefa98f6c4a425e
            :target: https://www.codacy.com/app/gmarull/ingenialink-python
            :alt: Code Quality
        
        This is a Python binding for the ingenialink_ C library. The binding is built as
        a native Python extension thanks to cffi_ and then exposed through an
        object-oriented API.
        
        Python versions >=3.5 are supported.
        
        .. image:: https://s3.eu-central-1.amazonaws.com/ingeniamc-cdn/images/all-servodrives.png
             :target: http://www.ingeniamc.com
             :alt: Ingenia Servodrives
        
        .. _ingenialink: https://github.com/ingeniamc/ingenialink
        .. _cffi: https://cffi.readthedocs.io/en/latest/
        
        Installation
        ------------
        
        The recommended way to install is by using ``pip``, i.e::
        
            pip install ingenialink
        
        Windows binary wheels are provided for all supported Python versions. For Linux
        and macOS, `pip` will automatically compile and install the library provided you
        have the requirements listed
        `here <http://ingenialink.readthedocs.io/en/latest/building.html>`_ installed.
        On recent versions of Debian/Ubuntu this translates to::
        
            sudo apt install python3-dev libffi-dev libudev-dev libxml2-dev build-essential cmake git
        
        Development and examples
        ------------------------
        
        `pipenv <https://docs.pipenv.org>`_ is used for package management. You can
        bring up a development environment like this::
        
            pipenv install --dev
        
        After that, you can enter the environment shell like this::
        
            pipenv shell
        
        and from there you can run any of the usage examples in the ``examples`` folder.
        Below you have a glimpse of the ``scope`` and ``monitor`` examples:
        
        .. image:: https://s3.eu-central-1.amazonaws.com/ingeniamc-cdn/images/examples-scope.gif
             :alt: Scope example
        
        .. image:: https://s3.eu-central-1.amazonaws.com/ingeniamc-cdn/images/example-monitor.png
             :alt: Monitor example
        
        Documentation
        -------------
        
        For further details you can read the documentation_ where you will find
        simple usage examples, the API docs, etc.
        
        .. _documentation: https://ingenialink.readthedocs.io
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Communications
Classifier: Topic :: Software Development :: Libraries
