proj-flow 0.8.1__tar.gz

proj_flow-0.8.1/.gitignore

@@ -0,0 +1,171 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

proj_flow-0.8.1/.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3"
+  jobs:
+    pre_build:
+      - python docs/enum-mods.py
+
+sphinx:
+   configuration: docs/source/conf.py
+
+python:
+   install:
+   - requirements: docs/requirements.txt

proj_flow-0.8.1/CHANGELOG.rst

@@ -0,0 +1,209 @@
+=========
+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)
+=================================================================================
+
+Bug Fixes
+---------
+
+- rename the package (`a994760 <https://github.com/mzdun/cxx-flow/commit/a994760c82630aee5c962d8910d4183408b10def>`_)
+
+`0.8.0 <https://github.com/mzdun/proj-flow/compare/v0.7.1...v0.8.0>`_ (2025-02-05)
+=================================================================================
+
+New Features
+------------
+
+- add ci commands (`e90afde <https://github.com/mzdun/proj-flow/commit/e90afde2e4fd1c1e3439f056a9ace31032554cba>`_)
+- changelog support (`a77b99c <https://github.com/mzdun/proj-flow/commit/a77b99c632957a38d83cd91f4f54268b5a0eadeb>`_)
+
+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
+------------
+
+- prepare for docstr modification of commands (`7712728 <https://github.com/mzdun/proj-flow/commit/7712728c91c966d8e31e38d2b84bd5f7c2734faa>`_)
+- support shell completion ``proj-flow`` (`a13358b <https://github.com/mzdun/proj-flow/commit/a13358b5bddd34f3d30fe883d89592742a5395a6>`_)
+
+Bug Fixes
+---------
+
+- set CC and CXX before each new configuration (`13fb9a0 <https://github.com/mzdun/proj-flow/commit/13fb9a020fac336cf450b42f18e88ee5c1a1380a>`_)
+- **docs**: adding autodoc to command functions (`cf0b522 <https://github.com/mzdun/proj-flow/commit/cf0b52259a88fd161f90e379716067fe0389cefe>`_)
+- **docs**: extend docstrings for steps (`782dd77 <https://github.com/mzdun/proj-flow/commit/782dd77ed9197d34ca5263fb10084d574dc24721>`_)
+- **docs**: add quick module docstrings (`aaa0f6d <https://github.com/mzdun/proj-flow/commit/aaa0f6de4fe41b19e3f50380967551fe1e974907>`_)
+- **docs**: tweak wording (`25b29db <https://github.com/mzdun/proj-flow/commit/25b29db69eebfedcb551a06a7d868bcafffbdfbb>`_)
+
+
+`0.6.0 <https://github.com/mzdun/proj-flow/compare/v0.5.0...v0.6.0>`_ (2025-01-31)
+=================================================================================
+
+New Features
+------------
+
+- swap JSON with YAML (`9080581 <https://github.com/mzdun/proj-flow/commit/90805812d6cb850522df95f4fa28ef8fa79c49c1>`_)
+- reorganize code (`7f9f256 <https://github.com/mzdun/proj-flow/commit/7f9f256b0c2885e9a74103d6b107e00578d9ad26>`_)
+
+Bug Fixes
+---------
+
+- **docs**: add documentation for usage (`a37bf7b <https://github.com/mzdun/proj-flow/commit/a37bf7b8c54c67041a4c32e14b7fc80949d62e2d>`_)
+
+
+`0.5.0 <https://github.com/mzdun/proj-flow/compare/v0.4.3...v0.5.0>`_ (2025-01-27)
+=================================================================================
+
+New Features
+------------
+
+- add subcommands support (`b50919a <https://github.com/mzdun/proj-flow/commit/b50919acd56cb1fcf9dce4e0c943fffda0e24cd5>`_)
+
+
+`0.4.3 <https://github.com/mzdun/proj-flow/compare/v0.4.2...v0.4.3>`_ (2025-01-27)
+=================================================================================
+
+Bug Fixes
+---------
+
+- move github bootstrap into proj-flow (`f1569be <https://github.com/mzdun/proj-flow/commit/f1569be3713a2bf9634fa3b5dedf5455a6cad0f1>`_)
+
+
+`0.4.2 <https://github.com/mzdun/proj-flow/compare/v0.4.1...v0.4.2>`_ (2025-01-27)
+=================================================================================
+
+Bug Fixes
+---------
+
+- code cleanups (`4ac2a64 <https://github.com/mzdun/proj-flow/commit/4ac2a6463e0dffc2437ff7a59e618558b0843ed0>`_)
+
+
+`0.4.1 <https://github.com/mzdun/proj-flow/compare/v0.3.7...v0.4.1>`_ (2025-01-27)
+=================================================================================
+
+Bug Fixes
+---------
+
+- keep to stderr (`ee0b920 <https://github.com/mzdun/proj-flow/commit/ee0b920f6f166a7600dbbcc531e1a51c41abd4cd>`_)
+- reorder the signature reading code (`5ab1e8e <https://github.com/mzdun/proj-flow/commit/5ab1e8e60e03d238bc00f25db77bd86b49d715b9>`_)
+- work with misconfigured environments better (`ed944e9 <https://github.com/mzdun/proj-flow/commit/ed944e9aa074f2ed94a8983c53ec54a1e45effeb>`_)
+
+
+`0.3.7 <https://github.com/mzdun/proj-flow/compare/v0.3.6...v0.3.7>`_ (2025-01-27)
+=================================================================================
+
+Bug Fixes
+---------
+
+- tak generator from a real place (`db5ffd8 <https://github.com/mzdun/proj-flow/commit/db5ffd8b52c5d5e0eda890bc9e086846942e1871>`_)
+
+
+`0.3.6 <https://github.com/mzdun/proj-flow/compare/v0.3.5...v0.3.6>`_ (2025-01-27)
+=================================================================================
+
+Bug Fixes
+---------
+
+- write the generators on store (`396e5f2 <https://github.com/mzdun/proj-flow/commit/396e5f21f6d6c66b2808792c00d21e7ea9fe219f>`_)
+
+
+`0.3.5 <https://github.com/mzdun/proj-flow/compare/v0.3.4...v0.3.5>`_ (2025-01-26)
+=================================================================================
+
+Bug Fixes
+---------
+
+- bring back Windows in github --matrix (`63f1cef <https://github.com/mzdun/proj-flow/commit/63f1ceff17e253eeadd1bd501f8966b03569c509>`_)
+
+
+`0.3.4 <https://github.com/mzdun/proj-flow/compare/v0.3.3...v0.3.4>`_ (2025-01-26)
+=================================================================================
+
+Bug Fixes
+---------
+
+- bring back f-strings (+ fix the build workflow) (`168c679 <https://github.com/mzdun/proj-flow/commit/168c679eb19f36e599f49e086925f4481d1a302c>`_)
+
+
+`0.3.3 <https://github.com/mzdun/proj-flow/compare/v0.3.2...v0.3.3>`_ (2025-01-26)
+=================================================================================
+
+Bug Fixes
+---------
+
+- downgrade Python even more (`424ae45 <https://github.com/mzdun/proj-flow/commit/424ae4558137557cf905178ef7ad3f88aa202666>`_)
+
+
+`0.3.2 <https://github.com/mzdun/proj-flow/compare/v0.3.1...v0.3.2>`_ (2025-01-26)
+=================================================================================
+
+Bug Fixes
+---------
+
+- clean GitHub Actions support (`f3b572e <https://github.com/mzdun/proj-flow/commit/f3b572e87168cbb4758742b0f28dc692887603dc>`_)
+
+
+`0.3.1 <https://github.com/mzdun/proj-flow/compare/v0.3.0...v0.3.1>`_ (2025-01-26)
+=================================================================================
+
+Bug Fixes
+---------
+
+- downgrade required python (`4eb14b9 <https://github.com/mzdun/proj-flow/commit/4eb14b92eb514adc1a8405bf58be22157cf7c8ae>`_)
+
+
+`0.3.0 <https://github.com/mzdun/proj-flow/compare/v0.2.0...v0.3.0>`_ (2025-01-26)
+=================================================================================
+
+New Features
+------------
+
+- add application icon (`7e42a1c <https://github.com/mzdun/proj-flow/commit/7e42a1cb05894d12aadb418b20b6733148e3e136>`_)
+- add Makefile rule list (`1af5ba3 <https://github.com/mzdun/proj-flow/commit/1af5ba3ce3f323700134132da55479cf5c6cf364>`_)
+- look into .flow/extensions (`fe3741f <https://github.com/mzdun/proj-flow/commit/fe3741f46ae4e20baba286dbec5f8eccdad8941c>`_)
+- add runs_before to steps (`2d65734 <https://github.com/mzdun/proj-flow/commit/2d65734fda53182875637c641f7de947175c02c1>`_)
+- move config dirs inside .flow (`db4e406 <https://github.com/mzdun/proj-flow/commit/db4e4063bac0ccfd4b8f3ef481a2407ce02c6ffc>`_)
+- return the WIX support (`b81011b <https://github.com/mzdun/proj-flow/commit/b81011bbb00ddd3bb34dd5918e9aa46342ab239e>`_)
+
+Bug Fixes
+---------
+
+- copy attributes from layers (`7e2ea63 <https://github.com/mzdun/proj-flow/commit/7e2ea637ffe6db855fca5d3a09eb395b8e8d7d62>`_)
+- ignore signature, if it exists (`9b21854 <https://github.com/mzdun/proj-flow/commit/9b218544514edf5e6b9e881062c0e013c7fdeb80>`_)
+
+
+`0.2.0 <https://github.com/mzdun/proj-flow/commits/v0.2.0>`_ (2025-01-22)
+========================================================================
+
+New Features
+------------
+
+- use win32 signtool on exes and msis (`98c1162 <https://github.com/mzdun/proj-flow/commit/98c11629a7115b9d343374bb14f6fa23f92e6192>`_)
+- add list command (`4ab8ec9 <https://github.com/mzdun/proj-flow/commit/4ab8ec9853c1bc19c495dc4e52190f9603ad6c09>`_)
+- add flow helpers in project root (`18c0afa <https://github.com/mzdun/proj-flow/commit/18c0afaa36067d31d46394370e737fb277e0f660>`_)
+- add store steps (`e3e20e6 <https://github.com/mzdun/proj-flow/commit/e3e20e6a4522218bf9e1602dea4f2862bdb44cfb>`_)
+- add cpack step (`9698c8f <https://github.com/mzdun/proj-flow/commit/9698c8f3d53af42bcc1811e185db00e3165cf6e3>`_)
+- add system command (`b17e6b4 <https://github.com/mzdun/proj-flow/commit/b17e6b4223d3f96641273f453161af6b7620189c>`_)
+- add ctest step (`2f7d32c <https://github.com/mzdun/proj-flow/commit/2f7d32c3bec375517edb8acea2301ebdaaee8a8f>`_)
+
+Bug Fixes
+---------
+
+- bring back path re-writing on Windows (`8509f96 <https://github.com/mzdun/proj-flow/commit/8509f96fac75ad289b2c8f60a66ece5048cd22ae>`_)
+
+

