kspl 1.1.0__tar.gz → 1.2.0__tar.gz

kspl-1.2.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.3
+Name: kspl
+Version: 1.2.0
+Summary: KConfig GUI for Software Product Lines with multiple variants.
+License: MIT
+Author: Cuinixam
+Author-email: cuinixam@me.com
+Requires-Python: <4.0,>=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 :: Only
+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: Topic :: Software Development :: Libraries
+Requires-Dist: customtkinter (>=5,<6)
+Requires-Dist: kconfiglib (>=14,<15)
+Requires-Dist: py-app-dev (>=2,<3)
+Project-URL: Bug Tracker, https://github.com/cuinixam/kspl/issues
+Project-URL: Changelog, https://github.com/cuinixam/kspl/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/cuinixam/kspl
+Description-Content-Type: text/markdown
+
+# SPL KConfig GUI
+
+<p align="center">
+  <a href="https://github.com/cuinixam/kspl/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/cuinixam/kspl/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://codecov.io/gh/cuinixam/kspl">
+    <img src="https://img.shields.io/codecov/c/github/cuinixam/kspl.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/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/kspl/">
+    <img src="https://img.shields.io/pypi/v/kspl.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/kspl.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/kspl.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Source Code**: <a href="https://github.com/cuinixam/kspl" target="_blank">https://github.com/cuinixam/kspl </a>
+
+---
+
+KConfig GUI for Software Product Lines with multiple variants.
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install kspl`
+
+## Usage
+
+Start by importing it:
+
+```python
+import kspl
+```
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## 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.
+

kspl-1.2.0/README.md

@@ -0,0 +1,72 @@
+# SPL KConfig GUI
+
+<p align="center">
+  <a href="https://github.com/cuinixam/kspl/actions/workflows/ci.yml?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/cuinixam/kspl/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://codecov.io/gh/cuinixam/kspl">
+    <img src="https://img.shields.io/codecov/c/github/cuinixam/kspl.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/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/kspl/">
+    <img src="https://img.shields.io/pypi/v/kspl.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/kspl.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/kspl.svg?style=flat-square" alt="License">
+</p>
+
+---
+
+**Source Code**: <a href="https://github.com/cuinixam/kspl" target="_blank">https://github.com/cuinixam/kspl </a>
+
+---
+
+KConfig GUI for Software Product Lines with multiple variants.
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install kspl`
+
+## Usage
+
+Start by importing it:
+
+```python
+import kspl
+```
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## 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.

kspl-1.2.0/pyproject.toml

