yanga-core 0.0.0__tar.gz

yanga_core-0.0.0/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2026 cuinixam
+
+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.

yanga_core-0.0.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: yanga-core
+Version: 0.0.0
+Summary: Core library for C/C++ software product line engineering.
+License-Expression: MIT
+License-File: LICENSE
+Author: cuinixam
+Author-email: cuinixam@gmail.com
+Requires-Python: >=3.10
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+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 :: Software Development :: Libraries
+Requires-Dist: clanguru (>=0,<1)
+Requires-Dist: kspl (>=1,<2)
+Requires-Dist: mashumaro (>=3.13,<4)
+Requires-Dist: pick (>=2.2,<3)
+Requires-Dist: py-app-dev (>=2.1,<3)
+Requires-Dist: typer (>=0,<1)
+Project-URL: Bug Tracker, https://github.com/yanga-project/yanga-core/issues
+Project-URL: Changelog, https://github.com/yanga-project/yanga-core/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/yanga-project/yanga-core
+Description-Content-Type: text/markdown
+
+# Yanga Core
+
+<p align="center">
+  <a href="https://github.com/yanga-project/yanga-core/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/yanga-project/yanga-core/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://codecov.io/gh/yanga-project/yanga-core">
+    <img src="https://img.shields.io/codecov/c/github/yanga-project/yanga-core.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://github.com/astral-sh/uv">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/cuinixam/pypeline">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/cuinixam/pypeline/refs/heads/main/assets/badge/v0.json" alt="pypeline">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/yanga-core/">
+    <img src="https://img.shields.io/pypi/v/yanga-core.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/yanga-core.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/yanga-core.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Source Code**: <a href="https://github.com/yanga-project/yanga-core" target="_blank">https://github.com/yanga-project/yanga-core </a>
+
+---
+
+Core library for C/C++ software product line (SPL) engineering. Works with any build system.
+
+Yanga Core provides data models, configuration loading, pipeline steps, and commands that build system integrations (like [Yanga](https://github.com/yanga-project/yanga) for CMake) use to:
+
+- Define platforms, variants, and components for a product line
+- Run build pipeline steps (KConfig generation, dependency installation, static analysis, ...)
+- Generate HTML reports (CppCheck, Sphinx docs, coverage)
+
+## Key Concepts
+
+- **Platform** — build target with generators and build types (Debug, Release, ...)
+- **Variant** — product configuration that picks which components to build for a platform
+- **Component** — source code unit with sources, tests, docs, and include directories
+- **ExecutionContext** — holds the active variant, platform, components, and shared data registry
+- **Pipeline Step** — one step in the build pipeline (e.g. KConfig generation, dependency installation)
+
+## Installation
+
+Requires Python 3.10+.
+
+```bash
+pip install yanga-core
+```
+
+## Usage
+
+`yanga-core` is a library, not a standalone CLI. Applications import its modules and compose them. See [Yanga](https://github.com/yanga-project/yanga) for a CMake-based application using `yanga-core`.
+
+```python
+from yanga_core.domain.config import PlatformConfig, VariantConfig
+from yanga_core.domain.components import Component
+from yanga_core.domain.execution_context import ExecutionContext, UserRequest, UserRequestScope
+from yanga_core.domain.project_slurper import ProjectSlurper
+```
+
+### Core Modules
+
+| Module                | Description                                                                |
+| --------------------- | -------------------------------------------------------------------------- |
+| `yanga_core.domain`   | Config models, components, execution context, artifacts                    |
+| `yanga_core.commands` | Commands for running steps, reports, compile commands, CppCheck, HTML fixes |
+| `yanga_core.steps`    | Pipeline steps for `pypeline` (KConfig, dependency install, reports)       |
+| `yanga_core.docs`     | Sphinx doc generation helpers                                              |
+
+## Contributing
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/yanga-project/yanga-core.git
+cd yanga-core
+
+# Install dependencies (using uv)
+uv sync
+```
+
+### Running Tests
+
+The project uses [pypeline-runner](https://github.com/yanga-project/pypeline) for automation:
+
+```bash
+# Run full pipeline (lint + tests)
+pypeline run
+
+# Run only linting
+pypeline run --step PreCommit
+
+# Run only tests with a specific Python version
+pypeline run --step CreateVEnv --step PyTest --single --input python_version=3.13
+```
+
+### Code Quality
+
+- [Ruff](https://github.com/astral-sh/ruff) for linting and formatting
+- [pre-commit](https://pre-commit.com/) hooks enforce code standards
+- Commits must follow [conventional commits](https://www.conventionalcommits.org)
+
+## Credits
+
+[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
+project template.
+

yanga_core-0.0.0/README.md

@@ -0,0 +1,124 @@
+# Yanga Core
+
+<p align="center">
+  <a href="https://github.com/yanga-project/yanga-core/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/yanga-project/yanga-core/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://codecov.io/gh/yanga-project/yanga-core">
+    <img src="https://img.shields.io/codecov/c/github/yanga-project/yanga-core.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://github.com/astral-sh/uv">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+  <a href="https://github.com/cuinixam/pypeline">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/cuinixam/pypeline/refs/heads/main/assets/badge/v0.json" alt="pypeline">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/yanga-core/">
+    <img src="https://img.shields.io/pypi/v/yanga-core.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/yanga-core.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/yanga-core.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Source Code**: <a href="https://github.com/yanga-project/yanga-core" target="_blank">https://github.com/yanga-project/yanga-core </a>
+
+---
+
+Core library for C/C++ software product line (SPL) engineering. Works with any build system.
+
+Yanga Core provides data models, configuration loading, pipeline steps, and commands that build system integrations (like [Yanga](https://github.com/yanga-project/yanga) for CMake) use to:
+
+- Define platforms, variants, and components for a product line
+- Run build pipeline steps (KConfig generation, dependency installation, static analysis, ...)
+- Generate HTML reports (CppCheck, Sphinx docs, coverage)
+
+## Key Concepts
+
+- **Platform** — build target with generators and build types (Debug, Release, ...)
+- **Variant** — product configuration that picks which components to build for a platform
+- **Component** — source code unit with sources, tests, docs, and include directories
+- **ExecutionContext** — holds the active variant, platform, components, and shared data registry
+- **Pipeline Step** — one step in the build pipeline (e.g. KConfig generation, dependency installation)
+
+## Installation
+
+Requires Python 3.10+.
+
+```bash
+pip install yanga-core
+```
+
+## Usage
+
+`yanga-core` is a library, not a standalone CLI. Applications import its modules and compose them. See [Yanga](https://github.com/yanga-project/yanga) for a CMake-based application using `yanga-core`.
+
+```python
+from yanga_core.domain.config import PlatformConfig, VariantConfig
+from yanga_core.domain.components import Component
+from yanga_core.domain.execution_context import ExecutionContext, UserRequest, UserRequestScope
+from yanga_core.domain.project_slurper import ProjectSlurper
+```
+
+### Core Modules
+
+| Module                | Description                                                                |
+| --------------------- | -------------------------------------------------------------------------- |
+| `yanga_core.domain`   | Config models, components, execution context, artifacts                    |
+| `yanga_core.commands` | Commands for running steps, reports, compile commands, CppCheck, HTML fixes |
+| `yanga_core.steps`    | Pipeline steps for `pypeline` (KConfig, dependency install, reports)       |
+| `yanga_core.docs`     | Sphinx doc generation helpers                                              |
+
+## Contributing
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/yanga-project/yanga-core.git
+cd yanga-core
+
+# Install dependencies (using uv)
+uv sync
+```
+
+### Running Tests
+
+The project uses [pypeline-runner](https://github.com/yanga-project/pypeline) for automation:
+
+```bash
+# Run full pipeline (lint + tests)
+pypeline run
+
+# Run only linting
+pypeline run --step PreCommit
+
+# Run only tests with a specific Python version
+pypeline run --step CreateVEnv --step PyTest --single --input python_version=3.13
+```
+
+### Code Quality
+
+- [Ruff](https://github.com/astral-sh/ruff) for linting and formatting
+- [pre-commit](https://pre-commit.com/) hooks enforce code standards
+- Commits must follow [conventional commits](https://www.conventionalcommits.org)
+
+## Credits
+
+[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
+project template.

yanga_core-0.0.0/pyproject.toml

@@ -0,0 +1,181 @@
+[project]
+name = "yanga-core"
+version = "0.0.0"
+description = "Core library for C/C++ software product line engineering."
+readme = "README.md"
+license = "MIT"
+authors = [
+  { name = "cuinixam", email = "cuinixam@gmail.com" },
+]
+requires-python = ">=3.10"
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Software Development :: Libraries",
+]
+
+dependencies = [
+  "py-app-dev>=2.1,<3",
+  "typer>=0,<1",
+  "mashumaro>=3.13,<4",
+  "clanguru>=0,<1",
+  "kspl>=1,<2",
+  "pick>=2.2,<3",
+]
+urls."Bug Tracker" = "https://github.com/yanga-project/yanga-core/issues"
+urls.Changelog = "https://github.com/yanga-project/yanga-core/blob/main/CHANGELOG.md"
+urls.repository = "https://github.com/yanga-project/yanga-core"
+
+[build-system]
+requires = ["poetry-core>=2,<3"]
+build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = [
+  "pytest==9.*",
+  "coverage",
+  "pytest-cov==7.*",
+  "pypeline-runner>=1,<2",
+  "pre-commit>=4,<5",
+  "ruff>=0,<1",
+  # docs
+  "myst-parser>=4,<5",
+  "furo",
+  "sphinx-copybutton>=0,<1",
+  "sphinx-design>=0,<1",
+  "sphinx-new-tab-link>=0,<1",
+  "sphinx-rtd-size>=0.2,<1",
+  "sphinxcontrib-mermaid>=1,<2",
+]
+
+[tool.ruff]
+line-length = 180
+lint.select = [
+  "B",   # flake8-bugbear
+  "D",   # flake8-docstrings
+  "C4",  # flake8-comprehensions
+  "S",   # flake8-bandit
+  "F",   # pyflake
+  "E",   # pycodestyle
+  "W",   # pycodestyle
+  "UP",  # pyupgrade
+  "I",   # isort
+  "RUF", # ruff specific
+]
+lint.ignore = [
+  "D100", # Missing docstring in public module
+  "D101", # Missing docstring in public class
+  "D102", # Missing docstring in public method
+  "D103", # Missing docstring in public function
+  "D104", # Missing docstring in public package
+  "D105", # Missing docstring in magic method
+  "D203", # 1 blank line required before class docstring
+  "D212", # Multi-line docstring summary should start at the first line
+  "D100", # Missing docstring in public module
+  "D104", # Missing docstring in public package
+  "D106", # Missing docstring in public nested class
+  "D107", # Missing docstring in `__init__`
+  "D401", # First line of docstring should be in imperative mood
+]
+lint.per-file-ignores."conftest.py" = [ "D100" ]
+lint.per-file-ignores."setup.py" = [ "D100" ]
+lint.per-file-ignores."tests/**/*" = [
+  "D100",
+  "D101",
+  "D102",
+  "D103",
+  "D104",
+  "S101",
+]
+lint.isort.known-first-party = [ "yanga_core", "tests" ]
+
+[tool.pyproject-fmt]
+max_supported_python = "3.14"
+
+[tool.pytest]
+minversion = "9.0"
+addopts = [
+  "-v",
+  "-Wonce",
+  "-p no:doctest",
+  "--cov=yanga_core",
+  "--cov-report=term",
+  "--cov-report=xml"
+]
+pythonpath = [ "src" ]
+
+[tool.coverage]
+run.branch = true
+paths.source = [
+  "src",
+  ".tox/**/site-packages",
+]
+report.exclude_lines = [
+  "pragma: no cover",
+  "@overload",
+  "if TYPE_CHECKING",
+  "raise NotImplementedError",
+  'if __name__ == "__main__":',
+]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+mypy_path = "src/"
+no_implicit_optional = true
+show_error_codes = true
+warn_unreachable = true
+warn_unused_ignores = true
+exclude = [
+  'docs/.*',
+  'setup.py',
+]
+disable_error_code = [ "import-untyped" ]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+allow_untyped_defs = true
+
+[tool.semantic_release]
+allow_zero_version = true
+version_toml = [ "pyproject.toml:project.version" ]
+version_variables = [
+  "src/yanga_core/__init__.py:__version__",
+]
+build_command = """
+pip install uv
+uv lock
+git add uv.lock
+uv build
+"""
+
+[tool.semantic_release.changelog]
+exclude_commit_patterns = [
+  '''chore(?:\([^)]*?\))?: .+''',
+  '''ci(?:\([^)]*?\))?: .+''',
+  '''refactor(?:\([^)]*?\))?: .+''',
+  '''style(?:\([^)]*?\))?: .+''',
+  '''test(?:\([^)]*?\))?: .+''',
+  '''build\((?!deps\): .+)''',
+  '''Merged? .*''',
+  '''Initial [Cc]ommit.*''', # codespell:ignore
+]
+
+[tool.semantic_release.changelog.environment]
+keep_trailing_newline = true
+
+[tool.semantic_release.branches.main]
+match = "main"
+
+[tool.semantic_release.branches.noop]
+match = "(?!main$)"
+prerelease = true

yanga_core-0.0.0/src/yanga_core/__init__.py

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

yanga_core-0.0.0/src/yanga_core/commands/base.py

@@ -0,0 +1,48 @@
+from argparse import Namespace
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import TypeVar
+
+from mashumaro import DataClassDictMixin
+from pick import pick
+from py_app_dev.core.logging import logger
+
+T = TypeVar("T", bound=DataClassDictMixin)
+
+
+def create_config(config_class: type[T], namespace: Namespace) -> T:
+    """
+    Creates a configuration instance from an argparse Namespace for the given class.
+
+    - config_class: The class type to instantiate, inheriting from DataClassDictMixin.
+    - namespace: The argparse Namespace containing configuration data.
+
+    It returns an instance of config_class populated with data from namespace.
+
+    """
+    return config_class.from_dict(vars(namespace))
+
+
+@dataclass
+class CommandConfigBase(DataClassDictMixin):
+    project_dir: Path = field(
+        default=Path(".").absolute(),
+        metadata={"help": "Project root directory. Defaults to the current directory if not specified."},
+    )
+
+
+def prompt_user_to_select_option(options: list[str], prompt: str) -> str | None:
+    if not options:
+        return None
+    # If there is only one option, return it immediately
+    if len(options) == 1:
+        return options[0]
+    try:
+        # TODO: this message is only necessary in case the user will press Ctrl+C to quit.
+        # In this case, after pick method returns, the execution is paused until the user presses any key.
+        # I have no idea why that happens.
+        logger.info("Press any key to continue...")
+        selected_variant, _ = pick(options, prompt, indicator="=>")
+    except KeyboardInterrupt:
+        selected_variant = None
+    return str(selected_variant) if selected_variant else None