leaf-hello-world

Name	leaf-hello-world JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	Leaf Adapter with a basic Hello World function. Creating a hello world message every x interval.
upload_time	2025-07-14 18:49:25
maintainer	None
docs_url	None
author	Jasper Koehorst
requires_python	<4.0,>=3.12
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Laboratory Equipment Adapter Framework - LEAF

This is a demo adapter for the Laboratory Equipment Adapter Framework (LEAF). It is a simple adapter that will be used to showcase how an adapter can be created and integrated into the LEAF framework.

## Installation

To install the adapter, you can use the following command:

```bash
# Clone the repository...

# Install the adapter into your python environment
poetry build
pip install dist/leaf_hello_world-0.1.0.tar.gz
```

## Usage

Once installed within `leaf` you can add a new equipment to the (minimal) config file.

```
EQUIPMENT_INSTANCES:
  - equipment:
      adapter: hello_world
      data:
        instance_id: example_equipment_id1
        institute: example_equipment_institute1
      requirements:
        interval: 11
OUTPUTS:
  - plugin: MQTT
    broker: test.mosquitto.org
    port: 1883
```

You can then start the leaf program and it should sent a 'hello world' message every 11 seconds.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "leaf-hello-world",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jasper Koehorst",
    "author_email": "jasper.koehorst@wur.nl",
    "download_url": "https://files.pythonhosted.org/packages/2a/b1/2f6b4286f3f425d9b5ed70719c3b6325e469ed5e3e18f936892ee6cad3d6/leaf_hello_world-0.1.0.tar.gz",
    "platform": null,
    "description": "# Laboratory Equipment Adapter Framework - LEAF\n\nThis is a demo adapter for the Laboratory Equipment Adapter Framework (LEAF). It is a simple adapter that will be used to showcase how an adapter can be created and integrated into the LEAF framework.\n\n## Installation\n\nTo install the adapter, you can use the following command:\n\n```bash\n# Clone the repository...\n\n# Install the adapter into your python environment\npoetry build\npip install dist/leaf_hello_world-0.1.0.tar.gz\n```\n\n## Usage\n\nOnce installed within `leaf` you can add a new equipment to the (minimal) config file.\n\n```\nEQUIPMENT_INSTANCES:\n  - equipment:\n      adapter: hello_world\n      data:\n        instance_id: example_equipment_id1\n        institute: example_equipment_institute1\n      requirements:\n        interval: 11\nOUTPUTS:\n  - plugin: MQTT\n    broker: test.mosquitto.org\n    port: 1883\n```\n\nYou can then start the leaf program and it should sent a 'hello world' message every 11 seconds.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Leaf Adapter with a basic Hello World function. Creating a hello world message every x interval.",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f8e8cfe02fc14763b20ac77ec99c76e8ebfa1cd5c26759bb4bb8d01099d41e18",
                "md5": "f048d2ea03b97cadaec31fd2d09cad43",
                "sha256": "f09eed1d2707067dcd36b5e33d67cc87ed3017d17229147699d44014180d38eb"
            },
            "downloads": -1,
            "filename": "leaf_hello_world-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f048d2ea03b97cadaec31fd2d09cad43",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 8993,
            "upload_time": "2025-07-14T18:49:24",
            "upload_time_iso_8601": "2025-07-14T18:49:24.487934Z",
            "url": "https://files.pythonhosted.org/packages/f8/e8/cfe02fc14763b20ac77ec99c76e8ebfa1cd5c26759bb4bb8d01099d41e18/leaf_hello_world-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ab12f6b4286f3f425d9b5ed70719c3b6325e469ed5e3e18f936892ee6cad3d6",
                "md5": "86f47a740cfbd0205ded6367e0febb98",
                "sha256": "30e49fb498d05f4c3f60251fc3d99ec73a25ad9d238f2ba8a5a204cb6afd895e"
            },
            "downloads": -1,
            "filename": "leaf_hello_world-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "86f47a740cfbd0205ded6367e0febb98",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 7045,
            "upload_time": "2025-07-14T18:49:25",
            "upload_time_iso_8601": "2025-07-14T18:49:25.811314Z",
            "url": "https://files.pythonhosted.org/packages/2a/b1/2f6b4286f3f425d9b5ed70719c3b6325e469ed5e3e18f936892ee6cad3d6/leaf_hello_world-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-14 18:49:25",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "leaf-hello-world"
}