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.5.0.tar.gz (35.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.5.0-py3-none-any.whl (47.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yanga_core-0.5.0.tar.gz
  • Upload date:
  • Size: 35.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.5.0.tar.gz
Algorithm Hash digest
SHA256 c3cf732acb669d9df7fce74325e0d22fab99a9c9fffb67dfbd9a951c74e495e9
MD5 78fa0d28138d4636ad2c05cc02580649
BLAKE2b-256 f3a9e3ce22f58758b527a52b5ab2f5a6dbfeea5eb4ccd0058a988135fa35326e

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: yanga_core-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 47.0 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3310d06863a6fa52532a2a703bd26b261d8e3a46eb2ef72aaf4b9858a074f0a1
MD5 4fece6f905ad612048530fabd6e2b774
BLAKE2b-256 15b7aa7ba4503397c0e831845abb1935be841d5fc38a789f689fa1182aef6876

See more details on using hashes here.

Provenance

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