proj-flow 0.8.1__py3-none-any.whl

proj_flow/template/layers/github_actions/.github/workflows/build.yml

@@ -0,0 +1,241 @@
+name: Build
+
+on:
+  push:
+    branches: [ "main" ]
+    tags: [ "v*" ]
+  pull_request:
+  workflow_dispatch:
+
+env:
+  RELEASE: ${{ github.event_name == 'push' && github.ref_type == 'tag' && startsWith(github.ref_name, 'v') }}
+
+jobs:
+  M:
+    name: Select builds
+    runs-on: ubuntu-latest
+    outputs:
+      RELEASE: ${{env.RELEASE}}
+      matrix: ${{steps.flow.outputs.matrix}}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Find builds
+      id: flow
+      run: python ./.flow/flow.py ci matrix
+
+  build:
+    needs: M
+    strategy:
+      matrix: ${{ fromJson(needs.M.outputs.matrix) }}
+
+    env:
+      BUILD_TYPE: ${{ matrix.build_type }}
+      CONAN_REVISIONS_ENABLED: 1
+      FLOW_COMMAND: python ./.flow/flow.py run -D os=${{ matrix.os }} build_type=${{ matrix.build_type }} compiler=${{ matrix.compiler }} sanitizer=${{ matrix.sanitizer }}
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      ARTIFACT_SUFFIX: ${{ matrix.github_os }}-${{ matrix.build_type }}-${{ matrix.compiler }}${{ matrix.sanitizer && '-sanitize' || '' }}
+      CONAN_CACHE: ${{ matrix.github_os }}-${{ matrix.build_type }}-${{ matrix.compiler }}
+
+    runs-on: ${{ matrix.github_os }}
+    name: ${{ matrix.build_name }}
+    outputs:
+      RELEASE: ${{ fromJson(needs.M.outputs.RELEASE) }}
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+         submodules: true
+
+#     ######## ##    ## ##     ## #### ########   #######  ##    ## ##     ## ######## ##    ## ########
+#     ##       ###   ## ##     ##  ##  ##     ## ##     ## ###   ## ###   ### ##       ###   ##    ##
+#     ##       ####  ## ##     ##  ##  ##     ## ##     ## ####  ## #### #### ##       ####  ##    ##
+#     ######   ## ## ## ##     ##  ##  ########  ##     ## ## ## ## ## ### ## ######   ## ## ##    ##
+#     ##       ##  ####  ##   ##   ##  ##   ##   ##     ## ##  #### ##     ## ##       ##  ####    ##
+#     ##       ##   ###   ## ##    ##  ##    ##  ##     ## ##   ### ##     ## ##       ##   ###    ##
+#     ######## ##    ##    ###    #### ##     ##  #######  ##    ## ##     ## ######## ##    ##    ##
+    - name: Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Bootstrap Flow
+      run: |
+        python ./.flow/flow.py bootstrap
+
+    - name: Add msbuild to PATH
+      if: ${{ matrix.windows }}
+      uses: microsoft/setup-msbuild@v1.1
+
+    - name: Install WiX 4
+      if: ${{ matrix.windows }}
+      shell: cmd
+      run: |
+        dotnet tool install --global wix --version 4.0.4
+        wix extension add -g WixToolset.UI.wixext/4.0.4
+
+    - name: Install Ninja
+      if: ${{ matrix.ubuntu }}
+      run: |
+        sudo apt-get install ninja-build -y
+
+    - name: Install GCC 13
+      if: ${{ matrix.ubuntu && matrix.needs_gcc_ppa }}
+      run: |
+        sudo apt install software-properties-common -y
+        sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
+        sudo apt install gcc-13 g++-13 -y
+
+    - name: Set up GCC 13
+      if: ${{ matrix.ubuntu }}
+      run: |
+        sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 130
+        sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-13 130
+        sudo update-alternatives --install /usr/bin/gcov gcov /usr/bin/gcov-13 130
+
+        sudo update-alternatives --set g++ /usr/bin/g++-13
+        sudo update-alternatives --set gcc /usr/bin/gcc-13
+        sudo update-alternatives --set gcov /usr/bin/gcov-13
+
+    - name: Set up GCC 13 as c++/cc
+      if: ${{ matrix.ubuntu && matrix.gcc }}
+      run: |
+        sudo update-alternatives --install /usr/bin/c++ c++ /usr/bin/g++-13 130
+        sudo update-alternatives --install /usr/bin/cc cc /usr/bin/gcc-13 130
+
+        sudo update-alternatives --set c++ /usr/bin/g++-13
+        sudo update-alternatives --set cc /usr/bin/gcc-13
+
+    - name: Install Clang 18
+      if: ${{ matrix.ubuntu && matrix.clang }}
+      run: |
+        wget https://apt.llvm.org/llvm.sh
+        chmod +x llvm.sh
+        sudo ./llvm.sh 18
+
+        sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-18 180
+        sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-18 180
+
+        sudo update-alternatives --install /usr/bin/c++ c++ /usr/bin/clang++-18 180
+        sudo update-alternatives --install /usr/bin/cc cc /usr/bin/clang-18 180
+
+        sudo update-alternatives --set clang++ /usr/bin/clang++-18
+        sudo update-alternatives --set clang /usr/bin/clang-18
+
+        sudo update-alternatives --set c++ /usr/bin/clang++-18
+        sudo update-alternatives --set cc /usr/bin/clang-18
+
+    - name: Check C++ binary
+      if: ${{ matrix.ubuntu }}
+      run: |
+        realpath `which c++`
+        c++ --version
+        sudo locale-gen pl_PL.UTF-8 en_US.UTF-8 en_GB.UTF-8
+
+    - name: Install Conan
+      id: conan
+      uses: turtlebrowser/get-conan@main
+      with:
+        version: 1.66.0
+
+    - name: Conan cache
+      uses: actions/cache@v4
+      id: cache
+      with:
+        path: ${{ matrix.home }}/.conan/data
+        key: ${{ env.CONAN_CACHE }}-${{ hashFiles('conanfile.txt') }}
+        restore-keys: |
+          ${{ env.CONAN_CACHE }}-
+
+#     ########  ########   #######        ## ########  ######  ########
+#     ##     ## ##     ## ##     ##       ## ##       ##    ##    ##
+#     ##     ## ##     ## ##     ##       ## ##       ##          ##
+#     ########  ########  ##     ##       ## ######   ##          ##
+#     ##        ##   ##   ##     ## ##    ## ##       ##          ##
+#     ##        ##    ##  ##     ## ##    ## ##       ##    ##    ##
+#     ##        ##     ##  #######   ######  ########  ######     ##
+
+    - name: Configure
+      run: ${{ env.FLOW_COMMAND }} -s Conan,CMake
+
+    - name: Build
+      run: ${{ env.FLOW_COMMAND }} -s Build
+
+    - name: Test
+      run: ${{ env.FLOW_COMMAND }} -s Test,StoreTests
+
+    - name: Pack
+      id: artifacts
+      if: ${{ fromJson(needs.M.outputs.RELEASE) }}
+      run: ${{ env.FLOW_COMMAND }} -s Sign,Pack,SignPackages,StorePackages
+      env:
+        SIGN_TOKEN: ${{ secrets.SIGN_TOKEN }}
+
+#     ##     ## ########  ##        #######     ###    ########
+#     ##     ## ##     ## ##       ##     ##   ## ##   ##     ##
+#     ##     ## ##     ## ##       ##     ##  ##   ##  ##     ##
+#     ##     ## ########  ##       ##     ## ##     ## ##     ##
+#     ##     ## ##        ##       ##     ## ######### ##     ##
+#     ##     ## ##        ##       ##     ## ##     ## ##     ##
+#      #######  ##        ########  #######  ##     ## ########
+
+    - name: Upload packages
+      uses: actions/upload-artifact@v4
+      if: ${{ steps.artifacts.outputs.CPACK_GENERATORS != '' }}
+      with:
+        name: _packages-${{ env.ARTIFACT_SUFFIX }}
+        path: ${{github.workspace}}/build/artifacts/packages/
+
+    - name: Upload test results
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: _tests-${{ env.ARTIFACT_SUFFIX }}
+        path: ${{github.workspace}}/build/artifacts/test-results/
+
+  merge:
+    name: Merge artifacts
+    runs-on: ubuntu-latest
+    needs: build
+    outputs:
+      RELEASE: ${{ fromJson(needs.build.outputs.RELEASE) }}
+
+    steps:
+    - name: Merge packages
+      uses: actions/upload-artifact/merge@v4
+      if: ${{ fromJson(needs.build.outputs.RELEASE) }}
+      with:
+        name: Packages
+        pattern: _packages-*
+        delete-merged: true
+    - name: Merge test results
+      uses: actions/upload-artifact/merge@v4
+      if: always()
+      with:
+        name: Test Results
+        pattern: _tests-*
+        delete-merged: true
+
+  publish:
+    name: Upload packages
+    if: ${{ fromJson(needs.merge.outputs.RELEASE) }}
+    needs: merge
+    runs-on: ubuntu-latest
+
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Get packages
+      uses: actions/download-artifact@v4
+      with:
+        name: Packages
+        path: ${{github.workspace}}/build/download/packages
+    
+    - name: Upload to release
+      run: python ./.flow/flow.py ci upload --ref "${{github.action_ref}}" "${{github.workspace}}/build/download/packages"

