proj-flow 0.8.1__tar.gz → 0.9.1__tar.gz

proj_flow-0.9.1/.flow/config.yaml

@@ -0,0 +1,11 @@
+extensions:
+  - proj_flow.ext.python
+  - proj_flow.ext.github
+  - proj_flow.ext.re_structured_changelist
+
+entry:
+  build: [ Build ]
+  install: [ Install ]
+  docs: [ RTD ]
+  verify: [ Build, Check Twine ]
+  refresh: [ Install, Build, RTD, Check Twine ]

{proj_flow-0.8.1 → proj_flow-0.9.1}/CHANGELOG.rst

@@ -4,16 +4,43 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
-`0.8.1 <https://github.com/mzdun/cxx-flow/compare/v0.8.0...v0.8.1>`_ (2025-02-05)
-=================================================================================
+`0.9.1 <https://github.com/mzdun/proj-flow/compare/v0.9.0...v0.9.1>`_ (2025-02-07)
+==================================================================================
 
 Bug Fixes
 ---------
 
-- rename the package (`a994760 <https://github.com/mzdun/cxx-flow/commit/a994760c82630aee5c962d8910d4183408b10def>`_)
+- turn auto-release on (`1a79267 <https://github.com/mzdun/proj-flow/commit/1a792677e66c882266b3e2b61f5adde885653814>`_)
+- prepare for autorelease (`9bbc4c5 <https://github.com/mzdun/proj-flow/commit/9bbc4c5abba3a945908f1ad796fed0e3d5bf390e>`_)
+
+`0.9.0 <https://github.com/mzdun/proj-flow/compare/v0.8.1...v0.9.0>`_ (2025-02-07)
+==================================================================================
+
+New Features
+------------
+
+- add python steps and version bumper (`1bca0cb <https://github.com/mzdun/proj-flow/commit/1bca0cb11e53ee137b0179d951c3d9767475fb8d>`_)
+- add ``github matrix`` and ``github release`` (`56d3ada <https://github.com/mzdun/proj-flow/commit/56d3ada74b2f38f1c1fb0dd8d63cdcb1e3e6ac98>`_)
+- allow making software releases (`7ae1552 <https://github.com/mzdun/proj-flow/commit/7ae1552011c62fb92aefa8dafcef8cf499c2165d>`_)
+- create hosting extension point (`f1464c2 <https://github.com/mzdun/proj-flow/commit/f1464c2da6dfea8aa42ce59d0d039505e6b37ae6>`_)
+- add simple decorator for extension points (`1483dba <https://github.com/mzdun/proj-flow/commit/1483dba8794e75ad8444e831af9a38fc7dc2d430>`_)
+- introduce new plugin system (`eb62ce3 <https://github.com/mzdun/proj-flow/commit/eb62ce3b5b9649affc9c925ce454940cbd2d52c3>`_)
+
+Bug Fixes
+---------
+
+- add some verbosity to plugin system (`830f6b8 <https://github.com/mzdun/proj-flow/commit/830f6b8227ba62286ec039d0445c1b5dc81cd65a>`_)
+
+`0.8.1 <https://github.com/mzdun/proj-flow/compare/v0.8.0...v0.8.1>`_ (2025-02-05)
+==================================================================================
+
+Bug Fixes
+---------
+
+- rename the package (`a994760 <https://github.com/mzdun/proj-flow/commit/a994760c82630aee5c962d8910d4183408b10def>`_)
 
 `0.8.0 <https://github.com/mzdun/proj-flow/compare/v0.7.1...v0.8.0>`_ (2025-02-05)
-=================================================================================
+==================================================================================
 
 New Features
 ------------
@@ -27,13 +54,13 @@ Bug Fixes
 - extract the code common to docstr and argparse (`ce09b2f <https://github.com/mzdun/proj-flow/commit/ce09b2f131e8bd2df7563b600ac5d1ff50928957>`_)
 
 `0.7.1 <https://github.com/mzdun/proj-flow/compare/v0.7.0...v0.7.1>`_ (2025-02-02)
-=================================================================================
+==================================================================================
 
 *Nothing to report.*
 
 
 `0.7.0 <https://github.com/mzdun/proj-flow/compare/v0.6.0...v0.7.0>`_ (2025-02-02)
-=================================================================================
+==================================================================================
 
 New Features
 ------------
@@ -52,7 +79,7 @@ Bug Fixes
 
 
 `0.6.0 <https://github.com/mzdun/proj-flow/compare/v0.5.0...v0.6.0>`_ (2025-01-31)
