spl-core 7.11.0__tar.gz → 7.11.1__tar.gz

{spl_core-7.11.0 → spl_core-7.11.1}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: spl-core
-Version: 7.11.0
+Version: 7.11.1
 Summary: Software Product Line Support for CMake
 License: MIT
+License-File: LICENSE
 Author: Avengineers
 Author-email: karsten.guenther@kamg.de
 Requires-Python: >=3.10,<3.12
@@ -20,7 +21,7 @@ Requires-Dist: doxysphinx (>=3.3,<4.0)
 Requires-Dist: gcovr (>=8.3,<9.0)
 Requires-Dist: hammocking (>=0.8,<0.10)
 Requires-Dist: kconfiglib (>=14.1,<15.0)
-Requires-Dist: mlx-traceability (>=10.0,<11.0)
+Requires-Dist: mlx-traceability (>=10,<12)
 Requires-Dist: myst-parser (>=0.16)
 Requires-Dist: py-app-dev (>=2.1,<3.0)
 Requires-Dist: py7zr (>=1.0.0,<2.0.0)

{spl_core-7.11.0 → spl_core-7.11.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spl-core"
-version = "7.11.0"
+version = "7.11.1"
 description = "Software Product Line Support for CMake"
 authors = ["Avengineers <karsten.guenther@kamg.de>"]
 license = "MIT"
@@ -43,7 +43,7 @@ sphinxcontrib-plantuml = ">=0.29,<0.31"
 sphinx-copybutton = "^0.5"
 sphinx-new-tab-link = ">=0.4,<0.9"
 myst-parser = ">=0.16"
-mlx-traceability = "^10.0"
+mlx-traceability = ">=10,<12"
 sphinx-book-theme = "^1.1"
 sphinx-design = ">=0.5,<0.7"
 pypeline-semantic-release = ">=0.4.1,<=0.5.0"

spl_core-7.11.1/src/spl_core/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.11.1"

spl_core-7.11.1/src/spl_core/kickstart/templates/application/src/greeter/doc/index.md

@@ -0,0 +1,31 @@
+# Software Detailed Design
+
+```{figure}  _images/screenshot.png
+```
+
+```{mermaid}
+
+graph TD
+   A[Start] --> B{Language}
+   B -->|DE| C[Hallo Welt]
+   B -->|EN| D[Hello World]
+
+   C --> E[End]
+   D --> E
+
+```
+
+Requirements
+------------
+
+```{spec} Say Hello
+:id: SWDD_GREETER-001
+:integrity: QM
+
+{% if config.LANG_DE %}
+   It shall greet the user with ``Hallo Welt``.
+{% else %}
+   It shall greet the user with ``Hello World``.
+{% endif %}
+
+```

spl_core-7.11.0/src/spl_core/kickstart/templates/application/src/main/doc/index.rst → spl_core-7.11.1/src/spl_core/kickstart/templates/application/src/main/doc/index.md

@@ -1,11 +1,12 @@
-Software Detailed Design
-========================
+# Software Detailed Design
 
-.. contents:: Table of Contents
-    :depth: 2
+```{toctree}
+:maxdepth: 2
+:caption: Table of Contents
+:class: toc
+```
 
-Introduction
-------------
+## Introduction
 
 This is the documentation for the ``Main`` component.
 

{spl_core-7.11.0 → spl_core-7.11.1}/src/spl_core/kickstart/templates/project/conf.py

@@ -29,7 +29,7 @@ exclude_patterns = [
     "**/test_results.rst",  # We renamed this file, but nobody deletes it.
 ]
 
-include_patterns = ["index.rst", "doc/**"]
+include_patterns = ["index.md", "doc/**"]
 
 # configuration of built-in stuff ###########################################
 # @see https://www.sphinx-doc.org/en/master/usage/configuration.html
@@ -119,9 +119,7 @@ extensions.append("sphinxcontrib.datatemplates")
 
 # needs_types - this option allows the setup of own need types like bugs, user_stories and more.
 needs_types = [
-    dict(
-        directive="req", title="Requirement", prefix="R_", color="#BFD8D2", style="node"
-    ),
+    dict(directive="req", title="Requirement", prefix="R_", color="#BFD8D2", style="node"),
     dict(
         directive="spec",
         title="Specification",
@@ -136,9 +134,7 @@ needs_types = [
         color="#DF744A",
         style="node",
     ),
-    dict(
-        directive="test", title="Test Case", prefix="T_", color="#DCB239", style="node"
-    ),
+    dict(directive="test", title="Test Case", prefix="T_", color="#DCB239", style="node"),
 ]
 
 # Define own options
@@ -161,19 +157,33 @@ needs_global_options = {
     "results": "[[tr_link('title', 'case')]]",
 }
 
+# Parse markdown files
+extensions.append("myst_parser")
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist",
+    "html_admonition",
+    "html_image",
+]
+
+# The suffix of source filenames.
+source_suffix = [
+    ".rst",
+    ".md",
+]
+
 # Provide all config values to jinja
 html_context = {
     "build_config": {},
     "config": {},
+    "timestamp": f"{datetime.datetime.now(tz=datetime.timezone.utc).strftime('%Y-%m-%d %H:%M:%S')} UTC",
 }
 
 # pass build configuration to jinja
 if "SPHINX_BUILD_CONFIGURATION_FILE" in os.environ:
     with open(os.environ["SPHINX_BUILD_CONFIGURATION_FILE"], "r") as file:
         html_context["build_config"] = json.load(file)
-        include_patterns.extend(
-            html_context["build_config"].get("include_patterns", [])
-        )
+        include_patterns.extend(html_context["build_config"].get("include_patterns", []))
 
 # pass feature configuration to jinja
 if "AUTOCONF_JSON_FILE" in os.environ:

{spl_core-7.11.0 → spl_core-7.11.1}/src/spl_core/kickstart/templates/project/doc/Doxyfile.in

@@ -2356,7 +2356,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = "static_scope_file=static"
+PREDEFINED             = "SPLE_TESTABLE_STATIC=static"
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

spl_core-7.11.1/src/spl_core/kickstart/templates/project/doc/common/index.md

@@ -0,0 +1,3 @@
+# Common Documentation of the Project
+
+Some text...

spl_core-7.11.1/src/spl_core/kickstart/templates/project/doc/components/index.md

@@ -0,0 +1,21 @@
+# Components
+
+{% for component_info in build_config.components_info %}
+{% if component_info.has_docs %}
+
+## {{ component_info.long_name or component_info.name }}
+
+```{toctree}
+:maxdepth: 2
+
+/{{ component_info.path }}/doc/index
+{% if (build_config.target == 'reports') and component_info.has_reports %}
+/{{ component_info.reports_output_dir }}/unit_test_spec
+/{{ component_info.reports_output_dir }}/unit_test_results
+/{{ component_info.reports_output_dir }}/doxygen/html/index
+/{{ component_info.reports_output_dir }}/coverage
+{% endif %}
+```
+
+{% endif %}
+{% endfor %}

spl_core-7.11.1/src/spl_core/kickstart/templates/project/doc/software_architecture/index.md

@@ -0,0 +1,3 @@
+# Software Architecture
+
+Some text...

spl_core-7.11.1/src/spl_core/kickstart/templates/project/doc/software_requirements/index.md

@@ -0,0 +1,8 @@
+# Software Requirements
+
+```{req} Requirement 001
+   :status: open
+
+   This is a requirement.
+
+```

spl_core-7.11.1/src/spl_core/kickstart/templates/project/index.md

@@ -0,0 +1,40 @@
+{% if build_config.component_info %}
+
+# Software Component Report
+
+**Variant:** {{ build_config.variant }}<br/>
+**Component:** {{ build_config.component_info.long_name }}<br/>
+**Timestamp:** {{ timestamp }}
+
+```{toctree}
+:maxdepth: 2
+
+{{ build_config.component_info.path }}/doc/index
+{% if build_config.component_info.has_reports %}
+{{ build_config.component_info.reports_output_dir }}/unit_test_spec
+{{ build_config.component_info.reports_output_dir }}/unit_test_results
+{{ build_config.component_info.reports_output_dir }}/doxygen/html/index
+{{ build_config.component_info.reports_output_dir }}/coverage
+{% endif %}
+```
+
+{% else %}
+
+# Variant Report
+
+**Variant:** {{ build_config.variant }}<br/>
+**Timestamp:** {{ timestamp }}
+
+```{toctree}
+:maxdepth: 1
+:caption: Contents
+
+doc/software_architecture/index
+doc/software_requirements/index
+doc/components/index
+{% if build_config.target == 'reports' %}
+{{ build_config.reports_output_dir }}/coverage
+{% endif %}
+```
+
+{% endif %}

{spl_core-7.11.0 → spl_core-7.11.1}/src/spl_core/kickstart/templates/project/pypeline.yaml

@@ -3,6 +3,7 @@ pipeline:
     module: pypeline.steps.create_venv
     config:
       bootstrap_script: .bootstrap/bootstrap.py
+      python_executable: python311
   - step: ScoopInstall
     module: pypeline.steps.scoop_install
   - step: GenerateEnvSetupScript

{spl_core-7.11.0 → spl_core-7.11.1}/src/spl_core/kickstart/templates/project/pyproject.toml

@@ -2,17 +2,20 @@
 name = "spled"
 version = "0.0.1"
 description = "SPL demo project"
-authors = [
-    {name = "Avengineers"},
-]
+authors = [{ name = "Avengineers" }]
 requires-python = "<3.12,>=3.10"
 
 dependencies = [
-    "spl-core>=7,<8",
+    "spl-core (>=7,<8)",
     "pypeline-runner>=1,<2",
     "pytest>=8,<9",
     "pip_system_certs>=4.0,<5",
+    "myst-parser>=4.0,<5",
+    "pypeline-semantic-release (>=0.4.1,<0.5.0)",
 ]
 
 [tool.poetry]
 package-mode = false
+
+[tool.ruff]
+line-length = 180

{spl_core-7.11.0 → spl_core-7.11.1}/src/spl_core/spl.cmake

@@ -110,7 +110,8 @@ endfunction(_spl_hook_end_of_configure)
 set(_CONFIGURATION_TARGET configuration.stamp)
 add_custom_command(
     OUTPUT ${_CONFIGURATION_TARGET}
-    COMMAND set "KCONFIG_CONFIG=${CMAKE_SOURCE_DIR}/variants/${VARIANT}/config.txt" && cd ${CMAKE_SOURCE_DIR} && guiconfig
+    COMMAND ${CMAKE_COMMAND} -E env KCONFIG_CONFIG=${CMAKE_SOURCE_DIR}/variants/${VARIANT}/config.txt VARIANT=${VARIANT} guiconfig
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
 )
 
 add_custom_target(configuration DEPENDS ${_CONFIGURATION_TARGET})

spl_core-7.11.0/src/spl_core/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.11.0"

spl_core-7.11.0/src/spl_core/kickstart/templates/application/src/greeter/doc/index.rst

@@ -1,26 +0,0 @@
-Software Detailed Design
-========================
-
-.. figure:: _images/screenshot.png
-
-.. mermaid::
-
-   graph TD
-      A[Start] --> B{Language}
-      B -->|DE| C[Hallo Welt]
-      B -->|EN| D[Hello World]
-      C --> E[End]
-      D --> E
-
-Requirements
-------------
-
-.. spec:: Say Hello
-   :id: SWDD_GREETER-001
-   :integrity: QM
-
-{% if config.LANG_DE %}
-   It shall greet the user with ``Hallo Welt``.
-{% else %}
-   It shall greet the user with ``Hello World``.
-{% endif %}

spl_core-7.11.0/src/spl_core/kickstart/templates/project/doc/common/index.rst

@@ -1,5 +0,0 @@
-Common Documentation of the Project
-===================================
-
-
-Some text...

spl_core-7.11.0/src/spl_core/kickstart/templates/project/doc/components/index.rst

@@ -1,22 +0,0 @@
-Components
-==========
-
-{% for component_info in build_config.components_info %}
-{% if component_info.has_docs %}
-
-{{ component_info.long_name or component_info.name }}
------------------------------------------------------
-
-.. toctree::
-    :maxdepth: 2
-
-    /{{ component_info.path }}/doc/index
-{% if (build_config.target == 'reports') and component_info.has_reports %}
-    /{{ component_info.reports_output_dir }}/unit_test_results
-    /{{ component_info.reports_output_dir }}/doxygen/html/index
-    /{{ component_info.reports_output_dir }}/coverage
-{% endif %}
-
-
-{% endif %}
-{% endfor %}

spl_core-7.11.0/src/spl_core/kickstart/templates/project/doc/software_architecture/index.rst

@@ -1,2 +0,0 @@
-Software Architecture
-=====================

spl_core-7.11.0/src/spl_core/kickstart/templates/project/doc/software_requirements/index.rst

@@ -1,7 +0,0 @@
-Software Requirements
-#####################
-
-.. req:: Requirement 001
-   :status: open
-
-   ...

spl_core-7.11.0/src/spl_core/kickstart/templates/project/index.rst

@@ -1,39 +0,0 @@
-{% if build_config.component_info %}
-
-Software Component Report
-#########################
-
-| **Variant:** {{ build_config.variant }}
-| **Component:** {{ build_config.component_info.long_name }}
-
-.. toctree::
-    :maxdepth: 2
-
-    {{ build_config.component_info.path }}/doc/index
-{% if build_config.component_info.has_reports %}
-    {{ build_config.component_info.reports_output_dir }}/unit_test_spec
-    {{ build_config.component_info.reports_output_dir }}/unit_test_results
-    {{ build_config.component_info.reports_output_dir }}/doxygen/html/index
-    {{ build_config.component_info.reports_output_dir }}/coverage
-{% endif %}
-
-{% else %}
-
-Variant Report
-##############
-
-**Variant:** {{ build_config.variant }}
-
-.. toctree::
-    :maxdepth: 1
-    :caption: Contents
-
-    doc/software_requirements/index
-    doc/software_architecture/index
-    doc/components/index
-{% if build_config.target == 'reports' %}
-    {{ build_config.reports_output_dir }}/coverage
-{% endif %}
-    doc/results/index
-
-{% endif %}