proj-flow 0.9.3__tar.gz → 0.9.4__tar.gz

{proj_flow-0.9.3 → proj_flow-0.9.4}/.flow/config.yaml

@@ -1,7 +1,7 @@
 extensions:
   - proj_flow.ext.python
   - proj_flow.ext.github
-  - proj_flow.ext.re_structured_changelist
+  - proj_flow.ext.re_structured_changelog
 
 entry:
   build: [ Build ]

{proj_flow-0.9.3 → proj_flow-0.9.4}/CHANGELOG.rst

@@ -4,6 +4,17 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+`0.9.4 <https://github.com/mzdun/proj-flow/compare/v0.9.3...v0.9.4>`_ (2025-02-09)
+==================================================================================
+
+Bug Fixes
+---------
+
+- remove vestiges of old plugin finder + styles (`484fec4 <https://github.com/mzdun/proj-flow/commit/484fec44107474fe765091b7754b94094395c838>`_)
+- move C++ things to ext.cplusplus (`fce7318 <https://github.com/mzdun/proj-flow/commit/fce7318b614a645dd9b72854a4ab78c0c5cf7b00>`_)
+- move last command to minimal (`c3f1dba <https://github.com/mzdun/proj-flow/commit/c3f1dba7c4f55fc8f62eb4d44162833991cd516f>`_)
+- **docs**: cleanup the docstrings after moving (`a952ebe <https://github.com/mzdun/proj-flow/commit/a952ebe19c65cb51585dc2c69ead74bfe7fff5cc>`_)
+
 `0.9.3 <https://github.com/mzdun/proj-flow/compare/v0.9.2...v0.9.3>`_ (2025-02-08)
 ==================================================================================
 

{proj_flow-0.9.3 → proj_flow-0.9.4}/PKG-INFO

@@ -1,7 +1,8 @@
 Metadata-Version: 2.4
 Name: proj-flow
-Version: 0.9.3
+Version: 0.9.4
 Summary: C++ project maintenance, automated
+Project-URL: Changelog, https://github.com/mzdun/proj-flow/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://proj-flow.readthedocs.io/en/latest/
 Project-URL: Homepage, https://pypi.org/project/proj-flow/
 Project-URL: Source Code, https://github.com/mzdun/proj-flow

{proj_flow-0.9.3 → proj_flow-0.9.4}/pyproject.toml

@@ -37,6 +37,7 @@ readme = "README.md"
 requires-python = ">=3.10"
 
 [project.urls]
+Changelog = "https://github.com/mzdun/proj-flow/blob/main/CHANGELOG.rst"
 Documentation = "https://proj-flow.readthedocs.io/en/latest/"
 Homepage = "https://pypi.org/project/proj-flow/"
 "Source Code" = "https://github.com/mzdun/proj-flow"

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/__init__.py

@@ -1,4 +1,4 @@
 # Copyright (c) 2025 Marcin Zdun
 # This code is licensed under MIT license (see LICENSE for details)
 
-__version__ = "0.9.3"
+__version__ = "0.9.4"

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/api/env.py

@@ -24,7 +24,6 @@ from enum import Enum
 from typing import Any, Callable, Dict, List, Optional, Union, cast
 
 from proj_flow.base import plugins, uname
-from proj_flow.base.plugins import load_module_plugins
 
 platform = uname.uname()[0]
 
@@ -152,7 +151,13 @@ class FlowConfig:
             sys.path.insert(0, local_extensions)
 
         for extension in extensions:
-            importlib.import_module(extension)
+            try:
+                importlib.import_module(extension)
+            except ModuleNotFoundError:
+                print(
+                    f"-- error: module `{extension}` was no found, ignoring",
+                    file=sys.stderr,
+                )
 
     @property
     def entry(self) -> Dict[str, dict]:

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/api/makefile.py

@@ -2,7 +2,7 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.api.makefiles** exposes simple makefiles APIs, so extensions can
+The **proj_flow.api.makefile** exposes simple makefile APIs, so extensions can
 easily provide run steps with multiple scripts being called.
 """
 

proj_flow-0.9.4/src/proj_flow/base/plugins.py

@@ -0,0 +1,48 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.base.plugins** provide the plugin enumeration helpers.
+"""
+
+import json
+import os
+from typing import cast
+
+import yaml
+
+
+def load_yaml(filename: str):
+    with open(filename) as src:
+        return cast(dict, yaml.load(src, Loader=yaml.Loader))
+
+
+def load_json(filename: str):
+    with open(filename) as src:
+        return cast(dict, json.load(src))
+
+
+LOADERS = {
+    ".json": load_json,
+    ".yml": load_yaml,
+    ".yaml": load_yaml,
+}
+
+
+def load_data(filename: str):
+    prefix, ext = os.path.splitext(filename)
+    loader = LOADERS.get(ext.lower())
+    if loader:
+        try:
+            return loader(filename)
+        except Exception:
+            pass
+
+    for new_ext, loader in LOADERS.items():
+        new_filename = prefix + new_ext
+        try:
+            return loader(new_filename)
+        except Exception:
+            pass
+
+    return {}

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/base/registry.py

