unitelabs-cdk 1.0.0rc2

A framework to develop UniteLabs connectors based on the SiLA 2 standard specification.

UniteLabs Connector Development Framework

The UniteLabs Connector Development Framework (CDK) is a free and open-source framework that enables you to build connectors for laboratory hard- and software systems with interfaces that are based on industry standards like SiLA 2. If you plan on implementing an interface natively for your device or as wrapper around an existing proprietary interface, you can use this framework to get it built quickly without deep-diving into the standard specifications with our intuitive, code-first approach. It provides configurable modules you can use to quickly integrate the hardware or software you want to connect.

Installation

The UniteLabs CDK requires Python 3.9 or later. To get started quickly, we recommend to get started with out cookiecutter starter project:

$ cruft create [e-mail]:unitelabs/cdk/connector-factory.git
$ cd <my-connector-name>
$ <env-manager> run connector start -vvv

where here env-manager would be poetry, hatch, or uv.

You can also manually create a new project from scratch and install the framework with pip. In this case, of course, you'll be responsible for creating the project boilerplate files yourself.

$ pip install unitelabs-cdk

Documentation

Explore the UniteLabs CDK documentation on our docs page. From there you can find your way to the tutorials and guides.

Contribute

There are many ways to contribute to this project and our vision of freely and readily available interfaces for laboratory systems.

• Check out our contribution guidelines to help us improve this project
• Join the over 400 developers in the SiLA Slack community
• Give back to the community and add your connectors to the UniteHub by sending us an email!
• Get in touch with our developers regarding feedback and feature requests at [e-mail]
• Give us a ⭐️ on GitLab

License

We, UniteLabs, provide and maintain this free and open-source framework with the aim to enable the community to overcome any barriers in digitalizing their laboratory environment. We highly appreciate, if the users of this framework value the same principles. Therefore, if you want to make your connectors available for others, we encourage you to share them on our sharing platform, the UniteHub. As we do not want to enforce disclosure of your work, we distribute this framework under the MIT license.