opentemplate 0.0.1__tar.gz

opentemplate-0.0.1/LICENSE.md

@@ -0,0 +1 @@
+LICENSES/Apache-2.0.txt

opentemplate-0.0.1/PKG-INFO

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: opentemplate
+Version: 0.0.1
+Summary: The simplest to use, yet the most comprehensive Python template
+Author: open-nudge
+Maintainer: open-nudge
+License-Expression: Apache-2.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Project-URL: Changelog, https://github.com/open-nudge/opentemplate/blob/master/CHANGELOG.md
+Project-URL: Documentation, https://open-nudge.github.io/opentemplate
+Project-URL: Homepage, https://open-nudge.github.io/opentemplate
+Project-URL: Issues, https://github.com/open-nudge/opentemplate/issues
+Project-URL: Repository, https://github.com/open-nudge/opentemplate
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: © 2025 open-nudge <https://github.com/open-nudge>
+SPDX-FileContributor: szymonmaszke <github@maszke.co>
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# opentemplate
+
+<!-- mkdocs remove start -->
+
+<!-- vale off -->
+
+<!-- pyml disable-num-lines 30 line-length-->
+
+<p align="center">
+    <em>The simplest to use, yet the most comprehensive Python template</em>
+</p>
+
+<div align="center">
+
+<a href="https://pypi.org/project/opentemplate">![PyPI - Python Version](https://img.shields.io/pypi/v/opentemplate?style=for-the-badge&label=release&labelColor=grey&color=blue)
+</a>
+<a href="https://pypi.org/project/opentemplate">![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fopen-nudge%2Fopentemplate%2Fmain%2Fpyproject.toml&style=for-the-badge&label=python&labelColor=grey&color=blue)
+</a>
+<a href="https://opensource.org/licenses/Apache-2.0">![License](https://img.shields.io/badge/License-Apache_2.0-blue?style=for-the-badge)
+</a>
+<a>![Coverage Hardcoded](https://img.shields.io/badge/coverage-100%25-green?style=for-the-badge)
+</a>
+<a href="https://scorecard.dev/viewer/?uri=github.com/open-nudge/opentemplate">![OSSF-Scorecard Score](https://img.shields.io/ossf-scorecard/github.com/open-nudge/opentemplate?style=for-the-badge&label=OSSF)
+</a>
+
+</div>
+
+<p align="center">
+✨ <a href="#features">Features</a>
+🚀 <a href="#quick-start">Quick start</a>
+📚 <a href="https://open-nudge.github.io/opentemplate">Documentation</a>
+🤝 <a href="#contribute">Contribute</a>
+👍 <a href="https://github.com/open-nudge/opentemplate/blob/main/ADOPTERS.md">Adopters</a>
+📜 <a href="#legal">Legal</a>
+</p>
+<!-- vale on -->
+
+______________________________________________________________________
+
+<!-- mkdocs remove end -->
+
+## Features
+
+__opentemplate__ is a Python template with the following features:
+
+- [__Truly open source__](https://open-nudge.github.io/opentemplate/template/about/philosophy):
+    no tokens, no fees, no premium plans, open source software only
+- [__Ease of use__](https://open-nudge.github.io/opentemplate/template/quickstart/usage):
+    clone templated repo, run `pdm setup` and __focus on your code__
+- [__Consistency__](https://open-nudge.github.io/opentemplate/template/configuration/basic):
+    `pre-commit` and `GitHub Actions` share the same config (`pyproject.toml`)
+- [__Security__](https://open-nudge.github.io/opentemplate/template/details/security):
+    [SLSA](https://slsa.dev/) L3+ (public/enterprise) or L2 (private),
+    [OSSF Best Practices](https://github.com/ossf/scorecard)
+- [__Batteries included__](https://open-nudge.github.io/opentemplate/template/details):
+    multiple checkers for Python, YAML, Markdown, prose, etc.
+- [__Performance__](https://open-nudge.github.io/opentemplate/template/details/github-actions):
+    Parallel checks, builds, minimally-sized caches and checkouts
+
+## Quick start
+
+### Installation
+
+> [!NOTE]
+> [Install `pdm`](https://pdm-project.org/en/latest/#recommended-installation-method)
+> (if you don't have it already), for Linux/MacOS:
+
+```sh
+curl -sSL https://pdm-project.org/install-pdm.py | python3 -
+```
+
+1. Create a new GitHub repository using this template
+    (green `Use this template` button)
+1. Name your repo (__use underscore `_`, not hyphens `-`__)
+1. Add project description (__necessary!__)
+1. __Wait until the setup commit appears__
+    (performed by `github-actions[bot]`, it may take a few minutes)
+1. Clone the repository
+1. Run `pdm setup` command locally to setup development environment
+
+> [!IMPORTANT]
+> For more details read the
+> [documentation](https://open-nudge.github.io/opentemplate/template/quickstart/installation)
+
+### Usage
+
+1. Create a new branch
+1. Optionally add dependencies to `pyproject.toml`
+1. Write code in `/src/<project_name>` and tests in `/tests`
+1. Use `git add`, `git commit` and `git push` your changes
+1. `pre-commit` will guide you through the process
+
+> [!IMPORTANT]
+> For more details read the
+> [documentation](https://open-nudge.github.io/opentemplate/template/quickstart/usage)
+
+### Examples
+
+<details>
+  <summary><b><big>Run checkers or fixers manually</big></b> (click me)</summary>
+&nbsp;
+
+```sh
+> pdm check-<group> # pdm fix-<group>
+```
+
+Note that all `check` and `fix` commands are grouped for your convenience:
+
+```sh
+> pdm check-all # pdm fix-all
+```
+
+</details>
+
+<details>
+  <summary><b><big>Adjust template</big></b> (click me)</summary>
+&nbsp;
+
+> Most of the adjustments can be done by __only__ editing `pyproject.toml`
+
+Common changes to `pyproject.toml`:
+
+- Add dev dependencies under `[dependency-groups]`
+    (everything is named `dev-<group>`)
+- Modify `[tool.pdm.scripts]` for custom command
+    (`check-<group>` or `fix-<group>`, the latter modifies files)
+- Use `[tool.<name>]` to adjust specific tool configuration
+
+> __Adjusting these sections will affect `pre-commit` and `GitHub Actions`__
+
+</details>
+
+<details>
+  <summary><b><big>Disable some pre-commit check</big></b> (click me)</summary>
+&nbsp;
+
+> Disabling checks should be done cautiously!
+
+`pre-commit` checks are defined in `.pre-commit-config.yaml`.
+
+Disable a check using `SKIP` environment variable:
+
+```sh
+SKIP='<group1>,<group2>` git commit -m <message>
+```
+
+For details, refer to the `id` fields in `.pre-commit-config.yaml`.
+
+> Some commands have both `<group>-fix` and `<group>-check`
+> for different actions!
+
+</details>
+
+<!-- mkdocs remove start -->
+
+## Contribute
+
+We welcome your contributions! Start here:
+
+- [Code of Conduct](/CODE_OF_CONDUCT.md)
+- [Contributing Guide](/CONTRIBUTING.md)
+- [Roadmap](/ROADMAP.md)
+- [Changelog](/CHANGELOG.md)
+- [Report security vulnerabilities](/SECURITY.md)
+- [Open an Issue](https://github.com/open-nudge/opentemplate/issues)
+
+## Legal
+
+- This project is licensed under the _Apache 2.0 License_ - see
+    the [LICENSE](/LICENSE.md) file for details.
+- This project is copyrighted by _open-nudge_ - the
+    appropriate copyright notice is included in each file.
+
+<!-- mkdocs remove end -->
+
+<!-- md-dead-link-check: on -->

opentemplate-0.0.1/README.md

@@ -0,0 +1,183 @@
+<!--
+SPDX-FileCopyrightText: © 2025 open-nudge <https://github.com/open-nudge>
+SPDX-FileContributor: szymonmaszke <github@maszke.co>
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# opentemplate
+
+<!-- mkdocs remove start -->
+
+<!-- vale off -->
+
+<!-- pyml disable-num-lines 30 line-length-->
+
+<p align="center">
+    <em>The simplest to use, yet the most comprehensive Python template</em>
+</p>
+
+<div align="center">
+
+<a href="https://pypi.org/project/opentemplate">![PyPI - Python Version](https://img.shields.io/pypi/v/opentemplate?style=for-the-badge&label=release&labelColor=grey&color=blue)
+</a>
+<a href="https://pypi.org/project/opentemplate">![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fopen-nudge%2Fopentemplate%2Fmain%2Fpyproject.toml&style=for-the-badge&label=python&labelColor=grey&color=blue)
+</a>
+<a href="https://opensource.org/licenses/Apache-2.0">![License](https://img.shields.io/badge/License-Apache_2.0-blue?style=for-the-badge)
+</a>
+<a>![Coverage Hardcoded](https://img.shields.io/badge/coverage-100%25-green?style=for-the-badge)
+</a>
+<a href="https://scorecard.dev/viewer/?uri=github.com/open-nudge/opentemplate">![OSSF-Scorecard Score](https://img.shields.io/ossf-scorecard/github.com/open-nudge/opentemplate?style=for-the-badge&label=OSSF)
+</a>
+
+</div>
+
+<p align="center">
+✨ <a href="#features">Features</a>
+🚀 <a href="#quick-start">Quick start</a>
+📚 <a href="https://open-nudge.github.io/opentemplate">Documentation</a>
+🤝 <a href="#contribute">Contribute</a>
+👍 <a href="https://github.com/open-nudge/opentemplate/blob/main/ADOPTERS.md">Adopters</a>
+📜 <a href="#legal">Legal</a>
+</p>
+<!-- vale on -->
+
+______________________________________________________________________
+
+<!-- mkdocs remove end -->
+
+## Features
+
+__opentemplate__ is a Python template with the following features:
+
+- [__Truly open source__](https://open-nudge.github.io/opentemplate/template/about/philosophy):
+    no tokens, no fees, no premium plans, open source software only
+- [__Ease of use__](https://open-nudge.github.io/opentemplate/template/quickstart/usage):
+    clone templated repo, run `pdm setup` and __focus on your code__
+- [__Consistency__](https://open-nudge.github.io/opentemplate/template/configuration/basic):
+    `pre-commit` and `GitHub Actions` share the same config (`pyproject.toml`)
+- [__Security__](https://open-nudge.github.io/opentemplate/template/details/security):
+    [SLSA](https://slsa.dev/) L3+ (public/enterprise) or L2 (private),
+    [OSSF Best Practices](https://github.com/ossf/scorecard)
+- [__Batteries included__](https://open-nudge.github.io/opentemplate/template/details):
+    multiple checkers for Python, YAML, Markdown, prose, etc.
+- [__Performance__](https://open-nudge.github.io/opentemplate/template/details/github-actions):
+    Parallel checks, builds, minimally-sized caches and checkouts
+
+## Quick start
+
+### Installation
+
+> [!NOTE]
+> [Install `pdm`](https://pdm-project.org/en/latest/#recommended-installation-method)
+> (if you don't have it already), for Linux/MacOS:
+
+```sh
+curl -sSL https://pdm-project.org/install-pdm.py | python3 -
+```
+
+1. Create a new GitHub repository using this template
+    (green `Use this template` button)
+1. Name your repo (__use underscore `_`, not hyphens `-`__)
+1. Add project description (__necessary!__)
+1. __Wait until the setup commit appears__
+    (performed by `github-actions[bot]`, it may take a few minutes)
+1. Clone the repository
+1. Run `pdm setup` command locally to setup development environment
+
+> [!IMPORTANT]
+> For more details read the
+> [documentation](https://open-nudge.github.io/opentemplate/template/quickstart/installation)
+
+### Usage
+
+1. Create a new branch
+1. Optionally add dependencies to `pyproject.toml`
+1. Write code in `/src/<project_name>` and tests in `/tests`
+1. Use `git add`, `git commit` and `git push` your changes
+1. `pre-commit` will guide you through the process
+
+> [!IMPORTANT]
+> For more details read the
+> [documentation](https://open-nudge.github.io/opentemplate/template/quickstart/usage)
+
+### Examples
+
+<details>
+  <summary><b><big>Run checkers or fixers manually</big></b> (click me)</summary>
+&nbsp;
+
+```sh
+> pdm check-<group> # pdm fix-<group>
+```
+
+Note that all `check` and `fix` commands are grouped for your convenience:
+
+```sh
+> pdm check-all # pdm fix-all
+```
+
+</details>
+
+<details>
+  <summary><b><big>Adjust template</big></b> (click me)</summary>
+&nbsp;
+
+> Most of the adjustments can be done by __only__ editing `pyproject.toml`
+
+Common changes to `pyproject.toml`:
+
+- Add dev dependencies under `[dependency-groups]`
+    (everything is named `dev-<group>`)
+- Modify `[tool.pdm.scripts]` for custom command
+    (`check-<group>` or `fix-<group>`, the latter modifies files)
+- Use `[tool.<name>]` to adjust specific tool configuration
+
+> __Adjusting these sections will affect `pre-commit` and `GitHub Actions`__
+
+</details>
+
+<details>
+  <summary><b><big>Disable some pre-commit check</big></b> (click me)</summary>
+&nbsp;
+
+> Disabling checks should be done cautiously!
+
+`pre-commit` checks are defined in `.pre-commit-config.yaml`.
+
+Disable a check using `SKIP` environment variable:
+
+```sh
+SKIP='<group1>,<group2>` git commit -m <message>
+```
+
+For details, refer to the `id` fields in `.pre-commit-config.yaml`.
+
+> Some commands have both `<group>-fix` and `<group>-check`
+> for different actions!
+
+</details>
+
+<!-- mkdocs remove start -->
+
+## Contribute
+
+We welcome your contributions! Start here:
+
+- [Code of Conduct](/CODE_OF_CONDUCT.md)
+- [Contributing Guide](/CONTRIBUTING.md)
+- [Roadmap](/ROADMAP.md)
+- [Changelog](/CHANGELOG.md)
+- [Report security vulnerabilities](/SECURITY.md)
+- [Open an Issue](https://github.com/open-nudge/opentemplate/issues)
+
+## Legal
+
+- This project is licensed under the _Apache 2.0 License_ - see
+    the [LICENSE](/LICENSE.md) file for details.
+- This project is copyrighted by _open-nudge_ - the
+    appropriate copyright notice is included in each file.
+
+<!-- mkdocs remove end -->
+
+<!-- md-dead-link-check: on -->

opentemplate-0.0.1/pyproject.toml

@@ -0,0 +1,746 @@
+[build-system]
+build-backend = "pdm.backend"
+requires = [
+    "commition[pdm]>=0.0.1",
+    "pdm-backend>=2",
+]
+
+[project]
+name = "opentemplate"
+description = "The simplest to use, yet the most comprehensive Python template"
+readme = "README.md"
+license = "Apache-2.0"
+maintainers = [
+    { name = "open-nudge" },
+]
+authors = [
+    { name = "open-nudge" },
+]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dynamic = []
+dependencies = []
+version = "0.0.1"
+
+[project.urls]
+Changelog = "https://github.com/open-nudge/opentemplate/blob/master/CHANGELOG.md"
+Documentation = "https://open-nudge.github.io/opentemplate"
+Homepage = "https://open-nudge.github.io/opentemplate"
+Issues = "https://github.com/open-nudge/opentemplate/issues"
+Repository = "https://github.com/open-nudge/opentemplate"
+
+[dependency-groups]
+dev-tests = [
+    "coverage>=7",
+    "hypothesis>=6",
+    "pytest>=8",
+    "pytest-asyncio>=1",
+    "pytest-html>=4",
+    "pytest-pretty-terminal>=1",
+    "pytest-randomly>=3",
+]
+dev-docs = [
+    "cairosvg>=2",
+    "markdown>=3",
+    "mike>=2",
+    "mkdocs-awesome-nav>=3",
+    "mkdocs-gen-files>=0.5.0",
+    "mkdocs-git-revision-date-localized-plugin>=1",
+    "mkdocs-github-admonitions-plugin>=0.0.3",
+    "mkdocs-jupyter>=0.25.1",
+    "mkdocs-link-marker>=0.1.3",
+    "mkdocs-literate-nav>=0.6.0",
+    "mkdocs-material>=9",
+    "mkdocs-minify-plugin>=0.8.0",
+    "mkdocs-open-in-new-tab>=1",
+    "mkdocs-redirects>=1",
+    "mkdocs-section-index>=0.3.4",
+    "mkdocstrings>=0.25.0",
+    "mkdocstrings-python>=1",
+    "pillow>=10",
+    "pygments>=2",
+    "pymdown-extensions>=10",
+    "termynal>=0.12.1",
+]
+dev-python = [
+    "fawltydeps>=0.17.0",
+    "interrogate>=1",
+    "ruff>=0.5.6",
+]
+dev-typing = [
+    "basedpyright>=1.28.1",
+]
+dev-shell = [
+    "shellcheck-py>=0.10.0",
+]
+dev-yaml = [
+    "yamllint>=1",
+]
+dev-markdown = [
+    "md-dead-link-check>=1.2.0",
+    "mdformat>=0.7.19",
+    "mdformat_frontmatter>=2",
+    "mdformat_footnote>=0.1.1",
+    "mdformat-gfm>=0.3.7",
+    "mdformat_gfm_alerts>=1",
+    "mdformat-mkdocs>=4",
+    "pymarkdownlnt>=0.9.21",
+]
+dev-ini = [
+    "pyinilint>=0.17",
+]
+dev-pyproject = [
+    "validate-pyproject>=0.18",
+]
+dev-code = [
+    "editorconfig-checker>=3",
+    "codespell>=2",
+]
+dev-citation = [
+    "cffconvert @ git+https://github.com/citation-file-format/cffconvert@b6045d78aac9e02b039703b030588d54d53262ac",
+]
+dev-security = [
+    "semgrep>=1; platform_system!='Windows' and python_version=='3.11'",
+]
+dev-github = [
+    "zizmor>=1",
+    "check-jsonschema>=0.31.2",
+]
+dev-legal = [
+    "reuse>=4",
+]
+dev-release = [
+    "spdx-tools>=0.8.3",
+    "cyclonedx-bom>=4",
+    "git-cliff>=2",
+    "reuse>=4",
+]
+dev-generation = [
+    "cogapp>=3",
+    "cogeol>=0.0.1",
+]
+dev-commit = [
+    "conventional-pre-commit>=4",
+]
+dev-pre-commit = [
+    "pre-commit>=3",
+]
+dev-all = [
+    { include-group = "dev-tests" },
+    { include-group = "dev-docs" },
+    { include-group = "dev-python" },
+    { include-group = "dev-typing" },
+    { include-group = "dev-shell" },
+    { include-group = "dev-yaml" },
+    { include-group = "dev-markdown" },
+    { include-group = "dev-ini" },
+    { include-group = "dev-pyproject" },
+    { include-group = "dev-code" },
+    { include-group = "dev-citation" },
+    { include-group = "dev-security" },
+    { include-group = "dev-github" },
+    { include-group = "dev-legal" },
+    { include-group = "dev-release" },
+    { include-group = "dev-generation" },
+    { include-group = "dev-commit" },
+    { include-group = "dev-pre-commit" },
+]
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.version]
+source = "call"
+getter = "commition.plugin.pdm:git"
+
+[tool.pdm.scripts]
+check-typing = "basedpyright --stats"
+check-shell = "shellcheck -x -S style -o all"
+check-ini = "pyinilint"
+check-citation = "cffconvert --validate -i {args:CITATION.cff}"
+check-docs = "mkdocs build"
+check-pre-commit-config = "pre-commit validate-config {args:.pre-commit-config.yaml}"
+check-pre-commit-hooks = "pre-commit validate-manifest {args:.pre-commit-hooks.yaml}"
+check-github = "zizmor --persona auditor --verbose {args:.}"
+check-legal = "reuse lint"
+lock = "pdm lock -G:all"
+pre-commit-all = "pre-commit run {args:''} --all-files"
+check-commit = "conventional-pre-commit --strict --scopes '' feat fix feat! fix!"
+
+[tool.pdm.scripts.tests]
+composite = [
+    "pdm run coverage run -m pytest -x --pretty {args:tests}",
+    "pdm run coverage report",
+]
+
+[tool.pdm.scripts.tests-all]
+composite = [
+    "setup-environment",
+    "pdm install --prod -G:all --no-editable",
+    "pdm install -G dev-tests --no-editable",
+    "pdm use 3.13",
+    "pdm run tests {args:tests}",
+    "pdm use 3.12",
+    "pdm run tests {args:tests}",
+    "pdm use 3.11",
+    "pdm run tests {args:tests}",
+]
+
+[tool.pdm.scripts.check-python]
+composite = [
+    "fawltydeps --detailed --code {args:.}",
+    "ruff format --check {args:.}",
+    "ruff check {args:.}",
+    "interrogate {args:.}",
+]
+
+[tool.pdm.scripts.fix-python]
+composite = [
+    "fawltydeps --detailed --code {args:.}",
+    "ruff format {args:.}",
+    "ruff check --fix {args:.}",
+    "interrogate {args:.}",
+]
+
+[tool.pdm.scripts.fix-shell]
+shell = "pdm run shellcheck -x -S style -o all {args} | git apply --allow-empty"
+
+[tool.pdm.scripts.check-yaml]
+composite = [
+    "yamllint {args:.}",
+]
+
+[tool.pdm.scripts.check-markdown]
+composite = [
+    "mdformat --check {args:.}",
+    "pymarkdownlnt scan -r {args:.}",
+    "md-dead-link-check {args:.}",
+]
+
+[tool.pdm.scripts.fix-markdown]
+composite = [
+    "mdformat {args:.}",
+    "pymarkdownlnt fix -r {args:.}",
+    "pymarkdownlnt scan -r {args:.}",
+    "md-dead-link-check {args:.}",
+]
+
+[tool.pdm.scripts.check-pyproject]
+composite = [
+    "validate-pyproject {args:pyproject.toml}",
+]
+
+[tool.pdm.scripts.check-code]
+composite = [
+    "codespell {args:.}",
+    "ec",
+]
+
+[tool.pdm.scripts.fix-code]
+composite = [
+    "codespell --write-changes {args:.}",
+    "ec",
+]
+
+[tool.pdm.scripts.check-security]
+cmd = [
+    "semgrep",
+    "scan",
+    "--config=p/python",
+    "--config=p/secrets",
+    "--config=p/security-audit",
+    "--config=p/ci",
+    "--config=p/github-actions",
+    "--config=p/bandit",
+    "--config=p/gitleaks",
+    "--error",
+    "--metrics=off",
+    "--severity=INFO",
+    "--strict",
+    "{args:.}",
+]
+
+[tool.pdm.scripts.check-renovate]
+cmd = [
+    "check-jsonschema",
+    "--builtin-schema",
+    "vendor.renovate",
+    "{args:./.github/renovate.json}",
+]
+
+[tool.pdm.scripts.check-github-actions]
+composite = [
+    "check-jsonschema --verbose --builtin-schema vendor.github-actions",
+]
+
+[tool.pdm.scripts.check-github-workflows]
+composite = [
+    "check-jsonschema --verbose --builtin-schema github-workflows-require-timeout",
+    "check-jsonschema --verbose --builtin-schema github-workflows",
+]
+
+[tool.pdm.scripts.fix-legal]
+shell = "  bash -c \"pdm run reuse annotate --license='$(basename $(readlink -f LICENSE.md) .txt)' --copyright='open-nudge <https://github.com/open-nudge>' --contributor='$(git config get user.name) <$(git config get user.email)>' --copyright-prefix=spdx-symbol --merge-copyrights --recursive --fallback-dot-license {args:.}\"\n"
+
+[tool.pdm.scripts.check-generation]
+cmd = [
+    "cog",
+    "-c",
+    "--check",
+    "{args:\n  pyproject.toml\n  ./.github/workflows/cache-item-reusable.yml\n  ./.github/workflows/cache-reusable.yml\n  ./.github/workflows/run-reusable.yml\n  ./.github/workflows/tests-reusable.yml\n  ./.github/workflows/release-sbom-attest-reusable.yml\n  ./.github/workflows/release-sbom-run-reusable.yml\n  ./.github/workflows/release-sboms-reusable.yml\n  }\n  ",
+]
+
+[tool.pdm.scripts.fix-generation]
+cmd = [
+    "cog",
+    "-c",
+    "-r",
+    "{args:\n  pyproject.toml\n  ./.github/workflows/cache-item-reusable.yml\n  ./.github/workflows/cache-reusable.yml\n  ./.github/workflows/run-reusable.yml\n  ./.github/workflows/tests-reusable.yml\n  ./.github/workflows/release-sbom-attest-reusable.yml\n  ./.github/workflows/release-sbom-run-reusable.yml\n  ./.github/workflows/release-sboms-reusable.yml\n  }\n  ",
+]
+
+[tool.pdm.scripts.check-all]
+composite = [
+    "check-generation",
+    "check-citation",
+    "check-markdown",
+    "check-yaml",
+    "check-pre-commit",
+    "check-pyproject",
+    "check-legal",
+    "check-workflows",
+    "check-security",
+    "check-docs",
+    "check-python",
+]
+
+[tool.pdm.scripts.fix-all]
+composite = [
+    "fix-generation",
+    "check-citation",
+    "fix-markdown",
+    "check-yaml",
+    "check-pre-commit",
+    "fix-pyproject",
+    "fix-legal",
+    "check-legal",
+    "check-workflows",
+    "check-security",
+    "check-docs",
+    "fix-python",
+]
+
+[tool.pdm.scripts.setup-environment]
+composite = [
+    "pdm self update",
+    "pdm python install 3.13",
+    "pdm python install 3.12",
+    "pdm python install 3.11",
+    "pdm use 3.13",
+    "pdm install --prod -G:all --no-editable",
+    "pdm install -G dev-tests --no-editable",
+    "pdm use 3.12",
+    "pdm install --prod -G:all --no-editable",
+    "pdm install -G dev-tests --no-editable",
+    "pdm use 3.11",
+]
+
+[tool.pdm.scripts.setup]
+composite = [
+    "setup-environment",
+    "pdm install -G:all --no-editable",
+    "pdm run pre-commit install --install-hooks",
+]
+
+[tool.pdm.scripts.sbom-python]
+shell = "  bash -c 'pdm run cyclonedx-py environment $(pdm info --python) --PEP-639 --mc-type library --schema-version 1.6'\n"
+
+[tool.pdm.scripts.sbom-legal]
+shell = "  bash -c \" pdm run reuse spdx --add-license-concluded --creator-organization='open-nudge <https://github.com/open-nudge>' --creator-person='$(git config get user.name) <$(git config get user.email)>' > .sbom-legal.spdx && pdm run pyspdxtools --version \"SPDX-2.2\" --novalidation -i .sbom-legal.spdx -o .sbom-legal.json && ( cat .sbom-legal.json && rm .sbom-legal.spdx .sbom-legal.json )\"\n"
+
+[tool.pdm.scripts.sbom-all]
+composite = [
+    "sbom-python",
+    "sbom-legal",
+]
+
+[tool.pdm.scripts.changelog]
+cmd = "pdm run git-cliff"
+
+[tool.pdm.scripts.changelog-latest]
+cmd = "pdm run git-cliff --latest"
+
+[tool.pdm.scripts.check-release]
+composite = [
+    "sbom-all",
+    "changelog",
+    "changelog-latest",
+    "pdm build",
+]
+
+[tool.pdm.scripts.commit]
+shell = "echo \"By committing to this repository, you agree to the Developer Certificate of Origin (DCO).\"\nprintf \"See here: https://developercertificate.org/ for more information.\n\"\ngit commit --signoff --gpg-sign\n"
+
+[tool.pdm.scripts.commit-type]
+shell = "echo \"By committing to this repository, you agree to the Developer Certificate of Origin (DCO).\"\nprintf \"See here: https://developercertificate.org/ for more information.\n\"\n\noptions=(\"fix\" \"feat\" \"fix!\" \"feat!\")\nPS3=\"Select commit type (1-4) or Quit (5): \"\nselect opt in \"${options[@]}\" \"Quit\"; do\n    case \"$REPLY\" in\n    1) break;;\n    2) break;;\n    3) break;;\n    4) break;;\n    5) exit 0; break;;\n    *) echo \"Invalid option.\"; continue;;\n    esac\ndone\n\nread -r -p \"\nCommit title message: \" title\n\necho \"\nYour commit will be: '$opt: $title'\n\"\n\ngit commit -S --signoff -m \"$opt: $title\"\n"
+
+[tool.pdm.scripts.commit-guided]
+shell = "echo \"By committing to this repository, you agree to the Developer Certificate of Origin (DCO).\"\nprintf \"See here: https://developercertificate.org/ for more information.\n\"\n\necho \"Please provide commit type (one of fix/feat/fix!/feat!):\"\necho \"- fix: A bug fix (not breaking backward compatibility).\"\necho \"- feat: A new feature (not breaking backward compatibility).\"\necho \"- fix!: A bug fix (breaking backward compatibility).\"\necho \"- feat!: A new feature (breaking backward compatibility).\"\necho \"\"\n\noptions=(\"fix\" \"feat\" \"fix!\" \"feat!\")\nPS3=\"Select commit type (1-4) or Quit (5): \"\nselect opt in \"${options[@]}\" \"Quit\"; do\n    case \"$REPLY\" in\n    1) break;;\n    2) break;;\n    3) break;;\n    4) break;;\n    5) exit 0; break;;\n    *) echo \"Invalid option.\";continue;;\n    esac\ndone\n\nprintf \"\nYou picked %s type.\n\" \"$opt\"\n\necho \"Please provide commit title message:\"\necho \"- Use the imperative, present tense: 'change' not 'changed' nor 'changes'\"\necho \"- Short (72 chars or less) informative summary of changes\"\necho \"- Lowercase\"\necho \"- No dot at the end\n\"\necho \"Example: 'add performance tests'\n\"\n\nread -r -p \"Commit title message: \" title\n\necho \"\nYour commit will be: '$opt: $title'\n\"\n\nread -p \"Would you like to make this commit? (Y/N): \" confirm && [[ $confirm == [yY] || $confirm == [yY][eE][sS] ]] || exit 1\n\ngit commit -S --signoff -m \"$opt: $title\"\n"
+
+[tool.ruff]
+line-length = 80
+src = [
+    "src",
+    "test",
+]
+extend-exclude = [
+    ".pdm-plugins",
+]
+unsafe-fixes = false
+show-fixes = true
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = [
+    "ALL",
+]
+extend-ignore = [
+    "ANN401",
+    "COM812",
+    "ISC001",
+    "TID252",
+]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/**.py" = [
+    "INP001",
+    "S101",
+]
+"template-setup/overwrite/tests/**.py" = [
+    "INP001",
+    "S101",
+]
+
+[tool.ruff.lint.flake8-bandit]
+check-typed-exception = true
+
+[tool.ruff.lint.flake8-boolean-trap]
+extend-allowed-calls = [
+    "django.db.models.Value",
+    "pydantic.Field",
+]
+
+[tool.ruff.lint.flake8-builtins]
+builtins-allowed-modules = [
+    "id",
+]
+
+[tool.ruff.lint.flake8-import-conventions]
+banned-from = [
+    "numpy",
+    "pandas",
+    "polars",
+    "typing",
+]
+
+[tool.ruff.lint.flake8-pytest-style]
+parametrize-values-type = "tuple"
+
+[tool.ruff.lint.flake8-type-checking]
+strict = true
+
+[tool.ruff.lint.isort]
+detect-same-package = false
+lines-between-types = 1
+required-imports = [
+    "from __future__ import annotations",
+]
+section-order = [
+    "future",
+    "standard-library",
+    "third-party",
+    "ml",
+    "testing",
+    "first-party",
+    "local-folder",
+]
+
+[tool.ruff.lint.isort.sections]
+ml = [
+    "pandas",
+    "numpy",
+    "polars",
+    "matplotlib",
+    "seaborn",
+    "scipy",
+    "sklearn",
+    "statsmodels",
+    "nltk",
+    "spacy",
+    "gensim",
+    "tensorflow",
+    "torch",
+    "pytorch-lightning",
+    "lightning",
+    "coremltools",
+    "torchmetrics",
+    "xgboost",
+    "lightgbm",
+    "catboost",
+    "fastai",
+    "mlflow",
+    "neptune",
+    "dvc",
+    "wandb",
+    "dask",
+    "pyspark",
+]
+testing = [
+    "pytest*",
+    "hypothesis",
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 6
+
+[tool.ruff.lint.pep8-naming]
+classmethod-decorators = [
+    "pydantic.validator",
+]
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 80
+max-line-length = 120
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+ignore-decorators = [
+    "typing.overload",
+]
+
+[tool.ruff.lint.pylint]
+max-branches = 6
+max-locals = 10
+max-nested-blocks = 3
+max-public-methods = 10
+max-returns = 5
+max-statements = 20
+
+[tool.codespell]
+skip = "*pdm.lock,*__pypackages__/*"
+ignore-words-list = "intoto"
+check-filenames = true
+interactive = 0
+
+[tool.coverage.run]
+branch = true
+relative_files = true
+source = [
+    "src",
+    "tests",
+]
+source_pkgs = [
+    "opentemplate",
+]
+omit = [
+    "src/opentemplate/**",
+]
+
+[tool.coverage.paths]
+source = [
+    "src/opentemplate",
+    "**/opentemplate",
+]
+
+[tool.coverage.report]
+exclude_also = [
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "if typing.TYPE_CHECKING:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]
+fail_under = 100
+precision = 2
+show_missing = true
+skip_empty = true
+
+[tool.fawltydeps]
+ignore_undeclared = [
+    "mkdocs_gen_files",
+    "pytest",
+    "hypothesis",
+    "opentemplate",
+]
+ignore_unused = [
+    "basedpyright",
+    "cairosvg",
+    "cffconvert",
+    "check-jsonschema",
+    "cogapp",
+    "cogeol",
+    "conventional-pre-commit",
+    "coverage",
+    "cyclonedx-bom",
+    "editorconfig-checker",
+    "git-cliff",
+    "hypothesis",
+    "interrogate",
+    "markdown",
+    "md-dead-link-check",
+    "mdformat",
+    "mdformat-gfm",
+    "mdformat_footnote",
+    "mdformat_frontmatter",
+    "semgrep",
+    "shellcheck-py",
+    "termynal",
+    "validate-pyproject",
+    "yamllint",
+    "zizmor",
+    "codespell",
+    "fawltydeps",
+    "mdformat-mkdocs",
+    "mdformat_gfm_alerts",
+    "mike",
+    "mkdocs-awesome-nav",
+    "mkdocs-gen-files",
+    "mkdocs-git-revision-date-localized-plugin",
+    "mkdocs-github-admonitions-plugin",
+    "mkdocs-jupyter",
+    "mkdocs-link-marker",
+    "mkdocs-literate-nav",
+    "mkdocs-material",
+    "mkdocs-minify-plugin",
+    "mkdocs-open-in-new-tab",
+    "mkdocs-redirects",
+    "mkdocs-section-index",
+    "mkdocstrings",
+    "mkdocstrings-python",
+    "pillow",
+    "pre-commit",
+    "pygments",
+    "pyinilint",
+    "pymarkdownlnt",
+    "pymdown-extensions",
+    "pytest",
+    "pytest-asyncio",
+    "pytest-html",
+    "pytest-pretty-terminal",
+    "pytest-randomly",
+    "reuse",
+    "ruff",
+    "spdx-tools",
+]
+
+[tool.interrogate]
+verbose = 1
+style = "google"
+fail-under = 100
+exclude = [
+    "build",
+    "test",
+    ".pdm-plugins",
+]
+
+[tool.basedpyright]
+exclude = [
+    "**/node_modules",
+    "**/__pycache__",
+    "**/.*",
+    "**/__pypackages__",
+    "site/*",
+    "docs/scripts/gen_ref_pages.py",
+    "docs/scripts/preprocess_files.py",
+]
+pythonPlatform = "All"
+pythonVersion = "3.11"
+failOnWarnings = true
+analyzeUnannotatedFunctions = true
+deprecateTypingAliases = true
+strictGenericNarrowing = true
+typeCheckingMode = "all"
+reportAny = "none"
+reportUnknownVariableType = "none"
+reportUnknownMemberType = "none"
+reportMissingTypeStubs = "none"
+reportPrivateLocalImportUsage = "none"
+reportPrivateImportUsage = "none"
+extraPaths = [
+    "__pypackages__/3.11/lib",
+]
+
+[tool.pymarkdown.plugins.md007]
+enabled = false
+
+[tool.pymarkdown.plugins.md028]
+enabled = false
+
+[tool.pymarkdown.plugins.md033]
+enabled = false
+
+[tool.pymarkdown.plugins.md034]
+enabled = false
+
+[tool.pymarkdown.plugins.md041]
+enabled = false
+
+[tool.pymarkdown.plugins.md042]
+enabled = false
+
+[tool.md_dead_link_check]
+exclude_links = [
+    "https://github.com/open-nudge/opentemplate*",
+    "https://open-nudge.github.io/opentemplate*",
+    "/LICENSE.md",
+    "https://open-nudge.github.io*",
+    "templateskip",
+]
+exclude_files = [
+    "template-setup/overwrite/*",
+    "pypackages/*",
+]
+
+[tool.commition]
+include_paths = [
+    "src/*",
+    "pyproject.toml",
+]
+exclude_commiters = [
+    "github-actions[bot]",
+]
+
+[tool.git-cliff.changelog]
+header = ""
+body = "{%- macro remote_url() -%}\n  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\n{%- endmacro -%}\n\n{%- if version -%}\n  {% if previous.version %}\n    # [{{ version | trim_start_matches(pat=\"v\") }}]({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }} ([vs HEAD]({{ self::remote_url() }}/compare/{{ version }}..HEAD))\n  {%- else -%}\n    # {{ version | trim_start_matches(pat=\"v\") }} - {{ timestamp | date(format=\"%Y-%m-%d\") }} ([vs HEAD]({{ self::remote_url() }}/compare/{{ version }}..HEAD))\n  {%- endif %}\n{%- else -%}\n# Untagged ([vs HEAD]({{ self::remote_url() }}/compare/..HEAD))\n{%- endif %}\n\n__Commits by type__\n\n{% set total = commits | length -%}\n\n{%- set human = self::count_commits(commits=commits, bot=false) -%}\n{%- set bot = self::count_commits(commits=commits, bot=true) -%}\n\n{%- set python = self::count_commits(commits=commits, label=\"python\") -%}\n{%- set other = self::count_commits(commits=commits, label=\"python\", contains=false) -%}\n\nTotal | Human | Bots | Python | Other\n:---: | :---: | :---:|  :---: | :---:\n{{ total }} | {{ human }} | {{ bot }} | {{ python }} | {{ other }}\n\n__Commits by labels__\n\n{% set security = self::count_commits(commits=commits, label=\"security\") -%}\n{%- set tests = self::count_commits(commits=commits, label=\"tests\") -%}\n{%- set legal = self::count_commits(commits=commits, label=\"legal\") -%}\n{%- set docs = self::count_commits(commits=commits, label=\"docs\") -%}\n{%- set actions = self::count_commits(commits=commits, label=\"actions\") -%}\n{%- set deps = self::count_commits(commits=commits, label=\"deps\") -%}\n{%- set config = self::count_commits(commits=commits, label=\"config\") -%}\n\nSecurity | Tests | Legal | Docs | Actions | Config | Dependencies |\n  :---:  | :---: | :---: | :---:|  :---:  |  :---: |    :---:     |\n{{ security }} | {{ tests }} | {{ legal }} | {{ docs }} | {{ actions }} | {{ config }} | {{ deps }}\n\n{% set python_data = [python, \"Python\", true, get_env(name=\"PYTHON_PACKAGE_VERSION\", default=\"\")] -%}\n{%- set other_data = [other, \"Other\", false, \"\"] -%}\n{%- set data = [python_data, other_data] -%}\n\n{%- for item in data%}\n  {%- if item[0] != \"0\" -%}\n    ## {{ item[1] }} ({% if item[3] %}v{{ item[3] }}, {% endif %}{{ item[0] }} commits)\n    {{- self::display(\n      commits=commits | filter(attribute=\"breaking\", value=true),\n      header=\"Breaking changes\",\n      python=item[2],\n      display_group=true,\n    )-}}\n    {{- self::display(\n      commits=commits | filter(attribute=\"breaking\", value=false) | filter(attribute=\"group\", value=\"feat\"),\n      header=\"Features\",\n      python=item[2],\n    )-}}\n    {{- self::display(\n      commits=commits | filter(attribute=\"breaking\", value=false) | filter(attribute=\"group\", value=\"fix\"),\n      header=\"Fixes\",\n      python=item[2],\n    )-}}\n    {{- self::display(\n      commits=commits,\n      header=\"Bots\",\n      python=item[2],\n      display_group=true,\n      bot=true,\n    )-}}\n  {% endif -%}\n{% endfor %}\n\n{%- macro count_commits(commits, label=false, bot=\"ignore\", contains=true) -%}\n  {% set counter = 0 %}\n  {%- for commit in commits %}\n    {%- if\n      (\n        not label or\n        (\n          (contains and commit.remote.pr_labels and label in commit.remote.pr_labels)\n          or\n          (not contains and commit.remote.pr_labels and label not in commit.remote.pr_labels)\n        )\n      )\n      and\n      (\n        bot == \"ignore\"\n        or\n        (not bot and not \"[bot]\" in commit.author.name)\n        or\n        (bot and \"[bot]\" in commit.author.name)\n      )\n    -%}\n      {%- set_global counter = counter + 1 -%}\n    {%- endif -%}\n  {%- endfor -%}\n  {{- counter -}}\n{%- endmacro -%}\n\n{%- macro display(commits, header, python, bot=false, display_group=false) -%}\n  {%- set n_commits = self::count_commits(\n    commits=commits,\n    label=\"python\",\n    bot=bot,\n    contains=python,\n  ) -%}\n  {%- if n_commits != \"0\" %}\n\n    ### {{ header }} ({{ n_commits }} commits)\n\n  {% endif -%}\n  {%- for commit in commits -%}\n    {%- if\n      (\n        python == \"ignore\"\n        or\n        (python and commit.remote.pr_labels and \"python\" in commit.remote.pr_labels)\n        or\n        (not python and commit.remote.pr_labels and \"python\" not in commit.remote.pr_labels)\n      )\n      and\n      (\n        bot == \"ignore\"\n        or\n        (bot and \"[bot]\" in commit.author.name)\n        or\n        (not bot and not \"[bot]\" in commit.author.name)\n      )\n    -%}\n      - {% if display_group -%}\n        {% if commit.group == \"feat\" -%}[FEATURE] {% elif commit.group == \"fix\" -%}[FIX] {% else -%}[?] {% endif -%}\n      {%- endif -%}\n      {{ commit.message | split(pat=\"\n\") | first | upper_first | trim }} {% if commit.remote.username -%}\n        (by [__@{{ commit.remote.username }}__](https://github.com/{{ commit.remote.username }})) {% elif \"[bot]\" in commit.author.name -%}\n        (by __@{{ commit.author.name }}__ [BOT]) {% elif commit.author.name -%}\n        (by __@{{ commit.author.name }}__) {% endif -%}\n      {% if commit.remote.pr_number -%}\n        ([#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}))\n      {%- endif %}\n      {%- if commit.remote.pr_labels and commit.remote.pr_labels | length > 0 %}\n        {%- for label in commit.remote.pr_labels -%}\n          {%- if label == \"security\" %} [SECURITY]\n          {%- elif label == \"tests\" %} [TESTS]\n          {%- elif label == \"legal\" %} [LEGAL]\n          {%- elif label == \"docs\" %} [DOCS]\n          {%- elif label == \"actions\" %} [ACTIONS]\n          {%- elif label == \"config\" %} [CONFIG]\n          {%- elif label == \"deps\" %} [DEPS]\n          {%- endif -%}\n        {%- endfor %}\n      {%- endif %}\n    {%- endif %}\n  {% endfor -%}\n{%- endmacro -%}\n"
+footer = ""
+trim = true
+
+[tool.git-cliff.git]
+conventional_commits = true
+filter_unconventional = true
+commit_parsers = [
+    { message = "^feat", group = "feat" },
+    { message = "^fix", group = "fix" },
+]
+filter_commits = true
+topo_order = false
+sort_commits = "oldest"

opentemplate-0.0.1/tests/README.md

@@ -0,0 +1,14 @@
+<!--
+SPDX-FileCopyrightText: © 2025 open-nudge <https://github.com/open-nudge>
+SPDX-FileContributor: szymonmaszke <github@maszke.co>
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Tests of opentemplate
+
+- `test_smoke.py` - generic
+    [smoke tests](https://grafana.com/blog/2024/01/30/smoke-testing/)
+    to check if the package is importable
+
+<!-- Describe your testing here -->