@@ -2,7 +2,8 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.base.registry**
+The **proj_flow.base.registry** allows building extension points, with ability
+to register the plugins with a decorator.
 """
 
 import typing

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/cli/__init__.py

@@ -10,10 +10,8 @@ The **proj_flow.cli** provides command-line entry for the *Project Flow*.
 import argparse
 import os
 import sys
-from pprint import pprint
-from typing import Dict, Optional, Tuple
 
-from proj_flow.api import arg, env
+from proj_flow.api import env
 from proj_flow.cli import argument, finder
 from proj_flow.flow import steps
 

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/cli/argument.py

@@ -2,7 +2,7 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.cli.arguments** provides command-line builders and runners,
+The **proj_flow.cli.argument** provides command-line builders and runners,
 supporting the functions decorated with :func:`@arg.command()
 <proj_flow.api.arg.command>`.
 """

proj_flow-0.9.4/src/proj_flow/ext/cplusplus/__init__.py

@@ -0,0 +1,10 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.ext.cplusplus** defines steps and commands for C++ projects.
+"""
+
+from . import cmake, conan
+
+__all__ = ["cmake", "conan"]

proj_flow-0.9.4/src/proj_flow/ext/cplusplus/cmake/__init__.py

@@ -0,0 +1,12 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.ext.cplusplus.cmake** provides ``"CMake"``, ``"Build"``,
+``"Pack"`` and ``"Test"`` steps, as well as CMake-specific initialization
+context.
+"""
+
+from . import context, parser, steps, version
+
+__all__ = ["context", "parser", "steps", "version"]

{proj_flow-0.9.3/src/proj_flow/plugins → proj_flow-0.9.4/src/proj_flow/ext/cplusplus}/cmake/context.py

@@ -2,8 +2,8 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.plugins.cmake.context** provides CMake-specific initialization
-context.
+The **proj_flow.ext.cplusplus.cmake.context** provides CMake-specific
+initialization context.
 """
 
 import re

{proj_flow-0.9.3/src/proj_flow/plugins → proj_flow-0.9.4/src/proj_flow/ext/cplusplus}/cmake/parser.py

@@ -2,13 +2,15 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.plugins.cmake.parser** contains simple CMake parser.
+The **proj_flow.ext.cplusplus.cmake.parser** contains simple CMake parser.
 """
 
 import os
 import re
 from typing import Iterator, List, NamedTuple, Optional
 