proj_flow/template/layers/github_actions/.github/workflows/linter.yml

@@ -0,0 +1,59 @@
+name: Super-linter
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    name: Super-linter
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v5
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          LOG_LEVEL: ERROR
+          SUPPRESS_POSSUM: true
+
+          VALIDATE_GITHUB_ACTIONS: true
+          VALIDATE_JSON: true
+          VALIDATE_MARKDOWN: true
+
+          VALIDATE_CPP: true
+
+          VALIDATE_PYTHON_BLACK: true
+          VALIDATE_PYTHON_FLAKE8: true
+          VALIDATE_PYTHON_MYPY: true
+          VALIDATE_PYTHON_PYLINT: true
+          VALIDATE_PYTHON_ISORT: true
+
+          VALIDATE_CSS: true
+          VALIDATE_HTML: true
+
+          VALIDATE_JAVASCRIPT_ES: true
+          VALIDATE_JAVASCRIPT_STANDARD: true
+          VALIDATE_JSX: true
+
+          VALIDATE_TYPESCRIPT_ES: true
+          VALIDATE_TYPESCRIPT_STANDARD: true
+          VALIDATE_TSX: true
+
+          IGNORE_GENERATED_FILES: true
+          FILTER_REGEX_INCLUDE: ".*/libs/.*|.*/apps/.*|.*/tools/[^/]+\\.py"
+          FILTER_REGEX_EXCLUDE: ".*/build/.*|\
+                                 .*/external/.*|\
+                                 .*/tools/.*"
+
+      - name: Lint with clang-format
+        uses: DoozyX/clang-format-lint-action@v0.17
+        with:
+            exclude: ./build ./external ./tools
+            clangFormatVersion: 17

