Skip to main content

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

Project description

Yanga Core

CI Status Test coverage percentage

uv Ruff pypeline pre-commit

PyPI Version Supported Python versions License


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)

Installation

Requires Python 3.10+.

pip install yanga-core

Quick Start

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

from pathlib import Path
from yanga_core.domain.project_slurper import YangaProjectSlurper

slurper = YangaProjectSlurper(project_dir=Path("."))
for variant in slurper.variants:
    print(f"Variant: {variant.name}, components: {variant.components}")

Documentation

Full documentation is available in the docs/ directory:

  • Tutorials — learn yanga-core step-by-step
  • How-to Guides — task-oriented guides for specific goals
  • Reference — configuration, domain model, pipeline, and API
  • Explanation — architecture, design decisions, and concepts

Contributing

See the Contributing Guide for setup instructions, running tests, and code quality standards.

Credits

Copier

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yanga_core-0.2.0.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yanga_core-0.2.0-py3-none-any.whl (45.4 kB view details)

Uploaded Python 3

File details

Details for the file yanga_core-0.2.0.tar.gz.

File metadata

  • Download URL: yanga_core-0.2.0.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for yanga_core-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5a721a7d58af7bd9d10839d0c92e681b279236a5f63027c2aa3af158b429d569
MD5 bc863098f2231b429fedd47a073547e8
BLAKE2b-256 a50bdb6fe6bba9a9d8207e96d6a1565d1881b3dc3c6396f9ae3df944fb51b522

See more details on using hashes here.

Provenance

The following attestation bundles were made for yanga_core-0.2.0.tar.gz:

Publisher: ci.yml on yanga-project/yanga-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file yanga_core-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: yanga_core-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 45.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for yanga_core-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb6a8d90a4bce26bc0c3598ae2b563051dae04930654ca2a17be3c591831f1cc
MD5 b690ae92fd5b73b33f73cce6423d5c57
BLAKE2b-256 f5f8efe2320beb13690dd8cf3689a8d60170cb6be0b56d3cced20668808b5e65

See more details on using hashes here.

Provenance

The following attestation bundles were made for yanga_core-0.2.0-py3-none-any.whl:

Publisher: ci.yml on yanga-project/yanga-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page