ekfsm 0.11.0b1.post3__tar.gz

ekfsm-0.11.0b1.post3/.env

@@ -0,0 +1 @@
+export PYTHONPATH=.:$PYTHONPATH

ekfsm-0.11.0b1.post3/.envrc

@@ -0,0 +1,3 @@
+source_url "https://raw.githubusercontent.com/cachix/devenv/82c0147677e510b247d8b9165c54f73d32dfd899/direnvrc" "sha256-7u4iDd1nZpxL4tCzmPG0dQgC5V+/44Ba+tHkPob1v2k="
+
+use devenv

ekfsm-0.11.0b1.post3/.flake8

@@ -0,0 +1,5 @@
+[flake8]
+max-line-length = 130
+max-complexity = 18
+exclude = myenv/ .venv/ docs/
+extend-ignore = E203

ekfsm-0.11.0b1.post3/.gitignore

@@ -0,0 +1,27 @@
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+.DS_Store
+myenv/
+.mypy_cache/
+.python-version
+dist/
+**/*.egg-info/
+coverage.xml
+report.xml
+.coverage
+result/
+result
+result-dist
+pytest.log
+.direnv/
+# Devenv
+.devenv*
+devenv.local.nix
+
+# direnv
+.direnv
+
+# pre-commit
+.pre-commit-config.yaml

ekfsm-0.11.0b1.post3/.gitlab-ci.yml

@@ -0,0 +1,201 @@
+include:
+  - project: templates/cicd
+    file: versioning.yml
+  - template: Jobs/Code-Quality.gitlab-ci.yml
+
+workflow:
+  name: $CI_COMMIT_MESSAGE
+  rules:
+    - if: $CI_COMMIT_TAG
+      when: never
+    - if: $CI_PIPELINE_SOURCE =~ /^(push|web)$/
+      when: always
+
+.default_rule_hotfix: &default_rule_hotfix
+  - if: $CI_COMMIT_BRANCH =~ /^hotfix(\/|-).*/
+    when: on_success
+
+default:
+  image:
+    name: $CI_REGISTRY/docker-container/nix-build:0.1.6 # Necessary due to if-not-present policy
+  tags:
+    - shell
+    - nix
+  interruptible: false
+
+variables:
+  CI_DEBUG_TRACE: $DEBUG # use value from gitlab project var
+  CI_SCRIPT_TRACE: $DEBUG
+  CI_GITVERSION_TRACE: $DEBUG
+  PACKAGE_REGISTRY_URL: ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi
+
+stages:
+  - test
+  - 💻 release
+  - 🧱 build
+  - ⬆️ deploy
+
+coverage:
+  stage: test
+  before_script:
+    - direnv allow .
+  script:
+    - echo "Coverage stage"
+    - direnv exec . generate-coverage
+  coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+)%/'  # Extract the total test coverage percentage
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml  # Cobertura-compatible XML report
+      junit: report.xml  # JUnit-compatible XML report
+    paths:
+      - coverage.xml  # Ensure the XML report is uploaded as an artifact
+      - report.xml  # Ensure the JUnit report is uploaded as an artifact
+
+code_quality:
+  services: []       # Shut off Docker-in-Docker
+  tags:
+    - cq-wo-dind
+
+code_quality_html:
+  extends: code_quality
+  variables:
+    REPORT_FORMAT: html
+  artifacts:
+    paths: [gl-code-quality-report.html]
+
+lint:
+  stage: test
+  before_script: 
+    - direnv allow .
+  script:
+    - echo "Lint stage"
+    - direnv exec . lint
+
+typing:
+  stage: test
+  before_script:
+    - direnv allow .
+  script:
+    - echo "Typing stage"
+    - direnv exec . typing
+
+release:
+  stage: 💻 release
+  image: registry.gitlab.com/gitlab-org/release-cli:v0.19.0
+  tags:
+    - shared
+  variables:
+    GIT_STRATEGY: none
+    GIT_SUBMODULE_STRATEGY: none
+  rules:
+    - *default_rule_hotfix
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH == "develop"
+      when: on_success
+  script:
+    - echo "Creating release ${GitVersion_SemVer} /w Asset debian packages..."
+  release:
+    tag_name: "v${GitVersion_SemVer}"
+    description: "$CI_COMMIT_MESSAGE"
+    ref: "$CI_COMMIT_SHA"
+  needs:
+    - version
+    - coverage
+    - lint
+    - typing
+
+pkg:
+  stage: 🧱 build
+  variables:
+    GIT_STRATEGY: clone
+    GIT_DEPTH: 0
+    GIT_SUBMODULE_STRATEGY: recursive
+  before_script:
+    - echo "Starting build"
+    - direnv allow .
+  script:
+    - echo "Building package..."
+    - direnv exec . generate-package
+  needs:
+    - job: release
+      optional: true
+    - job: coverage
+    - job: lint
+    - job: typing
+  artifacts:
+    untracked: false
+    when: on_success
+    expire_in: "30 days"
+    paths:
+      - dist/
+
+build-html-docs:
+  stage: 🧱 build
+  before_script:
+    - direnv allow .
+  script:
+    - echo "Building HTML documentation..."
+    - direnv exec . doc-html
+  artifacts:
+    when: on_success
+    paths:
+      - docs/build/html
+
+build-man-pages:
+  stage: 🧱 build
+  before_script:
+    - direnv allow .
+  script:
+    - echo "Building man page documentation..."
+    - direnv exec . doc-man-pages
+  artifacts:
+    when: on_success
+    paths:
+      - docs/build/man/ekfsm.1
+
+build-pdf-doc:
+  stage: 🧱 build
+  before_script:
+    - direnv allow .
+  script:
+    - echo "Building PDF documentation..."
+    - direnv exec . doc-pdf
+  artifacts:
+    when: on_success
+    paths:
+      - docs/build/latex/ekfsm.pdf
+
+build-doc-coverage:
+  stage: 🧱 build
+  before_script:
+    - direnv allow .
+  script:
+    - echo "Compute documentation coverage..."
+    - direnv exec . doc-coverage
+  coverage: '/TOTAL\s+\|\s+(\d+\.\d+%)/'  # Extract the total doc coverage percentage
+  artifacts:
+    when: on_success
+    paths:
+      - docs/build/coverage
+
+deploy:
+  stage: ⬆️ deploy
+  image: python:3.12
+  tags:
+    - shared
+  variables:
+    GIT_STRATEGY: clone
+    GIT_SUBMODULE_STRATEGY: recursive
+  rules:
+    - *default_rule_hotfix
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH == "develop"
+      when: on_success
+  before_script:
+    - echo "Install twine..."
+    - python -m pip install twine
+  script:
+    - echo "Deploying version ${GitVersion_SemVer} to pypi repository..."
+    - TWINE_PASSWORD=${CI_JOB_TOKEN} TWINE_USERNAME=gitlab-ci-token python -m twine upload --repository-url ${PACKAGE_REGISTRY_URL} dist/*
+  needs:
+    - pkg

ekfsm-0.11.0b1.post3/.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

ekfsm-0.11.0b1.post3/.vscode/launch.json

@@ -0,0 +1,67 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug CLI DB-ZIP",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/ekfsm/cli.py",
+            "console": "integratedTerminal",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}:$PYTHONPATH"
+            },
+            "args": ["-v","tests/zip2-ccu-only.yaml", "write","serial","12312312"],
+            "justMyCode": true,
+            "sudo": true
+        },
+        {
+            "name": "Debug CLI SIM",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/ekfsm/cli.py",
+            "console": "integratedTerminal",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}:$PYTHONPATH"
+            },
+            "args": ["-v","-s","tests/sim/sys","tests/sim/test_system.yaml", "show"],
+            "justMyCode": true,
+            "sudo": true
+        },
+        {
+            "name": "Python: Current File (sudo)",
+            "type": "python",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}:$PYTHONPATH"
+            },
+            "sudo": true
+        },
+        {
+            "name": "Python Debugger: Current File (sudo)",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}:$PYTHONPATH"
+            },
+            "sudo": true
+        },
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}:$PYTHONPATH"
+            },
+            "sudo": false
+        }
+    ]
+}

ekfsm-0.11.0b1.post3/.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "mypy-type-checker.reportingScope": "workspace",
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.formatOnSave": true,
+    "mypy-type-checker.preferDaemon": false,
+    "mypy-type-checker.importStrategy": "fromEnvironment",
+    "autoDocstring.docstringFormat": "numpy-notypes",
+    "autoDocstring.startOnNewLine": true,
+    "makefile.configureOnOpen": false,
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    }
+}

ekfsm-0.11.0b1.post3/LICENSE.md

@@ -0,0 +1,28 @@
+# EKFSM License (Version 1.0)
+
+**Copyright © [2024] EKF Elektronik GmbH.**
+*All rights reserved.*
+
+## EKF Non-Commercial License (ENCL)
+
+### Usage Rights
+
+**1.1.** The source code may be freely used for non-commercial purposes, including modification and further development.
+
+**1.2.** Commercial use—including but not limited to distribution, offering as a service, or integration into a commercial product—is strictly prohibited without prior written consent from the manufacturer.
+
+### Further Development
+
+**2.1.** Anyone may modify the source code and share modifications for non-commercial purposes, as long as the original copyright notice and this license text remain intact.
+
+**2.2.** Redistribution of the source code or any derived work for commercial purposes is strictly prohibited without explicit permission from the manufacturer.
+
+**2.3.** Contributions to this project are subject to a Contributor License Agreement (CLA) to ensure that all submitted changes can be shared under this license.
+
+### Disclaimer of Liability
+
+**3.1.** THE SOFTWARE IS PROVIDED “AS IS,” WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE MANUFACTURER SHALL NOT BE LIABLE FOR ANY DAMAGES RESULTING FROM THE USE OF THIS SOFTWARE.
+
+### Commercial Licensing
+
+**4.1.** For a commercial license or special agreements, please contact sales@ekf.de

ekfsm-0.11.0b1.post3/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: ekfsm
+Version: 0.11.0b1.post3
+Summary: The EKF System Management Library (ekfsm) is a sensor monitoring suite for Compact PCI Serial devices.
+Author-email: Klaus Popp <klaus.popp@ci4rail.com>, Jan Jansen <jan@ekf.de>, Felix Päßler <fp@ekf.de>
+Requires-Python: >=3.10
+Requires-Dist: anytree
+Requires-Dist: click>=8.0.1
+Requires-Dist: crcmod
+Requires-Dist: gpiod>=2.1.0
+Requires-Dist: hexdump
+Requires-Dist: more-itertools
+Requires-Dist: munch
+Requires-Dist: smbus2
+Requires-Dist: types-pyyaml>=6.0.12.20241230
+Requires-Dist: yamale
+Description-Content-Type: text/markdown
+
+# ekfsm - EKF system management library
+
+Provides access to system management functions on Linux based modular hardware systems,
+such as CompactPCI-Serial systems.
+
+Initial implementation for [DP-ZIP2 CompactPCI-Serial system](https://ekf.atlassian.net/l/cp/KzN2q7KR)
+
+## Features
+
+- System configuration via YAML configuration file
+- Obtain inventory information of the system and its components
+- Obtain sensor information, such as temperature, humidity, voltage, current, accelerometer, gyroscope, etc.
+- Access to system level functions, such as system LEDs, system fan, system power supply, etc.
+- Supports simulation mode for development and testing
+
+## Packaging
+
+The project can be packaged and deployed as a pypi package to the gitlab pypi registry.
+
+The project metadata is partially generated dynamically from the project readme and the auto generated version tag from SCM.
+
+### Build the package
+
+To build the package run `make build`
+
+### Upload package manually to the GITLAB package registry
+
+1. Set up your authentication method and the project URL in your `~/.pypirc` according to [Authenticate with the package registry](https://gitlab.ekf.com/api/v4/projects/407/packages/pypi)
+2. Run `make upload`
+
+Note that the version string which is generated complies to the `setuptools-scm` default versioning scheme and thus the version string will be slightly different from the string generated during the pipeline build if running from a shell in a workspace.
+
+*See also [SetupTools-SCM Documentation](https://setuptools-scm.readthedocs.io/en/latest/) and [SetupTool UserGuide](https://setuptools.pypa.io/en/latest/userguide).*
+
+## Install a package
+
+See instructions given in the packages deployed under [this projects pypi registry](https://gitlab.ekf.com/libs/apis/ekfsm/-/packages/).
+
+## Generating documentation
+
+From the nix shell, run `make docs` to generate the documentation. This will start a local web server to view the generated documentation. It is automatically updated when the source code changes.
+
+The documentation is generated using the `sphinx` tool. The configuration and docs are stored in the `docs` folder.
+
+
+## Remote development on the target
+
+On the remote machine, install recent version of direnv:
+
+```bash
+curl -sfL https://direnv.net/install.sh | bash
+```
+
+Add the following line to your ~/.bashrc or ~/.bash_profile:
+
+```bash
+eval "$(direnv hook bash)"
+```
+
+Install the following extensions in VSCode:
+* cab404.vscode-direnv
+* ms-python.mypy-type-checker
+* mikoz.black-py
+* ms-python.python
+* ms-python.vscode-pylance
+* ms-python.debugpy
+
+From vscode on the host machine, open the project folder on the remote machine via ssh. The direnv extension will automatically load the environment variables from the `.envrc` file.

ekfsm-0.11.0b1.post3/README.md

@@ -0,0 +1,68 @@
+# ekfsm - EKF system management library
+
+Provides access to system management functions on Linux based modular hardware systems,
+such as CompactPCI-Serial systems.
+
+Initial implementation for [DP-ZIP2 CompactPCI-Serial system](https://ekf.atlassian.net/l/cp/KzN2q7KR)
+
+## Features
+
+- System configuration via YAML configuration file
+- Obtain inventory information of the system and its components
+- Obtain sensor information, such as temperature, humidity, voltage, current, accelerometer, gyroscope, etc.
+- Access to system level functions, such as system LEDs, system fan, system power supply, etc.
+- Supports simulation mode for development and testing
+
+## Packaging
+
+The project can be packaged and deployed as a pypi package to the gitlab pypi registry.
+
+The project metadata is partially generated dynamically from the project readme and the auto generated version tag from SCM.
+
+### Build the package
+
+To build the package run `make build`
+
+### Upload package manually to the GITLAB package registry
+
+1. Set up your authentication method and the project URL in your `~/.pypirc` according to [Authenticate with the package registry](https://gitlab.ekf.com/api/v4/projects/407/packages/pypi)
+2. Run `make upload`
+
+Note that the version string which is generated complies to the `setuptools-scm` default versioning scheme and thus the version string will be slightly different from the string generated during the pipeline build if running from a shell in a workspace.
+
+*See also [SetupTools-SCM Documentation](https://setuptools-scm.readthedocs.io/en/latest/) and [SetupTool UserGuide](https://setuptools.pypa.io/en/latest/userguide).*
+
+## Install a package
+
+See instructions given in the packages deployed under [this projects pypi registry](https://gitlab.ekf.com/libs/apis/ekfsm/-/packages/).
+
+## Generating documentation
+
+From the nix shell, run `make docs` to generate the documentation. This will start a local web server to view the generated documentation. It is automatically updated when the source code changes.
+
+The documentation is generated using the `sphinx` tool. The configuration and docs are stored in the `docs` folder.
+
+
+## Remote development on the target
+
+On the remote machine, install recent version of direnv:
+
+```bash
+curl -sfL https://direnv.net/install.sh | bash
+```
+
+Add the following line to your ~/.bashrc or ~/.bash_profile:
+
+```bash
+eval "$(direnv hook bash)"
+```
+
+Install the following extensions in VSCode:
+* cab404.vscode-direnv
+* ms-python.mypy-type-checker
+* mikoz.black-py
+* ms-python.python
+* ms-python.vscode-pylance
+* ms-python.debugpy
+
+From vscode on the host machine, open the project folder on the remote machine via ssh. The direnv extension will automatically load the environment variables from the `.envrc` file.

ekfsm-0.11.0b1.post3/devenv.lock

@@ -0,0 +1,103 @@
+{
+  "nodes": {
+    "devenv": {
+      "locked": {
+        "dir": "src/modules",
+        "lastModified": 1740575096,
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "4000b0153c6f54a57368c0b066aaa0024450618c",
+        "type": "github"
+      },
+      "original": {
+        "dir": "src/modules",
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1733328505,
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1737465171,
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "9364dc02281ce2d37a1f55b6e51f7c0f65a75f17",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "git-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1733477122,
+        "owner": "cachix",
+        "repo": "devenv-nixpkgs",
+        "rev": "7bd9e84d0452f6d2e63b6e6da29fe73fac951857",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "rolling",
+        "repo": "devenv-nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "git-hooks": "git-hooks",
+        "nixpkgs": "nixpkgs",
+        "pre-commit-hooks": [
+          "git-hooks"
+        ]
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}