proj_flow/template/layers/github_actions/CPPLINT.cfg

@@ -0,0 +1,16 @@
+set noparent
+linelength=120
+exclude_files=./tools
+filter=-build/c++11
+filter=-build/include_order
+filter=-build/include_subdir
+filter=-build/namespaces
+filter=-readability/todo
+filter=-runtime/arrays
+filter=-runtime/explicit
+filter=-runtime/indentation_namespace
+filter=-runtime/int
+filter=-runtime/references
+filter=-whitespace/braces
+filter=-whitespace/tab
+filter=-whitespace/indent

proj_flow/template/layers/github_actions.json

@@ -0,0 +1,3 @@
+{
+    "when": "with_github_actions"
+}

proj_flow/template/layers/github_social/.github/ISSUE_TEMPLATE/bug_report.md.mustache

@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!--
+
+Have you read {{PROJECT.NAME}}'s Code of Conduct? By filing an Issue, you are
+expected to comply with it, including treating everyone with respect:
+https://github.com/???/{{PROJECT.NAME}}/blob/master/CODE_OF_CONDUCT.md
+
+-->
+
+## Describe the bug
+
+_A clear and concise description of what the bug is._
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. <!-- First Step -->
+2. <!-- Second Step -->
+3. <!-- and so on… -->
+
+**Expected behavior:**
+
+_A clear and concise description of what you expected to happen._
+
+**Actual behavior:**
+
+_What actually happens._
+
+**Reproduces how often:**
+
+_What percentage of the time does it reproduce?_
+
+## Platform (please complete the following information)
+ - OS: _[e.g. Ubuntu 18.04, Windows 10 2004]_
+ - Compiler: _[e.g. gcc-10, clang-10, msvc 16.4]_
+ - Library version: _[e.g. tag name, commit id]_
+
+## Additional information
+_Any additional information, configuration or data that might be necessary to reproduce the issue._

proj_flow/template/layers/github_social/.github/ISSUE_TEMPLATE/feature_request.md.mustache

@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+<!--
+
+Have you read {{PROJECT.NAME}}'s Code of Conduct? By filing an Issue, you are
+expected to comply with it, including treating everyone with respect:
+https://github.com/mbits-libs/{{PROJECT.NAME}}/blob/master/CODE_OF_CONDUCT.md
+
+-->
+
+## Summary
+
+_One paragraph explanation of the feature: a clear and concise description of what you want to happen._
+
+## Motivation
+
+_Why are we doing this? What use cases does it support? What is the expected outcome? A clear and concise description of what the problem is. Ex._ I'm always frustrated when [...]
+
+## Describe alternatives you've considered
+
+_A clear and concise description of the alternative solutions you've considered._
+
+## Additional context
+
+_Add any other context or screenshots about the feature request here._ 

proj_flow/template/layers/github_social/CODE_OF_CONDUCT.md.mustache

@@ -0,0 +1,76 @@
+# {{PROJECT.NAME}}'s Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at {{PROJECT.EMAIL}}. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

proj_flow/template/layers/github_social/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# How to contribute
+
+I'm really glad you're reading this. You are probably much further into this, than I am.
+
+_This is very much work in progress._
+
+In the meantime, look at the [issue templates](.github/ISSUE_TEMPLATE/).
+
+Thanks,
+Marcin

proj_flow/template/layers/github_social.json

@@ -0,0 +1,3 @@
+{
+    "when": "with_github_social"
+}

proj_flow/template/licenses/0BSD.mustache

@@ -0,0 +1,12 @@
+Copyright (c) {{COPY.YEAR}} {{COPY.HOLDER}}
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

proj_flow/template/licenses/MIT.mustache

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) {{COPY.YEAR}} {{COPY.HOLDER}}
+
+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/template/licenses/Unlicense.mustache

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

proj_flow/template/licenses/WTFPL.mustache

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

proj_flow/template/licenses/Zlib.mustache

@@ -0,0 +1,19 @@
+zlib License
+
+(C) {{COPY.YEAR}} {{COPY.HOLDER}}
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.

proj_flow-0.8.1.dist-info/METADATA

@@ -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/).