OpenSMI-Core 0.1__tar.gz

opensmi_core-0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

opensmi_core-0.1/.gitignore

@@ -0,0 +1,18 @@
+*.pyc
+/.idea
+/.vs
+/.vscode
+*.egg-info
+/dist
+*.log
+/build
+/tools/UNECE_to_OPCUA.csv
+/.venv/
+/uv.lock
+/*.xml
+/*.html
+*.coverage
+/apidocs
+*.der
+*.pem
+*.sql

opensmi_core-0.1/.gitlab-ci.yml

@@ -0,0 +1,49 @@
+default:
+  image: python:3.14-alpine
+  cache:
+    key: "$CI_COMMIT_REF_SLUG"
+    paths:
+      - .cache/pip
+  tags:
+    - k8s
+
+test:
+  stage: test
+  parallel:
+    matrix:
+      - PYTHON_VERSION: [ "3.11", "3.14" ]
+  image: python:${PYTHON_VERSION}-alpine
+  before_script:
+    - apk add --no-cache git
+    - python --version
+    - python -m pip install --cache-dir .cache/pip --upgrade pip setuptools wheel
+    - python -m pip install --cache-dir .cache/pip . --group dev
+  script:
+    - python -m pytest --timeout=120 --html=report.html --self-contained-html --junitxml=result.xml --cov=open_smi --cov-report term --cov-report xml:coverage.xml -v -n 8
+  coverage: '/TOTAL.+ ([0-9]{1,3}%)/'
+  artifacts:
+    when: always
+    paths:
+      - report.html
+      - result.xml
+      - coverage.xml
+      - .coverage
+    reports:
+      junit: result.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+package:
+  stage: deploy
+  variables:
+    TWINE_USERNAME: __token__
+    TWINE_PASSWORD: ${TEST_PYPI_PASSWORD}
+    TWINE_REPOSITORY_URL: https://test.pypi.org/legacy/
+  script:
+    - apk add --no-cache git
+    - pip install build twine
+    - python -m build
+    - python -m twine upload dist/* --verbose
+  rules:
+    - if: $CI_COMMIT_TAG

opensmi_core-0.1/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026 OpenSMI Contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

opensmi_core-0.1/LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026 OpenSMI Contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

opensmi_core-0.1/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.4
+Name: OpenSMI-Core
+Version: 0.1
+Summary: Smart Machine Interface core functionality for server and client applications.
+Author-email: Carsten Harms <Carsten.Harms@dfki.de>, Simon Jungbluth <Simon.Jungbluth@smartfactory.de>
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: asyncua<3,>=2.0.1
+Requires-Dist: structlog>=26
+Requires-Dist: typing-extensions>=4.16.0
+Provides-Extra: rich
+Requires-Dist: rich>=15.0.0; extra == "rich"
+Requires-Dist: colorama>=0.4; sys_platform == "win32" and extra == "rich"
+Provides-Extra: json
+Requires-Dist: orjson<4,>=3; extra == "json"
+Dynamic: license-file

opensmi_core-0.1/README.md

@@ -0,0 +1,2 @@
+# OpenSMI Common
+

opensmi_core-0.1/pyproject.toml

@@ -0,0 +1,180 @@
+[build-system]
+requires = ["setuptools>=80", "setuptools-scm[simple]>=9.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "OpenSMI-Core"
+dynamic = ["version"]
+
+description = "Smart Machine Interface core functionality for server and client applications."
+authors = [
+    { name = "Carsten Harms", email = "Carsten.Harms@dfki.de" },
+    { name = "Simon Jungbluth", email = "Simon.Jungbluth@smartfactory.de" },
+]
+
+# see https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: Manufacturing",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Communications",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed"
+]
+
+requires-python = ">=3.11"
+
+dependencies = [
+    "asyncua>=2.0.1,<3", # OPC UA, main dep; has quite a few deps
+    "structlog>=26", # structured logging; has no deps
+    "typing-extensions>=4.16.0", # backported type hints; already a dep of asyncua
+]
+
+[project.optional-dependencies]
+rich = [
+    "rich>=15.0.0", # colorful logging; transitive deps: markdown-it-py, mdurl & pygments
+    "colorama>=0.4; sys_platform == 'win32'", # colors in terminal on Windows; has no deps
+]
+json = [
+    "orjson>=3, <4", # faster JSON logging; has no deps
+]
+
+[dependency-groups]
+dev = [
+    "basedpyright>=1.39.9",
+    "ruff>=0.15",
+    "pytest>=9",
+    "pytest-asyncio>=1",
+    "pytest-cov>=7",
+    "pytest-xdist>=3",
+    "pytest-html>=4",
+    "pytest-timeout>=2",
+    "openpyxl"  # to load UNECE Excel to autogenerate units
+]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = true
+# exclude = ["tests", "doc*", "examples"]
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+line-length = 120
+indent-width = 4
+fix = true
+
+
+[tool.ruff.lint]
+select = ["A", "ANN001", "ANN201", "ANN205", "ANN206",
+    "ASYNC", "B", "C4", "CPY", "D", "DTZ", "E", "EM",
+    "EXE", "F", "FA", "ICN", "I", "LOG", "T20", "PT",
+    "SLF", "SIM", "C901", "N", "PIE", "PLE", "PYI", "PT",
+    "Q", "RSE", "RET", "TD", "PERF", "UP", "FURB", "RUF",
+    "TRY"]
+ignore = ["D203", "D213"]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.lint.flake8-annotations]
+allow-star-arg-any = true
+
+[tool.ruff.lint.flake8-copyright]
+notice-rgx = "SPDX-FileCopyrightText: \\d{4}"
+author = "OpenSMI Contributors"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["ANN", "D", "T", "SLF001"]
+"src/opensmi/core/unit_all.py" = [ # auto-generated
+    "E501",  # line too long
+    "RUF001",  # String contains ambiguous ~
+    "CPY",  # copyright
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = true
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.mypy]
+packages = "src/opensmi/core"
+
+warn_unused_configs = true
+pretty = true
+
+strict = true
+
+[tool.basedpyright]
+include = ["src"]
+typeCheckingMode = "standard"
+executionEnvironments = [{ root = "src" }]
+
+[tool.pydoctor]
+project-name = "OpenSMI-Core"
+add-package = ["src/opensmi/core"]
+docformat = "restructuredtext"
+theme = "readthedocs"
+# verbose = 1
+warnings-as-errors = true
+intersphinx = ["https://opcua-asyncio.readthedocs.io/en/latest/objects.inv"] # TODO(CaHa): does not work

opensmi_core-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

opensmi_core-0.1/src/OpenSMI_Core.egg-info/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.4
+Name: OpenSMI-Core
+Version: 0.1
+Summary: Smart Machine Interface core functionality for server and client applications.
+Author-email: Carsten Harms <Carsten.Harms@dfki.de>, Simon Jungbluth <Simon.Jungbluth@smartfactory.de>
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: asyncua<3,>=2.0.1
+Requires-Dist: structlog>=26
+Requires-Dist: typing-extensions>=4.16.0
+Provides-Extra: rich
+Requires-Dist: rich>=15.0.0; extra == "rich"
+Requires-Dist: colorama>=0.4; sys_platform == "win32" and extra == "rich"
+Provides-Extra: json
+Requires-Dist: orjson<4,>=3; extra == "json"
+Dynamic: license-file

opensmi_core-0.1/src/OpenSMI_Core.egg-info/SOURCES.txt

@@ -0,0 +1,40 @@
+.gitignore
+.gitlab-ci.yml
+LICENSE
+README.md
+pyproject.toml
+.github/workflows/python-publish.yml
+LICENSES/MIT.txt
+src/OpenSMI_Core.egg-info/PKG-INFO
+src/OpenSMI_Core.egg-info/SOURCES.txt
+src/OpenSMI_Core.egg-info/dependency_links.txt
+src/OpenSMI_Core.egg-info/requires.txt
+src/OpenSMI_Core.egg-info/scm_file_list.json
+src/OpenSMI_Core.egg-info/scm_version.json
+src/OpenSMI_Core.egg-info/top_level.txt
+src/opensmi/core/__init__.py
+src/opensmi/core/async_task_mixin.py
+src/opensmi/core/base_server.py
+src/opensmi/core/base_ua_object.py
+src/opensmi/core/config.py
+src/opensmi/core/enums.py
+src/opensmi/core/errors.py
+src/opensmi/core/frozen.py
+src/opensmi/core/hook.py
+src/opensmi/core/lifecycle_mixin.py
+src/opensmi/core/logging.py
+src/opensmi/core/meta.py
+src/opensmi/core/mixin_helpers.py
+src/opensmi/core/protocols.py
+src/opensmi/core/repr_mixin.py
+src/opensmi/core/signal.py
+src/opensmi/core/subscription_manager.py
+src/opensmi/core/ua.py
+src/opensmi/core/ua_enums.py
+src/opensmi/core/ua_node_util.py
+src/opensmi/core/unit_all.py
+src/opensmi/core/unit_base.py
+src/opensmi/core/unset.py
+tests/test_signal.py
+tests/test_unit.py
+tools/auto_generate_units.py

opensmi_core-0.1/src/OpenSMI_Core.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

opensmi_core-0.1/src/OpenSMI_Core.egg-info/requires.txt

@@ -0,0 +1,12 @@
+asyncua<3,>=2.0.1
+structlog>=26
+typing-extensions>=4.16.0
+
+[json]
+orjson<4,>=3
+
+[rich]
+rich>=15.0.0
+
+[rich:sys_platform == "win32"]
+colorama>=0.4

opensmi_core-0.1/src/OpenSMI_Core.egg-info/scm_file_list.json

@@ -0,0 +1,37 @@
+{
+  "files": [
+    ".github/workflows/python-publish.yml",
+    ".gitignore",
+    ".gitlab-ci.yml",
+    "LICENSE",
+    "LICENSES/MIT.txt",
+    "README.md",
+    "pyproject.toml",
+    "src/opensmi/core/__init__.py",
+    "src/opensmi/core/async_task_mixin.py",
+    "src/opensmi/core/base_server.py",
+    "src/opensmi/core/base_ua_object.py",
+    "src/opensmi/core/config.py",
+    "src/opensmi/core/enums.py",
+    "src/opensmi/core/errors.py",
+    "src/opensmi/core/frozen.py",
+    "src/opensmi/core/hook.py",
+    "src/opensmi/core/lifecycle_mixin.py",
+    "src/opensmi/core/logging.py",
+    "src/opensmi/core/meta.py",
+    "src/opensmi/core/mixin_helpers.py",
+    "src/opensmi/core/protocols.py",
+    "src/opensmi/core/repr_mixin.py",
+    "src/opensmi/core/signal.py",
+    "src/opensmi/core/subscription_manager.py",
+    "src/opensmi/core/ua.py",
+    "src/opensmi/core/ua_enums.py",
+    "src/opensmi/core/ua_node_util.py",
+    "src/opensmi/core/unit_all.py",
+    "src/opensmi/core/unit_base.py",
+    "src/opensmi/core/unset.py",
+    "tests/test_signal.py",
+    "tests/test_unit.py",
+    "tools/auto_generate_units.py"
+  ]
+}

opensmi_core-0.1/src/OpenSMI_Core.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.1",
+  "distance": 0,
+  "node": "g00bee2346bf90929caf7a2fb0ea251f864e2174c",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-09-15"
+}

opensmi_core-0.1/src/OpenSMI_Core.egg-info/top_level.txt

@@ -0,0 +1 @@
+opensmi

opensmi_core-0.1/src/opensmi/core/__init__.py

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2026 OpenSMI Contributors
+#
+# SPDX-License-Identifier: MIT
+
+"""Common functionality for both server and client."""
+
+from importlib import metadata
+
+from .async_task_mixin import AsyncTaskMixin as AsyncTaskMixin
+from .enums import LifecycleState as LifecycleState
+from .lifecycle_mixin import LifecycleMixin as LifecycleMixin
+from .lifecycle_mixin import lifecycle as lifecycle
+from .logging import LogFormat as LogFormat
+from .logging import setup_logging as setup_logging
+from .signal import Signal as Signal
+from .ua_enums import MachineryItemState as MachineryItemState
+from .ua_enums import MachineryOperationMode as MachineryOperationMode
+from .ua_enums import SkillState as SkillState
+from .unit_all import Unit as Unit
+
+__version__ = metadata.version("OpenSMI-Core")

opensmi_core-0.1/src/opensmi/core/async_task_mixin.py

@@ -0,0 +1,55 @@
+# SPDX-FileCopyrightText: 2026 OpenSMI Contributors
+#
+# SPDX-License-Identifier: MIT
+
+"""Mixin for reliable tracking of fire-and-forget asyncio tasks."""
+
+import asyncio
+from collections.abc import Coroutine
+from typing import Any
+
+
+class AsyncTaskMixin:
+    """Mixin for reliable tracking of fire-and-forget asyncio tasks.
+
+    Avoids such tasks disappearing while executing when garbage collected
+    (https://docs.python.org/3/library/asyncio-task.html#creating-tasks).
+    """
+
+    __tasks: set[asyncio.Task[None]] | None = None
+
+    def _create_task(
+        self,
+        coro: Coroutine[Any, Any, None],  # pyright: ignore[reportExplicitAny]
+        *,
+        name: str,
+    ) -> None:
+        """Schedule and track a background coroutine.
+
+        The coroutine must return ``None``.
+        """
+        if self.__tasks is None:
+            self.__tasks = set()
+
+        task = asyncio.create_task(coro, name=name)
+        self.__tasks.add(task)
+        task.add_done_callback(self.__tasks.discard)
+
+    @property
+    def _pending_tasks(self) -> set[asyncio.Task[None]]:
+        """Return currently running tracked tasks."""
+        if self.__tasks is None:
+            return set()
+        return self.__tasks.copy()
+
+    async def _cancel_tasks(self) -> None:
+        """Cancel and await all tracked tasks."""
+        if self.__tasks is None:
+            return  # nothing to cancel
+        tasks = self.__tasks.copy()
+
+        for task in tasks:
+            _ = task.cancel()
+
+        if tasks:
+            _ = await asyncio.gather(*tasks, return_exceptions=True)