Metadata-Version: 2.4
Name: channel_access.client
Version: 0.1.5
Summary: Channel Access client library
Author: André Althaus
Author-email: andre.althaus@tu-dortmund.de
License: MIT
Keywords: epics ca channel_access
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
Requires-Python: >= 3.5
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: channel_access.common
Provides-Extra: dev
Requires-Dist: tox; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: channel_access.server; extra == "dev"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: channel_access.server; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

Channel Access client library
=============================
This library contains the low-level bindings to the *libca* library and an
high-level thread-safe interface for ease of use.

For the server implementation see `channel_access.server`_.

.. _channel_access.server: https://pypi.org/project/channel_access.server

Installation
------------
Before installing the library, the environment variables ``EPICS_BASE``
and ``EPICS_HOST_ARCH`` must be set.

Then the library can be installed with pip::

    pip install channel_access.client

Examples
--------
Examples are located in the ``examples`` directory.

The ``simple.py`` example monitors a single process value and outputs the
contents of the data dictionary::

    python examples/simple.py test-pv

Get the source
--------------
The source code is available in a `Github repository`_::

    git clone https://github.com/delta-accelerator/channel_access.client

.. _Github repository: https://github.com/delta-accelerator/channel_access.client

Documentation
-------------
The documentation for the last version is available `online`_.

The documentation can also be generated from the source code with *sphinx*.
The package must be installed prior to building the documentation::

    cd /path/to/repository
    pip install .
    python setup.py build_sphinx

Then open ``build/sphinx/html/index.html``.

.. _online: https://delta-accelerator.github.io/channel_access.client

Tests
-----
Tests are run with *pytest*::

    cd /path/to/repository
    pytest -v

To run the tests for all supported version use *tox*::

    cd /path/to/repository
    tox