proj_flow-0.8.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Marcin Zdun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

proj_flow-0.8.1/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: proj-flow
+Version: 0.8.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/
+Project-URL: Source Code, https://github.com/mzdun/proj-flow
+Author-email: Marcin Zdun <marcin.zdun@gmail.com>
+License-File: LICENSE
+Keywords: C/C++,c++,ci,cpp,dependency,developer,manager,tool
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.10
+Requires-Dist: argcomplete
+Requires-Dist: chevron2021
+Requires-Dist: prompt-toolkit
+Requires-Dist: pyyaml
+Description-Content-Type: text/markdown
+
+# C++ 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, 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.
+
+Currently, it will make use of Conan for external dependencies, CMake presets
+for config and build and GitHub CLI for releases.
+
+## Installation
+
+To create a new project with _C++ flow_, first install it using pip:
+
+```sh
+(.venv) $ pip install proj-flow
+```
+
+Every project created with _C++ 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
+projects through the `bootstrap` command.
+
+On any platform, this command (and any other) may be called from the root of the
+project with:
+
+```sh
+python .flow/flow.py bootstrap
+```
+
+From Bash with:
+
+```sh
+./flow bootstrap
+```
+
+From PowerShell with:
+
+```sh
+.\flow bootstrap
+```
+
+## Creating a project
+
+A fresh C++ project can be created with a
+
+```sh
+proj-flow init
+```
+
+This command will ask multiple questions to build Mustache context for the
+project template. For more information, see [the documentation](https://proj-flow.readthedocs.io/en/latest/).

proj_flow-0.8.1/README.md

@@ -0,0 +1,57 @@
+# C++ 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, 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.
+
+Currently, it will make use of Conan for external dependencies, CMake presets
+for config and build and GitHub CLI for releases.
+
+## Installation
+
+To create a new project with _C++ flow_, first install it using pip:
+
+```sh
+(.venv) $ pip install proj-flow
+```
+
+Every project created with _C++ 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
+projects through the `bootstrap` command.
+
+On any platform, this command (and any other) may be called from the root of the
+project with:
+
+```sh
+python .flow/flow.py bootstrap
+```
+
+From Bash with:
+
+```sh
+./flow bootstrap
+```
+
+From PowerShell with:
+
+```sh
+.\flow bootstrap
+```
+
+## Creating a project
+
+A fresh C++ project can be created with a
+
+```sh
+proj-flow init
+```
+
+This command will ask multiple questions to build Mustache context for the
+project template. For more information, see [the documentation](https://proj-flow.readthedocs.io/en/latest/).

proj_flow-0.8.1/proj_flow/__init__.py

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

proj_flow-0.8.1/proj_flow/__main__.py

@@ -0,0 +1,10 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.__main__** allows *C++ flow* to be called as Python component.
+"""
+
+from .flow.cli import main
+
+main()

proj_flow-0.8.1/proj_flow/api/__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.api** contains public APIs, usable in third-party plugins.
+"""
+
+from . import arg, completers, ctx, env, init, makefile, step
+
+__all__ = ["arg", "completers", "ctx", "env", "init", "makefile", "step"]