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.3.0.tar.gz (34.7 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.3.0-py3-none-any.whl (46.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yanga_core-0.3.0.tar.gz
  • Upload date:
  • Size: 34.7 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.3.0.tar.gz
Algorithm Hash digest
SHA256 28092d885034ea4d1ade4f57ed57bc9008abd6ba640686cf0d64ecac876a98b9
MD5 677c2c6b9dabf7533f5ae26d1f01ccd2
BLAKE2b-256 45a0a3c5661636b2e483f5ac3ca48023620ae83bed5dc77287bc3cc03d54a9b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for yanga_core-0.3.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.3.0-py3-none-any.whl.

File metadata

  • Download URL: yanga_core-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 46.7 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c610652b5f189299e62e4daaec1fe178208ac630fc93b35424ba3042c7ae81df
MD5 c92dd668aa2af82980c5fad13a72d603
BLAKE2b-256 645329c3b6541ad25e5dcf176db31a7786a33efe72ac8ebf30ba45b7b0ab2a1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for yanga_core-0.3.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