yanga-core 0.0.0

Core library for C/C++ software product line engineering.

Yanga Core

---

Source Code: https://github.com/yanga-project/yanga-core

---

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 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+.

pip install yanga-core

Usage

yanga-core is a library, not a standalone CLI. Applications import its modules and compose them. See Yanga for a CMake-based application using yanga-core.

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

# 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 for automation:

# 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 for linting and formatting
• pre-commit hooks enforce code standards
• Commits must follow conventional commits

Credits

This package was created with Copier and the browniebroke/pypackage-template project template.