-=================================================================================
+==================================================================================
 
 New Features
 ------------
@@ -67,7 +94,7 @@ Bug Fixes
 
 
 `0.5.0 <https://github.com/mzdun/proj-flow/compare/v0.4.3...v0.5.0>`_ (2025-01-27)
-=================================================================================
+==================================================================================
 
 New Features
 ------------
@@ -76,7 +103,7 @@ New Features
 
 
 `0.4.3 <https://github.com/mzdun/proj-flow/compare/v0.4.2...v0.4.3>`_ (2025-01-27)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -85,7 +112,7 @@ Bug Fixes
 
 
 `0.4.2 <https://github.com/mzdun/proj-flow/compare/v0.4.1...v0.4.2>`_ (2025-01-27)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -94,7 +121,7 @@ Bug Fixes
 
 
 `0.4.1 <https://github.com/mzdun/proj-flow/compare/v0.3.7...v0.4.1>`_ (2025-01-27)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -105,7 +132,7 @@ Bug Fixes
 
 
 `0.3.7 <https://github.com/mzdun/proj-flow/compare/v0.3.6...v0.3.7>`_ (2025-01-27)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -114,7 +141,7 @@ Bug Fixes
 
 
 `0.3.6 <https://github.com/mzdun/proj-flow/compare/v0.3.5...v0.3.6>`_ (2025-01-27)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -123,7 +150,7 @@ Bug Fixes
 
 
 `0.3.5 <https://github.com/mzdun/proj-flow/compare/v0.3.4...v0.3.5>`_ (2025-01-26)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -132,7 +159,7 @@ Bug Fixes
 
 
 `0.3.4 <https://github.com/mzdun/proj-flow/compare/v0.3.3...v0.3.4>`_ (2025-01-26)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -141,7 +168,7 @@ Bug Fixes
 
 
 `0.3.3 <https://github.com/mzdun/proj-flow/compare/v0.3.2...v0.3.3>`_ (2025-01-26)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -150,7 +177,7 @@ Bug Fixes
 
 
 `0.3.2 <https://github.com/mzdun/proj-flow/compare/v0.3.1...v0.3.2>`_ (2025-01-26)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -159,7 +186,7 @@ Bug Fixes
 
 
 `0.3.1 <https://github.com/mzdun/proj-flow/compare/v0.3.0...v0.3.1>`_ (2025-01-26)
-=================================================================================
+==================================================================================
 
 Bug Fixes
 ---------
@@ -168,7 +195,7 @@ Bug Fixes
 
 
 `0.3.0 <https://github.com/mzdun/proj-flow/compare/v0.2.0...v0.3.0>`_ (2025-01-26)
-=================================================================================
+==================================================================================
 
 New Features
 ------------
@@ -188,7 +215,7 @@ Bug Fixes
 
 
 `0.2.0 <https://github.com/mzdun/proj-flow/commits/v0.2.0>`_ (2025-01-22)
-========================================================================
+=========================================================================
 
 New Features
 ------------