+from proj_flow.api.release import NO_ARG, Arg
+
 TOKENS = [
     ("COMMENT", r"#.*"),
     ("STR", r'"[^"]*"'),
@@ -25,39 +27,18 @@ class Token(NamedTuple):
     offset: int
 
 
-class Arg(NamedTuple):
-    value: str
-    offset: int
-
-
 class Command(NamedTuple):
     name: str
     args: List[Arg]
     offset: int
 
 
-class Project(NamedTuple):
+class CMakeProject(NamedTuple):
     name: Arg
     version: Arg
     stability: Arg
     description: Arg
 
-    def set_version(self, directory: str, next_version: str):
-        _patch(directory, self.version, next_version)
-        return ["proj_flow/__init__.py"]
-
-    @property
-    def ver(self):
-        return f"{self.version.value}{self.stability.value}"
-
-    @property
-    def pkg(self):
-        return f"{self.name.value}-{self.ver}"
-
-    @property
-    def tag(self):
-        return f"v{self.ver}"
-
 
 def _token_stream(text: str) -> Iterator[Token]:
     tok_regex = "|".join("(?P<%s>%s)" % pair for pair in TOKENS)
@@ -121,10 +102,7 @@ def _patch(directory: str, arg: Arg, value: str):
         input.write(patched)
 
 
-NO_ARG = Arg("", -1)
-
-
-def get_project(dirname: str) -> Optional[Project]:
+def get_project(dirname: str) -> Optional[CMakeProject]:
     try:
         commands = _cmake(os.path.join(dirname, "CMakeLists.txt"))
     except FileNotFoundError:
@@ -158,7 +136,7 @@ def get_project(dirname: str) -> Optional[Project]:
     if version_stability is None:
         version_stability = NO_ARG
 
-    return Project(
+    return CMakeProject(
         name=project_name,
         version=version,
         stability=version_stability,

proj_flow-0.9.4/src/proj_flow/ext/cplusplus/cmake/steps.py

@@ -0,0 +1,142 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.ext.cplusplus.cmake.steps** defines steps for configuring,
+building and archiving.
+"""
+
+import os
+from typing import Dict, List, cast
+
+from proj_flow import api
+from proj_flow.api import env, step
+
+from .__version__ import CMAKE_VERSION
+
+
+class CMakeBase(api.step.Step):
+    _name: str
+    _runs_after: List[str] = []
+    _runs_before: List[str] = []
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def runs_after(self):
+        return self._runs_after
+
+    @property
+    def runs_before(self):
+        return self._runs_before
+
+    def __init__(
+        self, name: str, runs_after: List[str] = [], runs_before: List[str] = []
+    ):
+        super().__init__()
+        self._name = name
+        self._runs_after = runs_after
+        self._runs_before = runs_before
+
+    def is_active(self, config: api.env.Config, rt: api.env.Runtime) -> int:
+        return os.path.isfile("CMakeLists.txt") and os.path.isfile("CMakePresets.json")
+
+    def platform_dependencies(self):
+        return [f"cmake>={CMAKE_VERSION}"]
+
+    def dep_with_tool(self, tool: str):
+        return [f"cmake>={CMAKE_VERSION}", f"{tool}>={CMAKE_VERSION}"]
+
+
+@step.register
+class CMakeConfig(CMakeBase):
+    """Configures the project using ``preset`` config."""
+
+    def __init__(self):
+        super().__init__(name="CMake")
+
+    def is_active(self, config: env.Config, rt: env.Runtime) -> int:
+        return os.path.isfile("CMakeLists.txt") and os.path.isfile("CMakePresets.json")
+
+    def directories_to_remove(self, config: env.Config) -> List[str]:
+        return [f"build/{config.build_type}"]
+
+    def run(self, config: env.Config, rt: env.Runtime) -> int:
+        cmake_vars = cast(Dict[str, str], rt._cfg.get("cmake", {}).get("vars", {}))
+        defines: List[str] = []
+        for var in cmake_vars:
+            value = cmake_vars[var]
+
+            is_flag = value.startswith("?")
+            if is_flag:
+                value = value[1:]
+
+            if value.startswith("config:"):
+                value = value[len("config:")]
+                value = config.get_path(value)
+            elif value.startswith("runtime:"):
+                value = value[len("runtime:")]
+                value = getattr(rt, value, None)
+
+            if is_flag:
+                value = "ON" if value else "OFF"
+
+            defines.append(f"-D{var}={value}")
+
+        return rt.cmd(
+            "cmake",
+            "--preset",
+            f"{config.preset}-{config.build_generator}",
+            *defines,
+        )
+
+
+@step.register()
+class CMakeBuild(CMakeBase):
+    """Builds the project using ``preset`` config."""
+
+    def __init__(self):
+        super().__init__(name="Build", runs_after=["CMake"])
+
+    def run(self, config: env.Config, rt: env.Runtime) -> int:
+        return rt.cmd("cmake", "--build", "--preset", config.preset, "--parallel")
+
+
+@step.register
+class CMakeTest(CMakeBase):
+    """Runs tests in the project using ``preset`` config."""
+
+    def __init__(self):
+        super().__init__(name="Test", runs_after=["Build"])
+
+    def platform_dependencies(self):
+        return self.dep_with_tool("ctest")
+
+    def run(self, config: env.Config, rt: env.Runtime) -> int:
+        return rt.cmd("ctest", "--preset", config.preset)
+
+
+@step.register
+class PackStep(CMakeBase):
+    """
+    Packs archives and installers from ``cpack_generator`` config, using
+    ``preset`` config.
+    """
+
+    def __init__(self):
+        super().__init__(name="Pack", runs_after=["Build"])
+
+    def platform_dependencies(self):
+        return self.dep_with_tool("cpack")
+
+    def is_active(self, config: env.Config, rt: env.Runtime) -> int:
+        return (
+            super().is_active(config, rt)
+            and len(config.items.get("cpack_generator", [])) > 0
+        )
+
+    def run(self, config: env.Config, rt: env.Runtime) -> int:
+        generators = ";".join(config.items.get("cpack_generator", []))
+        return rt.cmd("cpack", "--preset", config.preset, "-G", generators)

proj_flow-0.9.4/src/proj_flow/ext/cplusplus/cmake/version.py

@@ -0,0 +1,35 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.ext.cplusplus.cmake.version** provides project suite plugin.
+"""
+
+import os
+import re
+from typing import NamedTuple, Optional
+
+import toml
+
+from proj_flow.api import env, release
+from proj_flow.ext.cplusplus.cmake.parser import get_project
+
+
+class QuickProjectInfo(NamedTuple):
+    name: Optional[str] = None
+    path: Optional[str] = None
+    pattern: Optional[str] = None
+
+
+@release.project_suites.add
+class ProjectSuite(release.ProjectSuite):
+    def get_project(self, rt: env.Runtime) -> Optional[release.Project]:
+        project = get_project(rt.root)
+        if project is None:
+            return None
+        return release.Project(
+            project.name.value, release.Version(project.version, project.stability)
+        )
+
+    def get_version_file_path(self, rt: env.Runtime) -> Optional[str]:
+        return "CMakeLists.txt"

{proj_flow-0.9.3/src/proj_flow/plugins → proj_flow-0.9.4/src/proj_flow/ext/cplusplus}/conan/__init__.py

@@ -2,7 +2,7 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.plugins.conan** provides the ``"Conan"`` step.
+The **proj_flow.ext.cplusplus.conan** provides the ``"Conan"`` step.
 """
 
 import os
@@ -23,6 +23,7 @@ class ConanConfig:
     """Configures the project for ``preset`` config using ``build_type`` config."""
 
     name = "Conan"
+    runs_before = ["CMake"]
 
     def platform_dependencies(self):
         return ["conan"]

{proj_flow-0.9.3/src/proj_flow/plugins → proj_flow-0.9.4/src/proj_flow/ext/cplusplus}/conan/_conan.py

@@ -2,10 +2,12 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.plugins.conan._conan** adds support for both Conan v1 and v2.
+The **proj_flow.ext.cplusplus.conan._conan** adds support for both Conan v1
+and v2.
 """
 
 import shutil
+import subprocess
 from abc import ABC, abstractmethod
 from typing import Callable, List, cast
 
@@ -119,7 +121,10 @@ def _conan_version():
     if found is None:
         return 1
 
-    proc = cmd.run(found, "--version", capture_output=True)
+    proc = cast(
+        subprocess.CompletedProcess[str],
+        cmd.run(found, "--version", capture_output=True),
+    )
     if proc.returncode != 0:
         return 1
     m = VER_REGEX.search(proc.stdout)

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/ext/github/__init__.py

@@ -6,6 +6,6 @@ The **proj_flow.ext.github** provides GitHub support through CLI and GitHub
 hosting plugin.
 """
 
-from . import cli, hosting
+from . import cli, hosting, switches
 
-__all__ = ["cli", "hosting"]
+__all__ = ["cli", "hosting", "switches"]

proj_flow-0.9.3/src/proj_flow/plugins/github.py → proj_flow-0.9.4/src/proj_flow/ext/github/switches.py

@@ -1,7 +1,7 @@
 # Copyright (c) 2025 Marcin Zdun
 # This code is licensed under MIT license (see LICENSE for details)
 """
-The **proj_flow.plugins.github** provides GitHub-related switches for new
+The **proj_flow.ext.github.switches** provides GitHub-related switches for new
 projects.
 """
 

proj_flow-0.9.3/src/proj_flow/ext/markdown_changelist.py → proj_flow-0.9.4/src/proj_flow/ext/markdown_changelog.py

@@ -2,7 +2,8 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.ext.markdown_changelist** .
+The **proj_flow.ext.markdown_changelog** registers a
+:class:`api.ChangelogGenerator` plugin implemented for markdown changelogs.
 """
 
 from proj_flow.log.rich_text.api import changelog_generators

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/ext/python/rtdocs.py

@@ -2,7 +2,7 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.ext.python.steps.rtdocs** defines RTDocs step, which uses
+The **proj_flow.ext.python.rtdocs** defines RTDocs step (`"RTD"`), which uses
 .readthedocs.yaml to build the HTML documentation.
 """
 

{proj_flow-0.9.3 → proj_flow-0.9.4}/src/proj_flow/ext/python/version.py

@@ -2,8 +2,7 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.ext.python.steps** defines steps for building, installing and
-documenting.
+The **proj_flow.ext.python.version** provides project suite plugin.
 """
 
 import os

proj_flow-0.9.3/src/proj_flow/ext/re_structured_changelist.py → proj_flow-0.9.4/src/proj_flow/ext/re_structured_changelog.py

@@ -2,7 +2,9 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.ext.re_structured_text** .
+The **proj_flow.ext.re_structured_changelog** registers a
+:class:`api.ChangelogGenerator` plugin implemented for reStructuredText
+changelogs.
 """
 
 from proj_flow.log.rich_text.api import changelog_generators