@@ -0,0 +1,167 @@
+[build-system]
+build-backend = "poetry.core.masonry.api"
+
+requires = [ "poetry-core>=2,<3" ]
+
+[project]
+name = "kspl"
+version = "1.2.0"
+description = "KConfig GUI for Software Product Lines with multiple variants."
+readme = "README.md"
+license = { text = "MIT" }
+authors = [
+  { name = "Cuinixam", email = "cuinixam@me.com" },
+]
+requires-python = "<4.0,>=3.10"
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Libraries",
+]
+
+dependencies = [
+  "customtkinter>=5,<6",
+  "kconfiglib>=14,<15",
+  "py-app-dev>=2,<3",
+]
+urls."Bug Tracker" = "https://github.com/cuinixam/kspl/issues"
+urls.Changelog = "https://github.com/cuinixam/kspl/blob/main/CHANGELOG.md"
+urls.repository = "https://github.com/cuinixam/kspl"
+scripts.kspl = "kspl.main:main"
+
+[dependency-groups]
+dev = [
+  "pypeline-runner>=1,<2",
+  "pytest>=8,<9",
+  "pytest-cov>=6,<7",
+  "pre-commit>=4,<5",
+  "wrapt",
+]
+
+[tool.ruff]
+target-version = "py39"
+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
+  "D106", # Missing docstring in public nested class
+  "D107", # Missing docstring in `__init__`
+  "D203", # 1 blank line required before class docstring
+  "D212", # Multi-line docstring summary should start at the first line
+  "D401", # First line of docstring should be in imperative mood
+]
+lint.per-file-ignores."bootstrap.py" = [ "D200", "D205", "D417", "S603", "UP006", "UP035" ]
+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 = [ "kspl", "tests" ]
+
+[tool.pytest.ini_options]
+addopts = """\
+    -v
+    -Wdefault
+    --cov=kspl
+    --cov-report=term
+    --cov-report=xml
+    """
+pythonpath = [ "src" ]
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.paths]
+source = [
+  "src",
+  ".tox/**/site-packages",
+]
+
+[tool.coverage.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 = [
+  'setup.py',
+]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+allow_untyped_defs = true
+
+[tool.semantic_release]
+version_toml = [ "pyproject.toml:project.version" ]
+version_variables = [
+  "src/kspl/__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

kspl-1.2.0/src/kspl/__init__.py

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

{kspl-1.1.0 → kspl-1.2.0}/src/kspl/_run.py

@@ -1,9 +1,13 @@
-"""Used to run main from the command line when run from this repository.
-This is required because kspl module is not visible when running
-from the repository."""
-import runpy
-import sys
-from pathlib import Path
-
-sys.path.insert(0, Path(__file__).parent.parent.absolute().as_posix())
-runpy.run_module("kspl.main", run_name="__main__")
+"""
+Used to run main from the command line when run from this repository.
+
+This is required because kspl module is not visible when running
+from the repository.
+"""
+
+import runpy
+import sys
+from pathlib import Path
+
+sys.path.insert(0, Path(__file__).parent.parent.absolute().as_posix())
+runpy.run_module("kspl.main", run_name="__main__")

{kspl-1.1.0 → kspl-1.2.0}/src/kspl/config_slurper.py

@@ -1,85 +1,71 @@
-from dataclasses import dataclass
-from pathlib import Path
-from typing import Any, Dict, List, Optional
-
-from py_app_dev.core.exceptions import UserNotificationException
-from py_app_dev.core.logging import logger
-
-from kspl.kconfig import EditableConfigElement, KConfig
-
-
-@dataclass
-class VariantViewData:
-    """A variant is a set of configuration values for a KConfig model."""
-
-    name: str
-    config_dict: Dict[str, Any]
-
-
-@dataclass
-class VariantData:
-    name: str
-    config: KConfig
-
-    def find_element(self, element_name: str) -> Optional[EditableConfigElement]:
-        return self.config.find_element(element_name)
-
-
-class SPLKConfigData:
-    def __init__(self, project_root_dir: Path) -> None:
-        self.project_root_dir = project_root_dir.absolute()
-        variant_config_files = self._search_variant_config_file(self.project_root_dir)
-        if not self.kconfig_model_file.is_file():
-            raise UserNotificationException(
-                f"File {self.kconfig_model_file} does not exist."
-            )
-        self.model = KConfig(self.kconfig_model_file)
-        if variant_config_files:
-            self.variant_configs: List[VariantData] = [
-                VariantData(
-                    self._get_variant_name(file), KConfig(self.kconfig_model_file, file)
-                )
-                for file in variant_config_files
-            ]
-        else:
-            self.variant_configs = [VariantData("Default", self.model)]
-        self.logger = logger.bind()
-
-    @property
-    def kconfig_model_file(self) -> Path:
-        return self.project_root_dir / "KConfig"
-
-    def get_elements(self) -> List[EditableConfigElement]:
-        return self.model.elements
-
-    def get_variants(self) -> List[VariantViewData]:
-        variants = []
-
-        for variant in self.variant_configs:
-            variants.append(
-                VariantViewData(
-                    variant.name,
-                    {
-                        config_elem.name: config_elem.value
-                        for config_elem in variant.config.elements
-                        if not config_elem.is_menu
-                    },
-                )
-            )
-        return variants
-
-    def _get_variant_name(self, file: Path) -> str:
-        return file.relative_to(self.project_root_dir / "variants").parent.as_posix()
-
-    def _search_variant_config_file(self, project_dir: Path) -> List[Path]:
-        """
-        Finds all files called 'config.txt' in the variants directory
-        and returns a list with their paths.
-        """
-        return list((project_dir / "variants").glob("**/config.txt"))
-
-    def find_variant_config(self, variant_name: str) -> Optional[VariantData]:
-        for variant in self.variant_configs:
-            if variant.name == variant_name:
-                return variant
-        return None
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger
+
+from kspl.kconfig import EditableConfigElement, KConfig
+
+
+@dataclass
+class VariantViewData:
+    """A variant is a set of configuration values for a KConfig model."""
+
+    name: str
+    config_dict: dict[str, Any]
+
+
+@dataclass
+class VariantData:
+    name: str
+    config: KConfig
+
+    def find_element(self, element_name: str) -> EditableConfigElement | None:
+        return self.config.find_element(element_name)
+
+
+class SPLKConfigData:
+    def __init__(self, project_root_dir: Path) -> None:
+        self.project_root_dir = project_root_dir.absolute()
+        variant_config_files = self._search_variant_config_file(self.project_root_dir)
+        if not self.kconfig_model_file.is_file():
+            raise UserNotificationException(f"File {self.kconfig_model_file} does not exist.")
+        self.model = KConfig(self.kconfig_model_file)
+        if variant_config_files:
+            self.variant_configs: list[VariantData] = [VariantData(self._get_variant_name(file), KConfig(self.kconfig_model_file, file)) for file in variant_config_files]
+        else:
+            self.variant_configs = [VariantData("Default", self.model)]
+        self.logger = logger.bind()
+
+    @property
+    def kconfig_model_file(self) -> Path:
+        return self.project_root_dir / "KConfig"
+
+    def get_elements(self) -> list[EditableConfigElement]:
+        return self.model.elements
+
+    def get_variants(self) -> list[VariantViewData]:
+        variants = []
+
+        for variant in self.variant_configs:
+            variants.append(
+                VariantViewData(
+                    variant.name,
+                    {config_elem.name: config_elem.value for config_elem in variant.config.elements if not config_elem.is_menu},
+                )
+            )
+        return variants
+
+    def _get_variant_name(self, file: Path) -> str:
+        return file.relative_to(self.project_root_dir / "variants").parent.as_posix()
+
+    def _search_variant_config_file(self, project_dir: Path) -> list[Path]:
+        """Finds all files called 'config.txt' in the variants directory and returns a list with their paths."""
+        return list((project_dir / "variants").glob("**/config.txt"))
+
+    def find_variant_config(self, variant_name: str) -> VariantData | None:
+        for variant in self.variant_configs:
+            if variant.name == variant_name:
+                return variant
+        return None