Skip to content

PatrickBaus/labnode_async

Repository files navigation

pylint PyPI PyPI - Python Version PyPI - Status License: GPL v3 code style

LabNode

This is the Python3 asyncio API library for the Labnode system.

The library is fully type-hinted.

Documentation

The full documentation can be found on GitHub Pages: https://patrickbaus.github.io/labnode_async/. I use the Numpydoc style for documentation and Sphinx for compiling it.

Setup

To install the library in a virtual environment (always use venvs with every project):

python3 -m venv env  # virtual environment, optional
source env/bin/activate
pip install labnode-async

Usage

This library makes use of asynchronous context managers to hide all connection related stuff and also handle cleanup. By the way: Context managers are great!

Connect to the remote endpoint, and it will automatically enumerate the Labnode and create the correct device.

from labnode_async import IPConnection

# Create a device and start coding
async with IPConnection("192.1680.0.2") as device:
    # Add your code here
    ...

See examples/ for more working examples.

Versioning

I use SemVer for versioning. For the versions available, see the tags of this repository.

Authors

License

This project is licensed under the GPL v3 license - see the LICENSE file for details.