{proj_flow-0.8.1 → proj_flow-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proj-flow
-Version: 0.8.1
+Version: 0.9.1
 Summary: C++ project maintenance, automated
 Project-URL: Documentation, https://proj-flow.readthedocs.io/en/latest/
 Project-URL: Homepage, https://pypi.org/project/proj-flow/
@@ -20,15 +20,16 @@ Requires-Dist: argcomplete
 Requires-Dist: chevron2021
 Requires-Dist: prompt-toolkit
 Requires-Dist: pyyaml
+Requires-Dist: toml
 Description-Content-Type: text/markdown
 
-# C++ flow
+# Project Flow
 
 [![Python package workflow badge](https://github.com/mzdun/proj-flow/actions/workflows/python-publish.yml/badge.svg)](https://github.com/mzdun/proj-flow/actions)
 [![PyPI version badge](https://img.shields.io/pypi/v/proj-flow.svg)](https://pypi.python.org/pypi/proj-flow)
 [![PyPI License: MIT](https://img.shields.io/pypi/l/proj-flow.svg)](https://pypi.python.org/pypi/proj-flow)
 
-**C++ flow** aims at being a one-stop tool for C++ projects, from creating new
+**Project Flow** aims at being a one-stop tool for C++ projects, from creating new
 project, though building and verifying, all the way to publishing releases to
 the repository. It will run a set of known steps and will happily consult your
 project what do you want to call any subset of those steps.
@@ -38,13 +39,13 @@ for config and build and GitHub CLI for releases.
 
 ## Installation
 
-To create a new project with _C++ flow_, first install it using pip:
+To create a new project with _Project Flow_, first install it using pip:
 
 ```sh
 (.venv) $ pip install proj-flow
 ```
 
-Every project created with _C++ flow_ has a self-bootstrapping helper script,
+Every project created with _Project Flow_ has a self-bootstrapping helper script,
 which will install `proj-flow` if it is needed, using either current virtual
 environment or switching to a private virtual environment (created inside
 `.flow/.venv` directory). This is used by the GitHub workflow in the generated

{proj_flow-0.8.1 → proj_flow-0.9.1}/README.md

@@ -1,10 +1,10 @@
-# C++ flow
+# Project Flow
 
 [![Python package workflow badge](https://github.com/mzdun/proj-flow/actions/workflows/python-publish.yml/badge.svg)](https://github.com/mzdun/proj-flow/actions)
 [![PyPI version badge](https://img.shields.io/pypi/v/proj-flow.svg)](https://pypi.python.org/pypi/proj-flow)
 [![PyPI License: MIT](https://img.shields.io/pypi/l/proj-flow.svg)](https://pypi.python.org/pypi/proj-flow)
 
-**C++ flow** aims at being a one-stop tool for C++ projects, from creating new
+**Project Flow** aims at being a one-stop tool for C++ projects, from creating new
 project, though building and verifying, all the way to publishing releases to
 the repository. It will run a set of known steps and will happily consult your
 project what do you want to call any subset of those steps.
@@ -14,13 +14,13 @@ for config and build and GitHub CLI for releases.
 
 ## Installation
 
-To create a new project with _C++ flow_, first install it using pip:
+To create a new project with _Project Flow_, first install it using pip:
 
 ```sh
 (.venv) $ pip install proj-flow
 ```
 
-Every project created with _C++ flow_ has a self-bootstrapping helper script,
+Every project created with _Project Flow_ has a self-bootstrapping helper script,
 which will install `proj-flow` if it is needed, using either current virtual
 environment or switching to a private virtual environment (created inside
 `.flow/.venv` directory). This is used by the GitHub workflow in the generated

{proj_flow-0.8.1 → proj_flow-0.9.1}/pyproject.toml

@@ -3,13 +3,13 @@ build-backend = "hatchling.build"
 requires = ["hatchling"]
 
 [tool.hatch.version]
-path = "proj_flow/__init__.py"
+path = "src/proj_flow/__init__.py"
 
 [tool.hatch.build.targets.sdist]
 exclude = ["/.github", "/docs"]
 
 [tool.hatch.build.targets.wheel]
-packages = ["proj_flow"]
+packages = ["src/proj_flow"]
 
 [project]
 authors = [{name = "Marcin Zdun", email = "marcin.zdun@gmail.com"}]
@@ -27,6 +27,7 @@ dependencies = [
   "chevron2021",
   "prompt_toolkit",
   "PyYAML",
+  "toml",
 ]
 description = "C++ project maintenance, automated"
 dynamic = ["version"]
@@ -41,4 +42,4 @@ Homepage = "https://pypi.org/project/proj-flow/"
 "Source Code" = "https://github.com/mzdun/proj-flow"
 
 [project.scripts]
-proj-flow = "proj_flow.flow.cli:main"
+proj-flow = "proj_flow.cli:main"

{proj_flow-0.8.1 → proj_flow-0.9.1/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.8.1"
+__version__ = "0.9.1"

{proj_flow-0.8.1 → proj_flow-0.9.1/src}/proj_flow/__main__.py

@@ -2,9 +2,9 @@
 # This code is licensed under MIT license (see LICENSE for details)
 
 """
-The **proj_flow.__main__** allows *C++ flow* to be called as Python component.
+The **proj_flow.__main__** allows *Project Flow* to be called as Python component.
 """
 
-from .flow.cli import main
+from proj_flow.cli import main
 
 main()

proj_flow-0.9.1/src/proj_flow/api/__init__.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.api** contains public APIs, usable in third-party plugins.
+"""
+
+from . import arg, completers, ctx, env, init, makefile, release, step
+
+__all__ = [
+    "arg",
+    "completers",
+    "ctx",
+    "env",
+    "init",
+    "makefile",
+    "release",
+    "step",
+]

{proj_flow-0.8.1 → proj_flow-0.9.1/src}/proj_flow/api/arg.py

@@ -24,7 +24,7 @@ class Argument:
     action: typing.Union[str, argparse.Action, None] = None
     default: typing.Optional[typing.Any] = None
     choices: typing.Optional[typing.List[str]] = None
-    completer: typing.Optional[callable] = None  # type: ignore
+    completer: typing.Optional[_inspect.Function] = None
 
     def visit(self, parser: argparse.ArgumentParser, name: str):
         kwargs = {}
@@ -68,11 +68,16 @@ class FlagArgument(Argument):
 @dataclass
 class _Command:
     name: str
-    entry: typing.Optional[callable]  # type: ignore
+    entry: typing.Optional[_inspect.Function]
     doc: typing.Optional[str]
     subs: typing.Dict[str, "_Command"]
 
-    def add(self, names: typing.List[str], entry: callable, doc: typing.Optional[str]):  # type: ignore
+    def add(
+        self,
+        names: typing.List[str],
+        entry: _inspect.Function,
+        doc: typing.Optional[str],
+    ):
         name = names[0]
         rest = names[1:]
         if len(rest):
@@ -97,15 +102,18 @@ _known_commands = _Command("", None, None, {})
 _autodoc = {
     "proj_flow.flow.configs.Configs": "Current configuration list.",
     "proj_flow.api.env.Runtime": "Tools and print messages, while respecting ``--dry-run``, ``--silent`` and ``--verbose``.",
+    "proj_flow.cli.argument.Command": "The Command object attached to this @command function.",
 }
 
 
 def command(*name: str):
-    def wrap(entry: callable):  # type: ignore
+    def wrap(function: object):
+        entry = typing.cast(_inspect.Function, function)
         global _known_commands
-        _known_commands.add(list(name), entry, entry.__doc__)
+        orig_doc = inspect.getdoc(entry)
+        _known_commands.add(list(name), entry, orig_doc)
 
-        doc = inspect.getdoc(entry) or ""
+        doc = orig_doc or ""
         if doc:
             doc += "\n\n"
 

{proj_flow-0.8.1 → proj_flow-0.9.1/src}/proj_flow/api/env.py

@@ -23,9 +23,7 @@ from dataclasses import dataclass
 from enum import Enum
 from typing import Any, Callable, Dict, List, Optional, Union, cast
 
-import yaml
-
-from proj_flow.base import uname
+from proj_flow.base import plugins, uname
 from proj_flow.base.plugins import load_module_plugins
 
 platform = uname.uname()[0]
@@ -132,47 +130,29 @@ class FlowConfig:
             self.root = cfg.root
         else:
             self.root = os.path.abspath(root)
-            try:
-                with open(
-                    os.path.join(self.root, ".flow", "config.yml"),
-                    encoding="UTF-8",
-                ) as f:
-                    self._cfg = yaml.load(f, Loader=yaml.Loader)
-            except FileNotFoundError:
-                self._cfg = {}
+            self._cfg = plugins.load_data(
+                os.path.join(self.root, ".flow", "config.json")
+            )
 
             self._propagate_compilers()
-            self._load_plugins()
+            self._load_extensions()
 
     def _propagate_compilers(self):
         global _flow_config_default_compiler
         _flow_config_default_compiler = self.compiler_os_default
 
-    def _load_plugins(self):
-        std_plugins = importlib.import_module("proj_flow.plugins")
-        load_module_plugins(std_plugins)
+    def _load_extensions(self):
+        extensions = cast(List[str], self._cfg.get("extensions", []))
+        extensions.insert(0, "proj_flow.minimal")
 
-        local_plugins = os.path.abspath(os.path.join(self.root, ".flow", "extensions"))
-        if not os.path.exists(local_plugins):
-            return
-
-        if not os.path.isdir(local_plugins):
-            plugins = importlib.import_module(local_plugins)
-            load_module_plugins(plugins, can_fail=True)
-            return
-
-        sys.path.insert(0, local_plugins)
-
-        for root, dirnames, _ in os.walk(local_plugins):
-            for dirname in dirnames:
-                init = os.path.join(root, dirname, "__init__.py")
-                if not os.path.isfile(init):
-                    continue
-                plugins = importlib.import_module(dirname)
-                load_module_plugins(plugins, can_fail=True)
-            dirnames[:] = []
+        local_extensions = os.path.abspath(
+            os.path.join(self.root, ".flow", "extensions")
+        )
+        if os.path.isdir(local_extensions):
+            sys.path.insert(0, local_extensions)
 
-        sys.path.pop(0)
+        for extension in extensions:
+            importlib.import_module(extension)
 
     @property
     def entry(self) -> Dict[str, dict]:

proj_flow-0.9.1/src/proj_flow/api/release.py

@@ -0,0 +1,99 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.api.release** provides :class:`ProjectSuite` extension point.
+"""
+
+import os
+import re
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from typing import NamedTuple, Optional, Union
+
+from proj_flow.api import env
+from proj_flow.base import registry
+
+
+class Arg(NamedTuple):
+    value: str
+    offset: int
+
+
+NO_ARG = Arg("", -1)
+
+
+class Decl(NamedTuple):
+    name: str
+    value: str
+    offset: int
+
+    def __str__(self):
+        return self.value
+
+    def asArg(self):
+        return Arg(self.value, self.offset)
+
+
+class Version(NamedTuple):
+    core: Arg
+    stability: Arg
+
+    def __str__(self):
+        return f"{self.core.value}{self.stability.value}"
+
+
+@dataclass
+class Project:
+    package_root: str
+    version: Version
+
+    @property
+    def archive_name(self):
+        return f"{self.package_root}-{self.version}"
+
+    @property
+    def tag_name(self):
+        return f"v{self.version}"
+
+
+class ProjectSuite(ABC):
+    @abstractmethod
+    def get_project(self, rt: env.Runtime) -> Optional[Project]: ...
+
+    def set_version(self, rt: env.Runtime, version: str):
+        core = re.split(r"([0-9]+\.[0-9]+\.[0-9]+)", version, maxsplit=1)[1]
+        stability = version[len(core) :]
+
+        project = self.get_project(rt)
+        if project:
+            self.patch_project(rt, project.version.core, core)
+
+        project = self.get_project(rt)
+        if project:
+            version_pos = project.version
+
+            if len(stability):
+                self.patch_project(rt, version_pos.stability, stability)
+            elif len(version_pos.stability.value):
+                self.patch_project(rt, version_pos.stability, "")
+
+    @abstractmethod
+    def get_version_file_path(self, rt: env.Runtime) -> Optional[str]: ...
+
+    def patch_project(self, rt: env.Runtime, pos: Arg, newValue: str):
+        path = self.get_version_file_path(rt)
+
+        if not path or not os.path.isfile(path):
+            return
+
+        with open(path, "r", encoding="UTF-8") as input:
+            text = input.read()
+
+        patched = text[: pos.offset] + newValue + text[pos.offset + len(pos.value) :]
+
+        with open(path, "w", encoding="UTF-8") as input:
+            input.write(patched)
+
+
+project_suites = registry.Registry[ProjectSuite]("ProjectSuite")

{proj_flow-0.8.1 → proj_flow-0.9.1/src}/proj_flow/api/step.py

@@ -5,10 +5,12 @@
 The **proj_flow.api.step** exposes APIs used by run extensions.
 """
 
+import os
 from abc import ABC, abstractmethod
 from typing import List, cast
 
 from proj_flow.api.env import Config, Runtime
+from proj_flow.base import inspect as _inspect
 from proj_flow.base import matrix
 
 
@@ -77,7 +79,8 @@ def _register_step(step: Step):
 
     name = step.name
     if name in [step.name for step in __steps]:
-        raise NameError(f"Step {name} already registered")
+        if "READTHEDOCS" not in os.environ:
+            raise NameError(f"Step {name} already registered")
 
     __steps.append(step)
 
@@ -115,7 +118,7 @@ def _name_list(label: str, names: List[str], template="`{}`") -> str:
     return f"\n:{label}: {prefix}{em[-1]}"
 
 
-def _make_private(f: callable):
+def _make_private(f: _inspect.Function):
     if f.__doc__:
         f.__doc__ += "\n\n:meta private:\n"
     else:
@@ -171,3 +174,10 @@ def register(cls=None):
         return impl
 
     return impl(cls)
+
+
+def verbose_info():
+    for step in __steps:
+        print(
+            f'-- Step: adding "{step.name}" from `{step.__module__}.{step.__class__.__name__}`'
+        )

{proj_flow-0.8.1 → proj_flow-0.9.1/src}/proj_flow/base/__init__.py

@@ -6,6 +6,6 @@ The **proj_flow.base** contains low-level tools for higher-level parts of the
 library.
 """
 
-from . import cmd, matrix, plugins, uname
+from . import cmd, matrix, plugins, registry, uname
 
-__all__ = ["cmd", "matrix", "plugins", "uname"]
+__all__ = ["cmd", "matrix", "plugins", "registry", "uname"]