From 4de9b9a451431cac87783191de83ba3e82ee966e Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Sat, 3 Jan 2026 22:53:25 -0800 Subject: [PATCH 1/7] Update template --- .cookiecutter_includes/gitignore.j2 | 78 +++ .cookiecutter_includes/license_header.j2 | 149 ++++ .cookiecutter_includes/make/__init__.j2 | 33 + .cookiecutter_includes/make/clean.j2 | 46 ++ .cookiecutter_includes/make/docs.j2 | 173 +++++ .cookiecutter_includes/make/help.j2 | 71 ++ .cookiecutter_includes/make/lint.j2 | 19 + .cookiecutter_includes/make/phony.j2 | 59 ++ .cookiecutter_includes/make/python.j2 | 19 + .cookiecutter_includes/make/settings.j2 | 75 ++ .cookiecutter_includes/make/version.j2 | 29 + .cookiecutter_includes/pyproject/__init__.j2 | 19 + .cookiecutter_includes/tests/__init__.j2 | 23 + .cookiecutter_includes/tests/bake.j2 | 97 +++ .gitattributes | 5 + .github/FUNDING.yml | 5 + .github/workflows/dependency-check.yml | 43 ++ .github/workflows/format-check.yml | 43 ++ .github/workflows/jekyll-gh-pages.yml | 71 ++ .github/workflows/lint-check.yml | 56 ++ .github/workflows/security-audit.yml | 43 ++ .github/workflows/spellcheck.yml | 43 ++ .github/workflows/tests.yml | 43 ++ .github/workflows/typecheck.yml | 43 ++ .gitignore | 96 +++ .pre-commit-config.yaml | 80 +++ .yamllint | 54 ++ LICENSE | 678 +++++++++++++++++++ Makefile | 529 +++++++++++++++ README.md | 1 - cliff.toml | 88 +++ cookiecutter.json | 56 ++ cspell.json | 51 ++ docs/cookiecutter_input.json | 56 ++ docs/jekyll/.gitignore | 74 ++ docs/jekyll/Gemfile | 5 + docs/jekyll/Makefile | 89 +++ docs/jekyll/README.md | 7 + docs/jekyll/_config.yml | 140 ++++ docs/jekyll/_includes/image-carousel.html | 64 ++ docs/jekyll/_includes/snippet_loader.html | 4 + docs/jekyll/_includes/social-bar.html | 167 +++++ docs/jekyll/docs/cookiecutter_input.json | 26 + docs/jekyll/index.md | 26 + hooks/post_gen_project.py | 52 ++ hooks/pre_gen_project.py | 36 + pyproject.toml | 255 +++++++ tests/test_bake_project.py | 45 ++ 48 files changed, 3963 insertions(+), 1 deletion(-) create mode 100644 .cookiecutter_includes/gitignore.j2 create mode 100644 .cookiecutter_includes/license_header.j2 create mode 100644 .cookiecutter_includes/make/__init__.j2 create mode 100644 .cookiecutter_includes/make/clean.j2 create mode 100644 .cookiecutter_includes/make/docs.j2 create mode 100644 .cookiecutter_includes/make/help.j2 create mode 100644 .cookiecutter_includes/make/lint.j2 create mode 100644 .cookiecutter_includes/make/phony.j2 create mode 100644 .cookiecutter_includes/make/python.j2 create mode 100644 .cookiecutter_includes/make/settings.j2 create mode 100644 .cookiecutter_includes/make/version.j2 create mode 100644 .cookiecutter_includes/pyproject/__init__.j2 create mode 100644 .cookiecutter_includes/tests/__init__.j2 create mode 100644 .cookiecutter_includes/tests/bake.j2 create mode 100644 .gitattributes create mode 100644 .github/FUNDING.yml create mode 100644 .github/workflows/dependency-check.yml create mode 100644 .github/workflows/format-check.yml create mode 100644 .github/workflows/jekyll-gh-pages.yml create mode 100644 .github/workflows/lint-check.yml create mode 100644 .github/workflows/security-audit.yml create mode 100644 .github/workflows/spellcheck.yml create mode 100644 .github/workflows/tests.yml create mode 100644 .github/workflows/typecheck.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 .yamllint create mode 100644 LICENSE create mode 100644 Makefile delete mode 100644 README.md create mode 100644 cliff.toml create mode 100644 cookiecutter.json create mode 100644 cspell.json create mode 100644 docs/cookiecutter_input.json create mode 100644 docs/jekyll/.gitignore create mode 100755 docs/jekyll/Gemfile create mode 100644 docs/jekyll/Makefile create mode 100644 docs/jekyll/README.md create mode 100755 docs/jekyll/_config.yml create mode 100644 docs/jekyll/_includes/image-carousel.html create mode 100644 docs/jekyll/_includes/snippet_loader.html create mode 100644 docs/jekyll/_includes/social-bar.html create mode 100644 docs/jekyll/docs/cookiecutter_input.json create mode 100644 docs/jekyll/index.md create mode 100644 hooks/post_gen_project.py create mode 100644 hooks/pre_gen_project.py create mode 100644 pyproject.toml create mode 100644 tests/test_bake_project.py diff --git a/.cookiecutter_includes/gitignore.j2 b/.cookiecutter_includes/gitignore.j2 new file mode 100644 index 0000000..c05f9db --- /dev/null +++ b/.cookiecutter_includes/gitignore.j2 @@ -0,0 +1,78 @@ +{# +# gitignore.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{% macro gitignore( + template_type +) -%} + +{%- set ansible -%} +# ========================================= +# Ansible Galaxy Ignores # +# ========================================= +ansible.cfg +hosts +inventory.yml +**/vault.yml +/group_vars +/host_vars +{%- endset -%} + +{%- set python -%} +# ========================================= +# Python project ignores # +# ========================================= +__pycache__/ +*.egg-info/ +.mypy_cache/ +.pytest_cache/ +.ruff_cache/ +.venv/ +dist/ +{%- endset -%} + +{%- set ansible_cookiecutter = ansible ~ '\n' ~ python -%} + +{% if template_type == "ansible" %} +{{ ansible_cookiecutter }} +{% elif template_type in ["c", "c++", "c/cc", "c/c++"] %} +# ========================================= +# C/C++ Ignores # +# ========================================= +*.o +*.a +*.out +{% elif template_type in ["cookiecutter", "python"] %} +{{ python }} +{% elif template_type == "ros2" %} +# ========================================= +# ROS2 Ignores # +# ========================================= +install/ +build/ +log/ +{% elif template_type == "typescript" %} +# ========================================= +# Typescript Ignores # +# ========================================= +node_modules/ +dist/ +*.tsbuildinfo +{% endif %} +{%- endmacro -%} diff --git a/.cookiecutter_includes/license_header.j2 b/.cookiecutter_includes/license_header.j2 new file mode 100644 index 0000000..8368a2c --- /dev/null +++ b/.cookiecutter_includes/license_header.j2 @@ -0,0 +1,149 @@ +{# +# license_header.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{%- macro license_header( + license_type, + author, + project_name, + file_name='none', + comment_style='hash' +) -%} + {# + This renders license header depending on user selection of cookiecutter.license. + Args: license_type, author, file_name, comment_style. + #} +{# This macro generates the correct license header based on input #} +{# Define variables for start/end comment delimiters #} +{%- set start_comment = "" -%} +{%- set end_comment = "" -%} +{%- set newline = "\n" -%} +{# Determine the correct comment style #} +{%- if comment_style == 'python' -%} + {%- set start_comment = '"""' + newline -%} + {%- set end_comment = newline + '"""' -%} +{%- elif comment_style == 'html' -%} + {%- set start_comment = '' -%} +{%- else -%} + {# Default to hash/pound symbol for yaml, toml, shell scripts, etc. #} + {%- set start_comment = '#' -%} + {%- set end_comment = newline -%} +{%- endif -%} +{# Generate the core license text #} +{% set license_text %} +{{ file_name }} for {{ project_name }} + +Copyright (c) {% now 'utc', '%Y' %}, {{ author }} +{% if license_type == "Apache-2.0" -%} +SPDX-License-Identifier: Apache-2.0 + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + www.apache.org + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +{% elif license_type == "BSD-3-Clause" -%} +SPDX-License-Identifier: BSD-3-Clause + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +{% elif license_type == "GPL-3.0" -%} +SPDX-License-Identifier: GPL-3.0-or-later + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +{% elif license_type == "MIT" -%} +SPDX-License-Identifier: MIT + +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. +{% endif -%} +{%- endset -%} +{# Wrap the generated text with the appropriate start and end delimiters #} +{%- if comment_style == 'python' or comment_style == 'html' -%} +{{ start_comment -}} +{{ license_text | trim }} +{{- end_comment }} +{%- else -%} +{%- set text = license_text.split('\n') -%} +{# For hash comments, prefix every line with '#' #} +{%- for line in text -%} +{%- if line == '' or line == '\n' -%} +{%- set commented_line = line -%} +{%- else -%} +{%- set commented_line = " " + line -%} +{%- endif -%} +#{{ commented_line }} +{% endfor -%} +{%- endif -%} +{%- endmacro -%} diff --git a/.cookiecutter_includes/make/__init__.j2 b/.cookiecutter_includes/make/__init__.j2 new file mode 100644 index 0000000..a05de03 --- /dev/null +++ b/.cookiecutter_includes/make/__init__.j2 @@ -0,0 +1,33 @@ +{# +# make/__init__.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/make/clean.j2' as _clean with context %} +{% import '.cookiecutter_includes/make/docs.j2' as _docs with context %} +{% import '.cookiecutter_includes/make/help.j2' as _help with context %} +{% import '.cookiecutter_includes/make/phony.j2' as _phony with context %} +{% import '.cookiecutter_includes/make/settings.j2' as _settings with context %} +{% import '.cookiecutter_includes/make/version.j2' as _version with context %} + +{% set clean = _clean %} +{% set docs = _docs %} +{% set help = _help %} +{% set phony = _phony %} +{% set settings = _settings %} +{% set version = _version %} diff --git a/.cookiecutter_includes/make/clean.j2 b/.cookiecutter_includes/make/clean.j2 new file mode 100644 index 0000000..9de47b0 --- /dev/null +++ b/.cookiecutter_includes/make/clean.j2 @@ -0,0 +1,46 @@ +{# +# make/clean.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{% macro clean( + jekyll_enabled, + sphinx_enabled +) -%} +# -------------------------------------------------- +# ๐Ÿงน Clean artifacts +# -------------------------------------------------- +clean-docs: + $(AT)echo "๐Ÿงน Cleaning documentation artifacts..." +{% if sphinx_enabled %} + $(AT)$(MAKE) -C $(SPHINX_DIR) clean +{% endif %} +{% if jekyll_enabled %} + $(AT)$(MAKE) -C $(JEKYLL_DIR) clean +{% endif %} + $(AT)echo "โœ… Cleaned documentation artifacts..." + +clean-build: + $(AT)echo "๐Ÿงน Cleaning build artifacts..." + $(AT)rm -rf build dist *.egg-info + $(AT)find $(SRC_DIR) $(TESTS_DIR) -name "__pycache__" -type d -exec rm -rf {} + + $(AT)-[ -d "$(VENV_DIR)" ] && rm -r $(VENV_DIR) + $(AT)echo "๐Ÿงน Cleaned build artifacts." + +clean: clean-docs clean-build +{%- endmacro -%} diff --git a/.cookiecutter_includes/make/docs.j2 b/.cookiecutter_includes/make/docs.j2 new file mode 100644 index 0000000..6b3a5a5 --- /dev/null +++ b/.cookiecutter_includes/make/docs.j2 @@ -0,0 +1,173 @@ +{# +# make/docs.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{% macro sphinx_cmds() -%} + {# formatted sphinx command string. #} +sphinx: + $(ACTIVATE) && $(MAKE) -C $(SPHINX_DIR) all PUBLISHDIR=$(JEKYLL_SPHINX_DIR) +{%- endmacro -%} + + +{% macro jekyll_cmds() -%} + {# formatted jekyll command string. #} +jekyll: + $(MAKE) -C $(JEKYLL_DIR) all; + +jekyll-serve: docs + $(MAKE) -C $(JEKYLL_DIR) run; + +readme: + $(AT)$(NUTRIMATIC) build readme $(JEKYLL_DIR) $(README_FILE) \ + --tmp-dir $(README_GEN_DIR) --jekyll-cmd '$(JEKYLL_BUILD)' +{%- endmacro -%} + + +{% macro generate_doc_title(jekyll_enabled, sphinx_enabled) -%} + {# + Generates a formatted documentation title string based on active tools. + + Args: + jekyll_enabled (bool): Whether GitHub/Jekyll is being used. + sphinx_enabled (bool): Whether Sphinx is being used. + + Returns: + String: A combined title like "Sphinx + Jekyll + nutrimatic". + #} + {%- set title -%} + {% if sphinx_enabled -%}Sphinx{%- endif -%} + {% if sphinx_enabled and jekyll_enabled %} + {% endif -%} + {% if jekyll_enabled -%}Jekyll + nutrimatic{%- endif -%} + {%- endset -%} +# -------------------------------------------------- +# ๐Ÿ“š Documentation ({{ title }}) +# -------------------------------------------------- +{%- endmacro -%} + + +{% macro docs_cmds(jekyll_enabled, sphinx_enabled) -%} + {# + Generates a formatted documentation command string based on active tools. + + Args: + jekyll_enabled (bool): Whether GitHub/Jekyll is being used. + sphinx_enabled (bool): Whether Sphinx is being used. + + Returns: + String: A combined command string for both build-docs and run-docs". + #} + {%- set sphinx_cmds = sphinx_cmds() -%} + {%- set jekyll_cmds = jekyll_cmds() -%} + + {%- set docs_body -%} + {% if sphinx_enabled and jekyll_enabled %} +{{ sphinx_cmds }} + +{{ jekyll_cmds}} + {% elif sphinx_enabled %} +{{ sphinx_cmds }} + {% elif jekyll_enabled %} +{{ jekyll_cmds }} + {% endif %} + +# Note: Run as part of pre-commit. No manual run needed. +build-docs: + {%- if sphinx_enabled %} sphinx {%- endif %} + {%- if jekyll_enabled %} jekyll readme + $(AT)$(GIT) add $(DOCS_DIR) + $(AT)$(GIT) add $(README_FILE) + +run-docs: jekyll-serve + {%- else -%} + {%- endif -%} + {%- endset -%} +{{ docs_body }} +{%- endmacro -%} + + +{% macro docs_enabled( + jekyll_enabled, + sphinx_enabled, + macro +)%} + {% if not sphinx_enabled and not jekyll_enabled %} + {% else %} +{{ macro }} + {%- endif -%} +{%- endmacro -%} + + +{% macro doc_commands_section( + jekyll_enabled, + sphinx_enabled +) -%} + {# + Generates a formatted Makefile documentation command section based on active tools. + + Args: + jekyll_enabled (bool): Whether GitHub/Jekyll is being used. + sphinx_enabled (bool): Whether Sphinx is being used. + + Returns: + String: Makefile documentation command section. + #} + {%- set title = generate_doc_title(jekyll_enabled, sphinx_enabled) -%} + + {%- set python_commands_section -%} +{{ title }} + {% if sphinx_enabled %} +SPHINX := $(PYTHON) -m sphinx -b markdown + {% endif %} + {% if jekyll_enabled %} +JEKYLL_BUILD := bundle exec jekyll build --quiet +JEKYLL_CLEAN := bundle exec jekyll clean +JEKYLL_SERVE := bundle exec jekyll serve + {%- endif -%} + {%- endset -%} + + {%- set return = docs_enabled(jekyll_enabled, sphinx_enabled, python_commands_section) -%} + +{{ return }} +{%- endmacro -%} + + +{% macro doc_actions( + jekyll_enabled, + sphinx_enabled +) -%} + {# + Generates a formatted Makefile documentation command section based on active tools. + + Args: + jekyll_enabled (bool): Whether GitHub/Jekyll is being used. + sphinx_enabled (bool): Whether Sphinx is being used. + + Returns: + String: Makefile documentation command section. + #} + {%- set title = generate_doc_title(jekyll_enabled, sphinx_enabled) -%} + {%- set cmds = docs_cmds(jekyll_enabled, sphinx_enabled) -%} + + {%- set make_commands_section %} +{{ title }} +{{ cmds }} + {%- endset -%} + {%- set return = docs_enabled(jekyll_enabled, sphinx_enabled, make_commands_section) -%} +{{ return }} +{%- endmacro -%} diff --git a/.cookiecutter_includes/make/help.j2 b/.cookiecutter_includes/make/help.j2 new file mode 100644 index 0000000..73a22ed --- /dev/null +++ b/.cookiecutter_includes/make/help.j2 @@ -0,0 +1,71 @@ +{# +# make/help.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{# TODO: I should probably add pre-commit, pre-release, & release to the menu. #} +{# TODO: I should probably add options to turn the different features on and of formatters, linters, etc. #} + +{% macro help( + jekyll_enabled, + sphinx_enabled +) -%} +# -------------------------------------------------- +# โ“ Help +# -------------------------------------------------- +help: + $(AT)echo "๐Ÿ“ฆ $(PROJECT_NAME) Makefile" + $(AT)echo "" + $(AT)echo "Usage:" + $(AT)echo " make venv Create python virtual environment (venv)" + $(AT)echo " make install Install python project dependencies (pip)" + $(AT)echo " make security Security audit (pip-audit)" + $(AT)echo " make dependency-check dependency check (deptry)" + $(AT)echo " make black-formatter-check Run Black python formatter check (black)" + $(AT)echo " make black-formatter-fix Run Black python formatter (black)" + $(AT)echo " make format-check Run all project formatter checks (black)" + $(AT)echo " make format-fix Run all project formatter autofixes (black)" + $(AT)echo " make jinja2-lint-check Run jinja linter (jinja-cmd)" + $(AT)echo " make ruff-lint-check Run Ruff linter (ruff)" + $(AT)echo " make ruff-lint-fix Auto-fix python lint issues (ruff)" + $(AT)echo " make toml-lint-check Run TOML linter (tomllint)" + $(AT)echo " make yaml-lint-check Run YAML linter (yamllint)" + $(AT)echo " make lint-check Run all project linters (jinja2, ruff, toml, & yaml)" + $(AT)echo " make lint-fix Run all project linter autofixes (ruff)" + $(AT)echo " make spellcheck Run spellcheck (codespell)" + $(AT)echo " make typecheck Run type checking (mypy)" + $(AT)echo " make test Run test suite (pytest)" +{% if sphinx_enabled %} + $(AT)echo " make sphinx Generate Sphinx Documentation" +{% endif %} +{% if jekyll_enabled %} + $(AT)echo " make jekyll Generate Jekyll Documentation" +{% endif %} +{% if jekyll_enabled or sphinx_enabled %} + $(AT)echo " make build-docs Build all project documentation" +{% endif %} +{% if jekyll_enabled %} + $(AT)echo " make run-docs Serve Jekyll site locally" +{% endif %} + $(AT)echo " make clean Clean build artifacts" + $(AT)echo " make version Displays project information." + $(AT)echo " make all Run lint, typecheck, test, and docs" + $(AT)echo "Options:" + $(AT)echo " V=1 Enable verbose output (show all commands being executed)" + $(AT)echo " make -s Run completely silently (suppress make's own output AND command echo)" +{%- endmacro -%} diff --git a/.cookiecutter_includes/make/lint.j2 b/.cookiecutter_includes/make/lint.j2 new file mode 100644 index 0000000..160873d --- /dev/null +++ b/.cookiecutter_includes/make/lint.j2 @@ -0,0 +1,19 @@ +{# +# make/lint.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} diff --git a/.cookiecutter_includes/make/phony.j2 b/.cookiecutter_includes/make/phony.j2 new file mode 100644 index 0000000..c8270c3 --- /dev/null +++ b/.cookiecutter_includes/make/phony.j2 @@ -0,0 +1,59 @@ +{# +# make/phony.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{% macro phony( + jekyll_enabled, + sphinx_enabled +) -%} + {%- set targets = [ + 'all', 'list-folders' + ] -%} + {%- set python_targets = [ + 'venv', 'install', 'pre-commit-init', 'security', + 'dependency-check', 'black-formatter-check', 'black-formatter-fix', + 'render-cookiecutter', 'jinja2-lint-check', 'ruff-lint-check', + 'ruff-lint-fix', 'toml-lint-check', 'yaml-lint-check' + ] -%} + {%- set ci_cd_targets = [ + 'format-check', 'format-fix', 'lint-check', 'lint-fix', + 'spellcheck', 'typecheck', 'test' + ] -%} + {%- set release_targets = [ + 'build-docs', 'bump-version-patch', 'changelog', + 'git-release', 'pre-commit', 'pre-release', 'release' + ] -%} + {%- set internal_tool_targets = [ + 'clean-docs', 'clean-build', 'clean', 'version', 'help' + ] -%} + + {# TODO: Thinking about adding a python_enabled selection to this... #} + {%- do targets.extend(python_targets) -%} + {%- do targets.extend(ci_cd_targets) -%} + {%- if sphinx_enabled %}{% do targets.append('sphinx') %}{% endif %} + {%- if jekyll_enabled %}{% do targets.extend(['jekyll', 'readme', 'jekyll-serve', 'run-docs']) %}{% endif %} + {%- do targets.extend(release_targets) -%} + {%- do targets.extend(internal_tool_targets) -%} + +{# .PHONY: {{ targets | join(' \\\n\t') }} #} +.PHONY: +{%- for group in targets | batch(4) %} +{{ ' \\\n\t' }}{{ group | join(' ') }} +{%- endfor %} +{%- endmacro -%} diff --git a/.cookiecutter_includes/make/python.j2 b/.cookiecutter_includes/make/python.j2 new file mode 100644 index 0000000..2d454c0 --- /dev/null +++ b/.cookiecutter_includes/make/python.j2 @@ -0,0 +1,19 @@ +{# +# make/python.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} diff --git a/.cookiecutter_includes/make/settings.j2 b/.cookiecutter_includes/make/settings.j2 new file mode 100644 index 0000000..9efcbcd --- /dev/null +++ b/.cookiecutter_includes/make/settings.j2 @@ -0,0 +1,75 @@ +{# +# make/settings.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{% macro settings( + jekyll_enabled, + sphinx_enabled +) -%} +# -------------------------------------------------- +# โš™๏ธ Build Settings +# -------------------------------------------------- +PROJECT_NAME := "{{ cookiecutter.__python.project_name }}" +AUTHOR := "{{ cookiecutter.author }}" +VERSION := {{ cookiecutter.version }} +RELEASE := v$(VERSION) +# -------------------------------------------------- +# ๐Ÿ™ Github Build Settings +# -------------------------------------------------- +GITHUB_USER := "{{ cookiecutter.github_username }}" +GITHUB_REPO := $(GITHUB_USER)/$(PROJECT_NAME) +# -------------------------------------------------- +# ๐Ÿ“ Build Directories +# -------------------------------------------------- +PROJECT_ROOT := $(call cc_or_std,$(CURDIR),$(PWD)) +HOOKS_DIR := $(PROJECT_ROOT)/hooks +SRC_DIR := $(HOOKS_DIR) +TEST_DIR := $(PROJECT_ROOT)/tests +TESTS_DIR := $(TEST_DIR) +DOCS_DIR := $(PROJECT_ROOT)/docs +{% if jekyll_enabled %} +JEKYLL_DIR := $(DOCS_DIR)/jekyll +{% endif %} +{% if sphinx_enabled %} +SPHINX_DIR := $(DOCS_DIR)/sphinx +JEKYLL_SPHINX_DIR := $(JEKYLL_DIR)/sphinx +{% endif %} +{% if jekyll_enabled %} +README_GEN_DIR := $(JEKYLL_DIR)/tmp_readme +{% endif %} +CHANGELOG_DIR := $(PROJECT_ROOT)/changelogs +CHANGELOG_RELEASE_DIR := $(CHANGELOG_DIR)/releases +# -------------------------------------------------- +# ๐Ÿ“„ Build Files +# -------------------------------------------------- +{% if jekyll_enabled %} +README_FILE := $(PROJECT_ROOT)/README.md +{% endif %} +CHANGELOG_FILE := $(CHANGELOG_DIR)/CHANGELOG.md +CHANGELOG_RELEASE_FILE := $(CHANGELOG_RELEASE_DIR)/$(RELEASE).md +# -------------------------------------------------- +# ๐Ÿช Template Directories (cookiecutter) +# -------------------------------------------------- +{%- raw %} +COOKIE_DIR := $(PROJECT_ROOT)/{{ cookiecutter.project_slug }} +{% endraw %} +COOKIE_MACRO_DIR := $(COOKIE_DIR)/.cookiecutter_includes +RENDERED_COOKIE_DIR := /tmp/rendered +RENDERED_VENV_DIR := $(RENDERED_COOKIE_DIR)/**/.venv +{%- endmacro -%} diff --git a/.cookiecutter_includes/make/version.j2 b/.cookiecutter_includes/make/version.j2 new file mode 100644 index 0000000..9c6cc02 --- /dev/null +++ b/.cookiecutter_includes/make/version.j2 @@ -0,0 +1,29 @@ +{# +# make/version.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{% macro version() -%} +# -------------------------------------------------- +# Version +# -------------------------------------------------- +version: + $(AT)echo "$(PROJECT_NAME)" + $(AT)echo "author: $(AUTHOR)" + $(AT)echo "version: $(VERSION)" +{%- endmacro -%} diff --git a/.cookiecutter_includes/pyproject/__init__.j2 b/.cookiecutter_includes/pyproject/__init__.j2 new file mode 100644 index 0000000..2649eb1 --- /dev/null +++ b/.cookiecutter_includes/pyproject/__init__.j2 @@ -0,0 +1,19 @@ +{# +# pyproject/__init__.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} diff --git a/.cookiecutter_includes/tests/__init__.j2 b/.cookiecutter_includes/tests/__init__.j2 new file mode 100644 index 0000000..fd59d57 --- /dev/null +++ b/.cookiecutter_includes/tests/__init__.j2 @@ -0,0 +1,23 @@ +{# +# tests/__init__.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/tests/bake.j2' as _bake with context %} + +{% set bake = _bake %} diff --git a/.cookiecutter_includes/tests/bake.j2 b/.cookiecutter_includes/tests/bake.j2 new file mode 100644 index 0000000..778e70a --- /dev/null +++ b/.cookiecutter_includes/tests/bake.j2 @@ -0,0 +1,97 @@ +{# +# tests/bake.j2 for cookiecutter-cookiecutter +# +# Copyright (c) 2025, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +#} + + +{% macro _get_test_file( + template_type +) -%} +{# returns the test_file name depending on the template type. #} + {% if template_type in ["ansible", "c", "c++", "c/cc", "c/c++", "ros2"] -%} + LICENSE + {%- elif template_type == "cookiecutter" -%} + Makefile + {%- elif template_type == "python" -%} + pyproject.toml + {%- elif template_type == "typescript" -%} + package.json + {%- endif %} +{%- endmacro -%} + + +{% macro default_bake( + template_type +) -%} +{# returns test_bake_with_defaults python function for testing cookiecutter template projects.. #} +{%- set test_file = _get_test_file(template_type) -%} +{%- set python_bake_function -%} +def test_bake_with_defaults(cookies: Cookies) -> None: + """Ensure the template bakes correctly with default context.""" + result = cookies.bake() + assert result.exit_code == 0 + assert result.exception is None + assert result.project_path.is_dir() + + # Optional sanity checks + project_name = result.project_path.name + assert project_name # non-empty + test_file = result.project_path / "{{ test_file }}" + assert test_file.exists() +{%- endset -%} +{{ python_bake_function }} +{%- endmacro -%} + + +{% macro _get_test_name( + template_type +) -%} +{# + returns the expected project_slug for the test project name + depending on the template type. +#} + {%- set use_default_slug = [ + "c", "c++", "c/cc", "c/c++", + "cookiecutter", "python", "ros2", + "typescript"] -%} + + {% if template_type == "ansible" -%} + jcook3701.test_project + {%- elif template_type in use_default_slug -%} + test-project + {%- endif %} +{%- endmacro -%} + + +{% macro custom_bake( + template_type +) -%} +{# returns test_bake_with_custom_name python function for testing cookiecutter template projects. #} +{%- set test_name = _get_test_name(template_type) %} +{%- set python_bake_function -%} +def test_bake_with_custom_name(cookies: Cookies) -> None: + """Ensure custom project_name works.""" + result = cookies.bake(extra_context={"project_name": "Test Project"}) + print(result) + assert result.exit_code == 0 + assert result.exception is None + assert result.project_path.is_dir() + assert result.project_path.name == "{{ test_name }}" +{%- endset -%} +{{ python_bake_function }} +{%- endmacro -%} diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..41a876a --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +# ========================================= +# cookiecutter project upgrader attributes # +# ========================================= +cookiecutter.json merge=ours +**/README.md* merge=ours diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..dd36db4 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,5 @@ +# These are supported funding model platforms +--- + +# github: ["jcook3701"] +buy_me_a_coffee: "jcook3701" diff --git a/.github/workflows/dependency-check.yml b/.github/workflows/dependency-check.yml new file mode 100644 index 0000000..50afdb0 --- /dev/null +++ b/.github/workflows/dependency-check.yml @@ -0,0 +1,43 @@ +# dependency-check.yml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +name: Cookiecutter Template Dependency Check + +on: [push, pull_request] + +jobs: + dependency-check: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install deptry + run: | + make install + + - name: Run Dependency Check + run: | + make dependency-check diff --git a/.github/workflows/format-check.yml b/.github/workflows/format-check.yml new file mode 100644 index 0000000..f516813 --- /dev/null +++ b/.github/workflows/format-check.yml @@ -0,0 +1,43 @@ +# black-format.yml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +name: Cookiecutter Template Format Check + +on: [push, pull_request] + +jobs: + black-format-check: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install Formatting Tools + run: | + make install + + - name: Black Format Check + run: | + make black-formatter-check diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml new file mode 100644 index 0000000..ce2acb4 --- /dev/null +++ b/.github/workflows/jekyll-gh-pages.yml @@ -0,0 +1,71 @@ +# jekyll-gh-pages.yml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +name: Deploy Jekyll with GitHub Pages dependencies preinstalled + +on: + push: + branches: + - master + - main + paths: + - "docs/**" + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Build with Jekyll site in /docs/jekyll + uses: actions/jekyll-build-pages@v1 + with: + source: ./docs/jekyll + destination: ./_site + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/lint-check.yml b/.github/workflows/lint-check.yml new file mode 100644 index 0000000..58a93b3 --- /dev/null +++ b/.github/workflows/lint-check.yml @@ -0,0 +1,56 @@ +# lint-check.yml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +name: Cookiecutter Template Lint Check + +on: [push, pull_request] + +jobs: + jinja2-lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install Linting Tools + run: | + make install + + - name: Render Cookiecutter Template + run: | + make render-cookiecutter + + - name: Lint Jinja templates + run: | + make jinja2-lint-check + - name: Run Ruff Lint Check + run: | + make ruff-lint-check + - name: Run Toml Lint Check + run: | + make toml-lint-check + - name: Run YAML Lint Check + run: | + make yaml-lint-check diff --git a/.github/workflows/security-audit.yml b/.github/workflows/security-audit.yml new file mode 100644 index 0000000..610028a --- /dev/null +++ b/.github/workflows/security-audit.yml @@ -0,0 +1,43 @@ +# security-audit.yml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +name: Cookiecutter Template Security Audit + +on: [push, pull_request] + +jobs: + security-audit: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install pip-audit + run: | + make install + + - name: Run Security Check + run: | + make security diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..0dc38d7 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,43 @@ +# spellcheck.yml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +name: Cookiecutter Template Spellcheck + +on: [push, pull_request] + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install codespell + run: | + make install + + - name: Run Spellcheck + run: | + make spellcheck diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..da6ca27 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,43 @@ +# tests.yml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +name: Cookiecutter Template Tests + +on: [push, pull_request] + +jobs: + tests: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install pytest + run: | + make install + + - name: Run tests + run: | + make test diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml new file mode 100644 index 0000000..adef872 --- /dev/null +++ b/.github/workflows/typecheck.yml @@ -0,0 +1,43 @@ +# typecheck.yml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +name: Cookiecutter Template Typecheck + +on: [push, pull_request] + +jobs: + typecheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install mypy + run: | + make install + + - name: Run typecheck + run: | + make typecheck diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..184c420 --- /dev/null +++ b/.gitignore @@ -0,0 +1,96 @@ +# .gitignore for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +# ========================================= +# text editor ignores # +# ========================================= +.vscode/ +# ========================================= +# Ansible Galaxy Ignores # +# ========================================= +ansible.cfg +hosts +inventory.yml +**/vault.yml +/group_vars +/host_vars +# ========================================= +# Python project ignores # +# ========================================= +__pycache__/ +*.egg-info/ +.mypy_cache/ +.pytest_cache/ +.ruff_cache/ +.venv/ +dist/ +# ========================================= +## Default Ignores # +# ========================================= + +# ========================================= +# Backup Extensions # +# ========================================= +*.bak +*.old +*.save +# ========================================= +# Emacs Tmp Extensions # +# ========================================= +*.tmp +*.tmp.* +*.rpmnew +.#* +# ========================================= +# Compiled source Extensions # +# ========================================= +*.com +*.class +*.dll +*.exe +*.o +*.so +# ========================================= +# Package Extensions # +# ========================================= +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip +# ========================================= +# Logs and databases Extensions # +# ========================================= +*.log +*.sql +*.sqlite +# ========================================= +# OS generated files # +# ========================================= +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..9bc7457 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,80 @@ +# pre-commit-config.yaml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +default_install_hook_types: + - pre-commit + - commit-msg + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v6.0.0 + hooks: + - id: end-of-file-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md, --markdown-linebreak-ext=mdx] + - id: mixed-line-ending + args: [--fix=lf] + - id: check-yaml + exclude: '{{ cookiecutter.project_slug }}/.*' + - id: check-json + exclude: '{{ cookiecutter.project_slug }}/.*' + - id: check-toml + exclude: '{{ cookiecutter.project_slug }}/.*' + - id: detect-private-key + - id: check-case-conflict + - id: check-added-large-files + - id: check-symlinks + + - repo: https://github.com/psf/black + rev: 25.11.0 + hooks: + - id: black + exclude: '{{ cookiecutter.project_slug }}/.*' + + - repo: local + hooks: + - id: generate-changelog + name: Generate CHANGELOG.md + entry: make changelog + language: system + files: CHANGELOG.md + always_run: true + pass_filenames: false + + - repo: local + hooks: + - id: generate-docs + name: Generate Documentation + entry: make build-docs + language: system + always_run: true + pass_filenames: false + + - repo: https://github.com/streetsidesoftware/cspell-cli + rev: v9.3.3 + hooks: + - id: cspell + stages: [commit-msg] + args: ["--config", "./cspell.json"] + + - repo: https://github.com/compilerla/conventional-pre-commit + rev: v4.3.0 + hooks: + - id: conventional-pre-commit + stages: [commit-msg] diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..8a0973a --- /dev/null +++ b/.yamllint @@ -0,0 +1,54 @@ +# .yamllint for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +--- +extends: default +ignore: + - .venv + - changelogs + - '{{ cookiecutter.project_slug }}' + +rules: + line-length: + max: 120 + level: warning + braces: + min-spaces-inside: 0 + max-spaces-inside: 1 + comments: + # prettier compatibility + min-spaces-from-content: 1 + comments-indentation: false + document-start: + present: true + level: error + key-duplicates: + forbid-duplicated-merge-keys: true + indentation: + level: error + indent-sequences: consistent + octal-values: + forbid-implicit-octal: true + forbid-explicit-octal: true + quoted-strings: + quote-type: double + required: false + level: warning + truthy: + allowed-values: + ["true", "false", "yes", "no", "on", "off"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..af26be5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,678 @@ +GPL-3.0 License + +Copyright (c) 2026 Jared Cook + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..adb0c36 --- /dev/null +++ b/Makefile @@ -0,0 +1,529 @@ +# Makefile for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +# -------------------------------------------------- +# โš™๏ธ Environment Settings +# -------------------------------------------------- +SHELL := /bin/bash +.SHELLFLAGS := -O globstar -c +# If V is set to '1' or 'y' on the command line, +# AT will be empty (verbose). Otherwise, AT will +# contain '@' (quiet by default). The '?' is a +# conditional assignment operator: it only sets V +# if it hasn't been set externally. +V ?= 0 +ifeq ($(V),0) + AT = @ +else + AT = +endif +# Detect if we are running inside GitHub Actions CI. +# GitHub sets the environment variable GITHUB_ACTIONS=true in workflows. +# We set CI=1 if running in GitHub Actions, otherwise CI=0 for local runs. +ifeq ($(GITHUB_ACTIONS),true) +CI := 1 +else +CI := 0 +endif +# Detect if we are running inside Cookiecutter (pre/post) hooks. +# Cookiecutter hooks are used to set the environment variable COOKIECUTTER_HOOKS=true. +# We set CC=1 if running in Cookiecutter hooks, otherwise CC=0 for standard runs. +COOKIECUTTER_RENDER_DIR := /tmp/rendered +ifeq ($(COOKIECUTTER_HOOKS),true) +CC := 1 +else +CC := 0 +endif +# -------------------------------------------------- +# ๐Ÿ—๏ธ CI/CD Functions +# -------------------------------------------------- +# Returns true when CI is off and gracefully moves through failed checks. +define run_ci_safe = +( $1 || \ + if [ "$(CI)" != "1" ]; then \ + echo "โŒ process finished with error; continuing..."; \ + true; \ + else \ + echo "โŒ process finished with error"; \ + exit 1; \ + fi \ +) +endef +# cc_or_std: +# Selects between Cookiecutter hook context and standard execution context. +# +# If COOKIECUTTER_HOOKS=true, expands to the first argument (Cookiecutter render). +# Otherwise, expands to the second argument (normal project execution). +# +# Usage: +# PROJECT_ROOT := $(call cc_or_std,$(COOKIECUTTER_RENDER_DIR),$(PWD)) +cc_or_std = $(if $(filter true,$(COOKIECUTTER_HOOKS)),$(1),$(2)) +# -------------------------------------------------- +# โš™๏ธ Build Settings +# -------------------------------------------------- +PROJECT_NAME := "python3-cookiecutter" +AUTHOR := "Jared Cook" +VERSION := 0.1.0 +RELEASE := v$(VERSION) +# -------------------------------------------------- +# ๐Ÿ™ Github Build Settings +# -------------------------------------------------- +GITHUB_USER := "jcook3701" +GITHUB_REPO := $(GITHUB_USER)/$(PROJECT_NAME) +# -------------------------------------------------- +# ๐Ÿ“ Build Directories +# -------------------------------------------------- +PROJECT_ROOT := $(call cc_or_std,$(CURDIR),$(PWD)) +HOOKS_DIR := $(PROJECT_ROOT)/hooks +SRC_DIR := $(HOOKS_DIR) +TEST_DIR := $(PROJECT_ROOT)/tests +TESTS_DIR := $(TEST_DIR) +DOCS_DIR := $(PROJECT_ROOT)/docs +JEKYLL_DIR := $(DOCS_DIR)/jekyll +README_GEN_DIR := $(JEKYLL_DIR)/tmp_readme +CHANGELOG_DIR := $(PROJECT_ROOT)/changelogs +CHANGELOG_RELEASE_DIR := $(CHANGELOG_DIR)/releases +# -------------------------------------------------- +# ๐Ÿ“„ Build Files +# -------------------------------------------------- +README_FILE := $(PROJECT_ROOT)/README.md +CHANGELOG_FILE := $(CHANGELOG_DIR)/CHANGELOG.md +CHANGELOG_RELEASE_FILE := $(CHANGELOG_RELEASE_DIR)/$(RELEASE).md +# -------------------------------------------------- +# ๐Ÿช Template Directories (cookiecutter) +# -------------------------------------------------- +COOKIE_DIR := $(PROJECT_ROOT)/{{ cookiecutter.project_slug }} +COOKIE_MACRO_DIR := $(COOKIE_DIR)/.cookiecutter_includes +RENDERED_COOKIE_DIR := /tmp/rendered +RENDERED_VENV_DIR := $(RENDERED_COOKIE_DIR)/**/.venv +# -------------------------------------------------- +# ๐Ÿ Python / Virtual Environment +# -------------------------------------------------- +PYTHON_CMD := python3.11 +VENV_DIR := $(PROJECT_ROOT)/.venv +# -------------------------------------------------- +# ๐Ÿ Python Dependencies +# -------------------------------------------------- +DEPS := . +DEV_DEPS := .[dev] +DEV_DOCS := .[docs] +# -------------------------------------------------- +# ๐Ÿ Python Commands +# -------------------------------------------------- +CREATE_VENV := $(PYTHON_CMD) -m venv $(VENV_DIR) +ACTIVATE := source $(VENV_DIR)/bin/activate +PYTHON := $(ACTIVATE) && $(PYTHON_CMD) +PIP := $(PYTHON) -m pip +# -------------------------------------------------- +# ๐Ÿช Render template (cookiecutter, cookiecutter_project_upgrader) +# -------------------------------------------------- +COOKIECUTTER := $(ACTIVATE) && cookiecutter +PROJECT_UPGRADE := $(ACTIVATE) && cookiecutter_project_upgrader +# -------------------------------------------------- +# ๐Ÿงฌ Dependency Management (deptry) +# -------------------------------------------------- +DEPTRY := $(ACTIVATE) && deptry +# -------------------------------------------------- +# ๐Ÿ›ก๏ธ Security Audit (pip-audit) +# -------------------------------------------------- +PIPAUDIT := $(ACTIVATE) && pip-audit +# -------------------------------------------------- +# ๐ŸŽจ Formatting (black) +# -------------------------------------------------- +BLACK := $(PYTHON) -m black +# -------------------------------------------------- +# ๐Ÿ” Linting (ruff, yaml, jinja2) +# -------------------------------------------------- +RUFF := $(PYTHON) -m ruff +TOMLLINT := tomllint +YAMLLINT := $(PYTHON) -m yamllint +JINJA := $(ACTIVATE) && jinja2 --strict \ + --extension=cookiecutter.extensions.JsonifyExtension \ + --extension=cookiecutter.extensions.RandomStringExtension \ + --extension=cookiecutter.extensions.SlugifyExtension \ + --extension=cookiecutter.extensions.TimeExtension \ + --extension=cookiecutter.extensions.UUIDExtension +# -------------------------------------------------- +# ๐ŸŽ“ Spellchecker (codespell) +# -------------------------------------------------- +CODESPELL := $(ACTIVATE) && codespell +# -------------------------------------------------- +# ๐Ÿง  Typing (mypy) +# -------------------------------------------------- +MYPY := $(PYTHON) -m mypy +# -------------------------------------------------- +# ๐Ÿงช Testing (pytest) +# -------------------------------------------------- +PYTEST := $(PYTHON) -m pytest +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Jekyll + nutrimatic) +# -------------------------------------------------- +JEKYLL_BUILD := bundle exec jekyll build --quiet +JEKYLL_CLEAN := bundle exec jekyll clean +JEKYLL_SERVE := bundle exec jekyll serve +# -------------------------------------------------- +# ๐Ÿ”– Version Bumping (bumpy-my-version) +# -------------------------------------------------- +BUMPVERSION := $(ACTIVATE) && bump-my-version bump --verbose +# Patch types: +MAJOR := major +MINOR := minor +PATCH := patch +# -------------------------------------------------- +# ๐Ÿ“œ Changelog generation (git-clif) +# -------------------------------------------------- +GITCLIFF := git cliff +GITCLIFF_CHANGELOG := $(GITCLIFF) --output $(CHANGELOG_FILE) +GITCLIFF_CHANGELOG_RELEASE := $(GITCLIFF) --unreleased --tag $(RELEASE) --output $(CHANGELOG_RELEASE_FILE) +# -------------------------------------------------- +# ๐Ÿ™ Github Tools (git) +# -------------------------------------------------- +GIT := git +GITHUB := gh +# Commands: +GIT_INIT_STATUS := git rev-parse --is-inside-work-tree > /dev/null 2>&1 +# -------------------------------------------------- +# ๐Ÿšจ Pre-Commit (pre-commit) +# -------------------------------------------------- +PRECOMMIT := $(ACTIVATE) && pre-commit +# -------------------------------------------------- +# ๐Ÿƒโ€โ™‚๏ธ Nutri-Matic command +# -------------------------------------------------- +NUTRIMATIC := $(PYTHON) -m nutrimatic +# -------------------------------------------------- +# Functions +# -------------------------------------------------- +# Finds files of a given extension or "*" (all files) under a directory, +# skipping VENV_DIR and template markers like {{ }}. +define get_files_by_extension + find $(1) -name "$(2)" \ + ! -path "$(VENV_DIR)/*" \ + ! -path "$(RENDERED_VENV_DIR)/*" \ + ! -path "*{{*" \ + ! -path "*}}*" \ + ! -name "__init__.j2" \ + -print0 +endef + +JINJA_FILE_LIST := ( \ + $(call get_files_by_extension,$(PROJECT_ROOT),*.j2); \ + $(call get_files_by_extension,$(RENDERED_COOKIE_DIR),*.j2) \ + ) +TOML_FILE_LIST := ( \ + $(call get_files_by_extension,$(PROJECT_ROOT),*.toml); \ + $(call get_files_by_extension,$(RENDERED_COOKIE_DIR),*.toml) \ + ) +# -------------------------------------------------- +.PHONY: \ + all list-folders venv install \ + pre-commit-init security dependency-check black-formatter-check \ + black-formatter-fix render-cookiecutter jinja2-lint-check ruff-lint-check \ + ruff-lint-fix toml-lint-check yaml-lint-check format-check \ + format-fix lint-check lint-fix spellcheck \ + typecheck test jekyll readme \ + jekyll-serve run-docs build-docs bump-version-patch \ + changelog git-release pre-commit pre-release \ + release clean-docs clean-build clean \ + version help +# -------------------------------------------------- +# Default: run lint, typecheck, spellcheck, tests, & docs +# -------------------------------------------------- +all: install lint-check typecheck spellcheck test build-docs +# -------------------------------------------------- +# Make Internal Utilities +# -------------------------------------------------- +list-folders: + $(AT)printf "\ + ๐Ÿ src: $(SRC_DIR)\n\ + ๐Ÿงช Test: $(TESTS_DIR)\n" +# -------------------------------------------------- +# Dependency Checks +# -------------------------------------------------- +git-dependency-check: + $(AT)which $(GIT) >/dev/null || \ + { echo "Git is required: sudo apt install git"; exit 1; } + +gh-dependency-check: + $(AT)which $(GITHUB) >/dev/null || \ + { echo "GitHub is required: sudo apt install gh"; exit 1; } +# -------------------------------------------------- +# ๐Ÿ Virtual Environment Setup +# -------------------------------------------------- +venv: + $(AT)echo "๐Ÿ Creating virtual environment..." + $(AT)$(CREATE_VENV) + $(AT)echo "โœ… Virtual environment created." + +install: venv + $(AT)echo "๐Ÿ“ฆ Installing project dependencies..." + $(AT)$(PIP) install --upgrade pip setuptools wheel + # $(AT)$(PIP) install -e $(DEPS) + $(AT)$(PIP) install -e $(DEV_DEPS) + $(AT)$(PIP) install -e $(DEV_DOCS) + $(AT)echo "โœ… Dependencies installed." +# -------------------------------------------------- +# ๐Ÿšจ Pre-Commit (pre-commit) +# -------------------------------------------------- +# Note: Run as part of project initialization. No manual run needed. +pre-commit-init: + $(AT)echo "๐Ÿ“ฆ Installing pre-commit hooks and hook-types..." + $(AT)which $(GIT) >/dev/null || { echo "Git is required"; exit 1; } + $(AT)$(PRECOMMIT) install --install-hooks + $(AT)$(PRECOMMIT) install --hook-type pre-commit --hook-type commit-msg + $(AT)echo "โœ… pre-commit dependencies installed!" +# -------------------------------------------------- +# ๐Ÿช Project Updater (cookiecutter_project_upgrader) +# -------------------------------------------------- +project-upgrade: + $(AT)echo "๐Ÿช Upgrading project from initial cookiecutter template..." + $(AT)$(PROJECT_UPGRADE) --context-file ./docs/cookiecutter_input.json \ + --upgrade-branch main \ + -e "cookiecutter.json" \ + -e "$(COOKIE_DIR)" + $(AT)echo "โœ… Finished project upgrade!" +# -------------------------------------------------- +# ๐Ÿ›ก๏ธ Security (pip-audit) +# -------------------------------------------------- +security: + $(AT)echo "๐Ÿ›ก๏ธ Running security audit..." + $(AT)$(call run_ci_safe, $(PIPAUDIT)) + $(AT)echo "โœ… Finished security audit!" +# -------------------------------------------------- +# ๐Ÿงฌ Dependency Management (deptry) +# -------------------------------------------------- +dependency-check: + $(AT)echo "๐Ÿงฌ Checking dependency issues..." + $(AT)$(DEPTRY) --pep621-dev-dependency-groups dev,docs \ + $(SRC_DIR) + $(AT)echo "โœ… Finished checking for dependency issues!" +# -------------------------------------------------- +# ๐ŸŽจ Formatting (black) +# -------------------------------------------------- +black-formatter-check: + $(AT)echo "๐Ÿ” Running black formatter style check..." + $(AT)$(call run_ci_safe, $(BLACK) --check $(SRC_DIR) $(TESTS_DIR)) + $(AT)echo "โœ… Finished formatting check of Python code with Black!" + +black-formatter-fix: + $(AT)echo "๐ŸŽจ Running black formatter fixes..." + $(AT)$(BLACK) $(SRC_DIR) $(TESTS_DIR) + $(AT)echo "โœ… Finished formatting Python code with Black!" + +format-check: black-formatter-check +format-fix: black-formatter-fix +# -------------------------------------------------- +# ๐Ÿ” Linting (jinja2, ruff, toml, & yaml) +# -------------------------------------------------- +render-cookiecutter: + $(AT)rm -rf $(RENDERED_COOKIE_DIR) + $(AT)$(COOKIECUTTER) . --no-input \ + --output-dir $(RENDERED_COOKIE_DIR) \ + --overwrite-if-exists + +jinja2-lint-check: + $(AT)echo "๐Ÿ” jinja2 lint..." + $(AT)jq '{cookiecutter: .}' cookiecutter.json > /tmp/_cc_wrapped.json + $(AT)$(JINJA_FILE_LIST) | tr '\0' '\n' + $(AT)$(ACTIVATE) && $(JINJA_FILE_LIST) | \ + while IFS= read -r -d '' f; do \ + if file "$$f" | grep -q text; then \ + echo "Checking $$f"; \ + $(JINJA) "$$f" /tmp/_cc_wrapped.json || exit 1; \ + fi; \ + done + $(AT)echo "โœ… Finished linting check of jinja2 macro files with jinja2!" + +ruff-lint-check: + $(AT)echo "๐Ÿ” Running ruff linting..." + $(AT)$(MAKE) list-folders + $(AT)$(RUFF) check --config pyproject.toml $(SRC_DIR) $(TESTS_DIR) \ + --force-exclude '$(COOKIE_DIR)/pyproject.toml' + $(AT)echo "โœ… Finished linting check of Python code with Ruff!" + +ruff-lint-fix: + $(AT)echo "๐ŸŽจ Running ruff lint fixes..." + $(AT)$(RUFF) check --config pyproject.toml --show-files $(SRC_DIR) $(TESTS_DIR) + $(AT)$(RUFF) check --config pyproject.toml --fix $(SRC_DIR) $(TESTS_DIR) \ + --force-exclude '$(COOKIE_DIR)/pyproject.toml' + $(AT)echo "โœ… Finished linting Python code with Ruff!" + +toml-lint-check: + $(AT)echo "๐Ÿ” Running Tomllint..." + $(AT)$(TOML_FILE_LIST) | tr '\0' '\n' + $(AT)$(ACTIVATE) && \ + $(TOML_FILE_LIST) \ + | xargs -0 -n 1 $(TOMLLINT) + $(AT)echo "โœ… Finished linting check of toml files with Tomllint!" + +yaml-lint-check: + $(AT)echo "๐Ÿ” Running yamllint..." + $(AT)$(YAMLLINT) $(PROJECT_ROOT) + $(AT)$(YAMLLINT) $(RENDERED_COOKIE_DIR) + $(AT)echo "โœ… Finished linting check of yaml files with yamllint!" + +lint-check: render-cookiecutter ruff-lint-check toml-lint-check yaml-lint-check +lint-fix: ruff-lint-fix +# -------------------------------------------------- +# ๐ŸŽ“ Spellchecker (codespell) +# -------------------------------------------------- +spellcheck: + $(AT)echo "๐ŸŽ“ Checking Spelling (codespell)..." + $(AT)$(call run_ci_safe, $(CODESPELL)) + $(AT)echo "โœ… Finished spellcheck!" +# -------------------------------------------------- +# ๐Ÿง  Typechecking (MyPy) +# -------------------------------------------------- +typecheck: + $(AT)echo "๐Ÿง  Checking types (MyPy)..." + $(AT)$(MAKE) list-folders + $(AT)$(call run_ci_safe, $(MYPY) $(SRC_DIR) $(TESTS_DIR)) + $(AT)echo "โœ… Python typecheck complete!" +# -------------------------------------------------- +# ๐Ÿงช Testing (pytest) +# -------------------------------------------------- +test: + $(AT)echo "๐Ÿงช Running tests with pytest..." + $(AT)$(call run_ci_safe, $(PYTEST)) + $(AT)echo "โœ… Python tests complete!" +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Jekyll + nutrimatic) +# -------------------------------------------------- +jekyll: + $(MAKE) -C $(JEKYLL_DIR) all; + +jekyll-serve: docs + $(MAKE) -C $(JEKYLL_DIR) run; + +readme: + $(AT)$(NUTRIMATIC) build readme $(JEKYLL_DIR) $(README_FILE) \ + --tmp-dir $(README_GEN_DIR) --jekyll-cmd '$(JEKYLL_BUILD)' + +# Note: Run as part of pre-commit. No manual run needed. +build-docs: jekyll readme + $(AT)$(GIT) add $(DOCS_DIR) + $(AT)$(GIT) add $(README_FILE) + +run-docs: jekyll-serve +# -------------------------------------------------- +# ๐Ÿ”– Version Bumping (bumpy-my-version) +# -------------------------------------------------- +# TODO: Also create a git tag of current version. +bump-version-patch: + $(AT)echo "๐Ÿ”– Updating $(PROJECT_NAME) version from $(VERSION)..." + $(AT)$(BUMPVERSION) $(PATCH) + $(AT)echo "โœ… $(PROJECT_NAME) version update complete!" +# -------------------------------------------------- +# ๐Ÿ“œ Changelog generation (git-cliff) +# -------------------------------------------------- +# Note: Run as part of pre-commit. No manual run needed. +changelog: + $(AT)echo "๐Ÿ“œ $(PROJECT_NAME) Changelog Generation..." + $(AT)$(GITCLIFF_CHANGELOG) + $(AT)$(GITCLIFF_CHANGELOG_RELEASE) + $(AT)$(GIT) add $(CHANGELOG_FILE) + $(AT)$(GIT) add $(CHANGELOG_RELEASE_FILE) + $(AT)echo "โœ… Finished Changelog Update!" +# -------------------------------------------------- +# ๐Ÿ™ Github Commands (git) +# -------------------------------------------------- +# Note: Run as part of project initialization. No manual run needed. +git-init: git-dependency-check + $(AT)if ! $(GIT_INIT_STATUS); then \ + echo "๐ŸŒฑ $(PROJECT_NAME) Git initialization! ๐ŸŽ‰"; \ + $(GIT) init; \ + $(GIT) add --all; \ + $(GIT) commit -m "chore(init): Init commit. \ + Project $(PROJECT_NAME) template generation complete."; \ + echo "โœ… Finished Git initialization!"; \ + else \ + echo "โ„น๏ธ Git is already initialized for $(PROJECT_NAME)."; \ + fi + +git-release: + $(AT)if $(GIT_INIT_STATUS); then \ + echo "๐Ÿ“ฆ $(PROJECT_NAME) Release Tag - $(RELEASE)! ๐ŸŽ‰"; \ + $(GIT) tag -a $(RELEASE) -m "Release $(RELEASE)"; \ + $(GIT) push origin $(RELEASE); \ + $(GITHUB) release create $(RELEASE) --generate-notes; \ + echo "โœ… Finished uploading Release - $(RELEASE)! ๐ŸŽ‰"; \ + else \ + echo "โŒ Git is not yet initialized. Skipping version release." \ + fi +# -------------------------------------------------- +# ๐Ÿ“ข Release +# -------------------------------------------------- +pre-commit: test security dependency-check format-fix lint-check spellcheck typecheck +pre-release: clean install pre-commit build-docs changelog build +release: git-release bump-version-patch +# -------------------------------------------------- +# ๐Ÿงน Clean artifacts +# -------------------------------------------------- +clean-docs: + $(AT)echo "๐Ÿงน Cleaning documentation artifacts..." + $(AT)$(MAKE) -C $(JEKYLL_DIR) clean + $(AT)echo "โœ… Cleaned documentation artifacts..." + +clean-build: + $(AT)echo "๐Ÿงน Cleaning build artifacts..." + $(AT)rm -rf build dist *.egg-info + $(AT)find $(SRC_DIR) $(TESTS_DIR) -name "__pycache__" -type d -exec rm -rf {} + + $(AT)-[ -d "$(VENV_DIR)" ] && rm -r $(VENV_DIR) + $(AT)echo "๐Ÿงน Cleaned build artifacts." + +clean: clean-docs clean-build +# -------------------------------------------------- +# Version +# -------------------------------------------------- +version: + $(AT)echo "$(PROJECT_NAME)" + $(AT)echo "author: $(AUTHOR)" + $(AT)echo "version: $(VERSION)" +# -------------------------------------------------- +# โ“ Help +# -------------------------------------------------- +help: + $(AT)echo "๐Ÿ“ฆ $(PROJECT_NAME) Makefile" + $(AT)echo "" + $(AT)echo "Usage:" + $(AT)echo " make venv Create python virtual environment (venv)" + $(AT)echo " make install Install python project dependencies (pip)" + $(AT)echo " make security Security audit (pip-audit)" + $(AT)echo " make dependency-check dependency check (deptry)" + $(AT)echo " make black-formatter-check Run Black python formatter check (black)" + $(AT)echo " make black-formatter-fix Run Black python formatter (black)" + $(AT)echo " make format-check Run all project formatter checks (black)" + $(AT)echo " make format-fix Run all project formatter autofixes (black)" + $(AT)echo " make jinja2-lint-check Run jinja linter (jinja-cmd)" + $(AT)echo " make ruff-lint-check Run Ruff linter (ruff)" + $(AT)echo " make ruff-lint-fix Auto-fix python lint issues (ruff)" + $(AT)echo " make toml-lint-check Run TOML linter (tomllint)" + $(AT)echo " make yaml-lint-check Run YAML linter (yamllint)" + $(AT)echo " make lint-check Run all project linters (jinja2, ruff, toml, & yaml)" + $(AT)echo " make lint-fix Run all project linter autofixes (ruff)" + $(AT)echo " make spellcheck Run spellcheck (codespell)" + $(AT)echo " make typecheck Run type checking (mypy)" + $(AT)echo " make test Run test suite (pytest)" + $(AT)echo " make jekyll Generate Jekyll Documentation" + $(AT)echo " make build-docs Build all project documentation" + $(AT)echo " make run-docs Serve Jekyll site locally" + $(AT)echo " make clean Clean build artifacts" + $(AT)echo " make version Displays project information." + $(AT)echo " make all Run lint, typecheck, test, and docs" + $(AT)echo "Options:" + $(AT)echo " V=1 Enable verbose output (show all commands being executed)" + $(AT)echo " make -s Run completely silently (suppress make's own output AND command echo)" diff --git a/README.md b/README.md deleted file mode 100644 index 9960bd8..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# supreme_restock \ No newline at end of file diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..a2dbc03 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,88 @@ +# cliff.toml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +# Git-Cliff config for hybrid changelog system +[git] +conventional_commits = true +filter_unconventional = false +include_commits = "all" + +commit_parsers = [ + { message = "^init", group = "๐ŸŒฑ Init", type = "init" }, + { message = "^feat", group = "๐Ÿš€ Added", type = "feat" }, + { message = "^fix", group = "๐Ÿ› Fixed", type = "fix" }, + { message = "^doc", group = "๐Ÿ“š Documentation", type = "docs" }, + { message = "^perf", group = "โšก Performance", type = "perf" }, + { message = "^refactor", group = "๐Ÿšœ Refactoring", type = "refactor" }, + { message = "^style", group = "๐ŸŽจ Styling", type = "style" }, + { message = "^test", group = "๐Ÿงช Tests", type = "test" }, + { message = "^deprecate", group = "โš ๏ธ Deprecated", type = "deprecate" }, + { message = "^remove", group = "๐Ÿšซ Removed", type = "remove" }, + { message = "^security", group = "๐Ÿ”’ Security", type = "security" }, + { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous", type = "chore" }, + { message = ".*", group = "โš™๏ธ Miscellaneous", type = "chore" }, +] + +exclude = [ + "^Merge", + "^chore: bump version", + "^chore: update changelog", + "^docs: update readme", +] + +[sections] +"๐ŸŒฑ Init" = ["init"] +"๐Ÿš€ Added" = ["feat"] +"๐Ÿ› Fixed" = ["fix"] +"๐Ÿ“š Documentation" = ["docs"] +"โšก Performance" = ["perf"] +"๐Ÿšœ Refactoring" = ["refactor"] +"๐ŸŽจ Styling" = ["style"] +"๐Ÿงช Tests" = ["test"] +"โš ๏ธ Deprecated" = ["deprecate"] +"๐Ÿšซ Removed" = ["remove"] +"๐Ÿ”’ Security" = ["security"] +"๐Ÿ‘ท CI" = ["ci"] +"๐Ÿ”จ Build System" = ["build"] +"โš™๏ธ Miscellaneous" = ["chore"] + +[changelog] +# This tells git-cliff to manage the file persistently +header = """ +# -------------------------------------------------- +# Changelog: +# -------------------------------------------------- + +""" +# This setting controls how new entries are added +prepend = true + +# Sorts commits from oldest to newest within each release section +sort = "oldest" +# Hides sections if they have no commits in that release +filter_sections = true +# Use a custom template to define the output format +template = """ +{% for section, commits in sections %} +## {{ section | striptags | trim }} +{% for commit in commits %} +* {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.external_link }})) +{% endfor %} +{% endfor %} +""" diff --git a/cookiecutter.json b/cookiecutter.json new file mode 100644 index 0000000..0e5ecd5 --- /dev/null +++ b/cookiecutter.json @@ -0,0 +1,56 @@ +{ + "project_name": "project-name-cookiecutter", + "project_slug": "{{ cookiecutter.project_name | slugify }}", + "author": "Jared Cook", + "email": "jcook3701+github@gmail.com", + "version": "0.1.0", + "license": [ + "GPL-3.0", + "Apache-2.0", + "BSD-3-Clause", + "MIT" + ], + "__copyright": "Copyright (c) {% now 'utc', '%Y' %} {{ cookiecutter.author }}", + "description": "Description of cookiecutter template project.", + "python_version": [ + "3.11", + "3.10" + ], + "__python": { + "package_name": "{{ cookiecutter.project_slug }}", + "target_version": "py{{ cookiecutter.python_version|replace('.', '') }}", + "keywords": [ + "python3", + "cookiecutter", + "template", + "automation" + ] + }, + "ga_tracking": "G-C7PWLWSHB9", + "github_username": "jcook3701", + "twitter_username": "", + "linkedin_usercode": "jared-cook-b3585a114", + "buymeacoffee_username": "jcook3701", + "theme": [ + "pmarsceill/just-the-docs", + "carlosperate/jekyll-theme-rtd" + ], + "_hooks": { + "post_gen_make_cmds": { + "install": true, + "git-init": true, + "pre-commit-init": true, + "changelog": true, + "build-docs": false + } + }, + "_copy_without_render": [ + ".github/workflows/*" + ], + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true + }, + "add_github_docs": true, + "add_sphinx_docs": false +} diff --git a/cspell.json b/cspell.json new file mode 100644 index 0000000..554ed02 --- /dev/null +++ b/cspell.json @@ -0,0 +1,51 @@ +{ + "version": "0.2", + "language": "en", + "useGitignore": true, + "words": [ + "bumpversion", + "cli", + "codespell", + "cookiecutter", + "cookiecutter_project_upgrader", + "deptry", + "ehthumbs", + "gitcliff", + "githubusercontent", + "mkdirp", + "nutrimatic", + "nutri-matic", + "pipaudit", + "pip-audit", + "pyproject", + "pytest", + "rpmnew", + "streetsidesoftware", + "tomllint", + "tsmerge", + "upgrader", + "venv", + "visualstudio", + "vsmarketplacebadge" + ], + "flagWords": [ + "hte" + ], + "dictionaries": [ + "bash", + "companies", + "css", + "docker", + "django", + "filetypes", + "git", + "html", + "javascript", + "misc", + "npm", + "python", + "python-common", + "softwareTerms", + "typescript" + ] +} diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json new file mode 100644 index 0000000..f678e71 --- /dev/null +++ b/docs/cookiecutter_input.json @@ -0,0 +1,56 @@ +{ + "__copyright": "Copyright (c) 2026 Jared Cook", + "__python": { + "keywords": [ + "python3", + "cookiecutter", + "template", + "automation" + ], + "project_name": "python3-cookiecutter", + "target_version": "py311" + }, + "_checkout": "main", + "_copy_without_render": [ + "{{ '{{' }} cookiecutter.project_slug {{ '}}' }}/*", + ".cookiecutter_includes/*", + ".cookiecutter_includes/**/*" + ], + "_extensions": [ + "jinja2.ext.do", + "jinja2.ext.loopcontrols" + ], + "_hooks": { + "post_gen_make_cmds": { + "build-docs": false, + "changelog": false, + "git-init": true, + "install": true, + "pre-commit-init": true + } + }, + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true + }, + "_output_dir": "/home/jcook/Documents/git_repo/python3-cookiecutter/.git/cookiecutter", + "_repo_dir": "/home/jcook/.cookiecutters/cookiecutter-cookiecutter", + "_template": "git@github.com:jcook3701/cookiecutter-cookiecutter.git", + "add_github_docs": true, + "add_sphinx_docs": false, + "author": "Jared Cook", + "buymeacoffee_username": "jcook3701", + "description": "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation.", + "email": "jcook3701+github@gmail.com", + "ga_tracking": "G-C7PWLWSHB9", + "github_username": "jcook3701", + "license": "GPL-3.0", + "linkedin_usercode": "jared-cook-b3585a114", + "project_name": "python3-cookiecutter", + "project_slug": "python3-cookiecutter", + "python_version": "3.11", + "template_type": "ansible", + "theme": "pmarsceill/just-the-docs", + "twitter_username": "", + "version": "0.1.0" +} diff --git a/docs/jekyll/.gitignore b/docs/jekyll/.gitignore new file mode 100644 index 0000000..96b24c2 --- /dev/null +++ b/docs/jekyll/.gitignore @@ -0,0 +1,74 @@ +# .gitignore +# ========================================= +# Project: python3-cookiecutter +# ========================================= + +# ========================================= +## Jekyll Ignores +# ========================================= +# Ignore the default location of the built site, and caches and metadata generated by Jekyll +_site/ +.sass-cache/ +.jekyll-cache/ +.jekyll-metadata + +# ========================================= +# Ignore folders generated by Bundler +# ========================================= +.bundle/ +vendor/ + +# ========================================= +## Default Ignores +# ========================================= + +# ========================================= +# Backup Extensions # +# ========================================= +*.bak +*.old +*.save +# ========================================= +# Emacs Tmp Extensions # +# ========================================= +*.tmp +*.tmp.* +.#* +# ========================================= +# Compiled source Extensions # +# ========================================= +*.com +*.class +*.dll +*.exe +*.o +*.so +# ========================================= +# Package Extensions # +# ========================================= +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip +# ========================================= +# Logs and databases Extensions # +# ========================================= +*.log +*.sql +*.sqlite +# ========================================= +# OS generated files # +# ========================================= +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db diff --git a/docs/jekyll/Gemfile b/docs/jekyll/Gemfile new file mode 100755 index 0000000..a3aebeb --- /dev/null +++ b/docs/jekyll/Gemfile @@ -0,0 +1,5 @@ +source 'https://rubygems.org' + +gem "faraday", "~> 2.7", ">= 2.7.11" +gem "faraday-retry" +gem "github-pages", group: :jekyll_plugins diff --git a/docs/jekyll/Makefile b/docs/jekyll/Makefile new file mode 100644 index 0000000..9dd6cfc --- /dev/null +++ b/docs/jekyll/Makefile @@ -0,0 +1,89 @@ +# Makefile +# ========================================= +# Project: github-docs for python3-cookiecutter +# ========================================= + +# -------------------------------------------------- +# โš™๏ธ Environment Settings +# -------------------------------------------------- +SHELL := /bin/bash +.SHELLFLAGS := -O globstar -c +# If V is set to '1' or 'y' on the command line, +# AT will be empty (verbose). Otherwise, AT will +# contain '@' (quiet by default). The '?' is a +# conditional assignment operator: it only sets V +# if it hasn't been set externally. +V ?= 0 +ifeq ($(V),0) + AT = @ +else + AT = +endif +# Detect if we are running inside GitHub Actions CI. +# GitHub sets the environment variable GITHUB_ACTIONS=true in workflows. +# We set CI=1 if running in GitHub Actions, otherwise CI=0 for local runs. +ifeq ($(GITHUB_ACTIONS),true) +CI := 1 +else +CI := 0 +endif +# Define a reusable CI-safe runner +define run_ci_safe = +( $1 || [ "$(CI)" != "1" ] ) +endef +# -------------------------------------------------- +# โš™๏ธ Build Settings +# -------------------------------------------------- +PACKAGE_NAME = "python3-cookiecutter" +AUTHOR = "Jared Cook" +VERSION = "0.1.0" +PUBLISHDIR ?= +# -------------------------------------------------- +# ๐Ÿ“˜ Documentation (Sphinx + Jekyll) +# -------------------------------------------------- +JEKYLL_BUILD := bundle exec jekyll build --quiet +JEKYLL_CLEAN := bundle exec jekyll clean +JEKYLL_SERVE := bundle exec jekyll serve +# -------------------------------------------------- +.PHONY: all jekyll jekyll-serve build run clean help +# -------------------------------------------------- +# Default: +# -------------------------------------------------- +all: build +# -------------------------------------------------- +# ๐Ÿ“˜ Documentation (Jekyll) +# -------------------------------------------------- +jekyll: + $(AT)echo "๐Ÿ”จ Building Jekyll site ๐Ÿ“˜..." + $(AT)$(JEKYLL_BUILD) + $(AT)echo "โœ… Full documentation build complete!" + +jekyll-serve: + $(AT)echo "๐Ÿš€ Starting Jekyll development server..." + $(AT)$(JEKYLL_SERVE) + +build: jekyll +run: jekyll-serve +# -------------------------------------------------- +# ๐Ÿงน Clean artifacts +# -------------------------------------------------- +clean: + $(AT)echo "๐Ÿงน Cleaning Jekyll build artifacts..." + $(AT)$(call run_ci_safe,$(JEKYLL_CLEAN)) + $(AT)echo "โœ… Cleaned Jekyll build artifacts." +# -------------------------------------------------- +# Help +# -------------------------------------------------- +help: + $(AT)echo "๐Ÿ“ฆ $(PACKAGE_NAME) github documentation Makefile" + $(AT)echo " author: $(PACKAGE_AUTHOR)" + $(AT)echo " version: $(PACKAGE_VERSION)" + $(AT)echo "" + $(AT)echo "Usage:" + $(AT)echo " make build Generate Jekyll documentation" + $(AT)echo " make run Serve Jekyll site locally" + $(AT)echo " make clean Clean Jekyll build artifacts" + $(AT)echo " make all Run make (build)" + $(AT)echo "Options:" + $(AT)echo " V=1 Enable verbose output (show all commands being executed)" + $(AT)echo " make -s Run completely silently (suppress make's own output AND command echo)" diff --git a/docs/jekyll/README.md b/docs/jekyll/README.md new file mode 100644 index 0000000..2f2e9af --- /dev/null +++ b/docs/jekyll/README.md @@ -0,0 +1,7 @@ +# {{ site.title }} + +__Author:__ {{ site.author }} +__Version:__ {{ site.version }} + +## Overview +{{ site.description }} diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml new file mode 100755 index 0000000..e049703 --- /dev/null +++ b/docs/jekyll/_config.yml @@ -0,0 +1,140 @@ +# python3-cookiecutter Documentation +--- + +title: "python3-cookiecutter" +author: "Jared Cook" +version: "0.1.0" +description: "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation." +remote_theme: "pmarsceill/just-the-docs" +ga_tracking: "G-C7PWLWSHB9" + +repo_name: "python3-cookiecutter" +baseurl: "/python3-cookiecutter" +repo_url: > + https://github.com/jcook3701/python3-cookiecutter + +# Author Remote User Accounts +# twitter_username: "" +github_username: "jcook3701" +linkedin_usercode: "jared-cook-b3585a114" +buymeacoffee_username: "jcook3701" + +# carousel_images: +# - /assets/images/ +# - /assets/images/ +# - /assets/images/ + +# Set a path/url to a logo that will be displayed instead of the title +# logo: /assets/images/icon128.png + +# Enable or disable the site search +search_enabled: true + +# For copy button on code +enable_copy_code_button: true + +# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in +mermaid: + # Version of mermaid library + # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/ + version: "9.1.6" + # Note: Put any additional configuration, such as setting the theme, + # in _includes/mermaid_config.js. See also docs/ui-components/code. + # Note: To load mermaid from a local library, also use the `path` key + # to specify the location of the library; e.g. for (v10+): + # path: "/assets/js/mermaid.esm.min.mjs" for (- + Copyright © 2025 Jared Cook. Distributed by an + + MIT license. + + + +## Footer last edited timestamp +# show or hide edit time - page must have `last_modified_date` defined in the frontmatter +last_edit_timestamp: true +# uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html +last_edit_time_format: >- + %b %e %Y at %I:%M %p +## Footer "Edit this page on GitHub" link text +# show or hide edit this page link +gh_edit_link: true +gh_edit_link_text: "Edit this page on GitHub" +# the github URL for your repo +gh_edit_repository: >- + https://github.com/jcook3701/python3-cookiecutter +# the branch that your docs is served from +gh_edit_branch: "master" +# the source that your files originate from +gh_edit_source: docs +# "tree" or "edit" if you want the user to jump into the editor immediately +gh_edit_view_mode: "tree" + +# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define +callouts_level: quiet # or loud +callouts: + highlight: + color: yellow + important: + title: Important + color: blue + new: + title: New + color: green + note: + title: Note + color: purple + warning: + title: Warning + color: red + +plugins: + - jekyll-seo-tag + - jekyll-github-metadata + - jekyll-include-cache + - jekyll-sitemap + +kramdown: + auto_ids: true + +# Exclude files/folders from Jekyll processing +exclude: + - node_modules + - .DS_Store + - Gemfile + - Gemfile.lock + +# Optional SEO metadata +seo: + title: "python3-cookiecutter Documentation" + description: "Full code documentation for the python3-cookiecutter project" diff --git a/docs/jekyll/_includes/image-carousel.html b/docs/jekyll/_includes/image-carousel.html new file mode 100644 index 0000000..f74f777 --- /dev/null +++ b/docs/jekyll/_includes/image-carousel.html @@ -0,0 +1,64 @@ +
+ +
+ {% assign slides = site.carousel_images %} {% for image in slides %} {% if + image.src %} + {{ image.caption }} + {% else %} + + {% endif %} {% endfor %} +
+ +
+ + + + diff --git a/docs/jekyll/_includes/snippet_loader.html b/docs/jekyll/_includes/snippet_loader.html new file mode 100644 index 0000000..6765a0a --- /dev/null +++ b/docs/jekyll/_includes/snippet_loader.html @@ -0,0 +1,4 @@ + diff --git a/docs/jekyll/_includes/social-bar.html b/docs/jekyll/_includes/social-bar.html new file mode 100644 index 0000000..9dd1a65 --- /dev/null +++ b/docs/jekyll/_includes/social-bar.html @@ -0,0 +1,167 @@ + +
+
    + {% if site.twitter_username %} +
  • + +
    • + {% endif %} + + {% if site.linkedin_usercode %} +
  • + + + +
    • + {% endif %} + + {% if site.github_username %} +
  • + + + +
    • + {% endif %} + + + {% if site.buymeacoffee_username %} +
  • + + + +
    • + {% endif %} +
+
+ + diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json new file mode 100644 index 0000000..483fc66 --- /dev/null +++ b/docs/jekyll/docs/cookiecutter_input.json @@ -0,0 +1,26 @@ +{ + "_checkout": null, + "_copy_without_render": [ + "README.md", + "_includes/*" + ], + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true + }, + "_output_dir": "/home/jcook/Documents/git_repo/python3-cookiecutter/.git/cookiecutter/python3-cookiecutter/docs/_tmp_docs", + "_repo_dir": "/home/jcook/.cookiecutters/github-docs-cookiecutter", + "_template": "https://github.com/jcook3701/github-docs-cookiecutter.git", + "author": "Jared Cook", + "buymeacoffee_username": "jcook3701", + "description": "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation.", + "email": "jcook3701+github@gmail.com", + "ga_tracking": "G-C7PWLWSHB9", + "github_username": "jcook3701", + "linkedin_usercode": "jared-cook-b3585a114", + "project_name": "python3-cookiecutter", + "project_slug": "python3-cookiecutter", + "theme": "pmarsceill/just-the-docs", + "twitter_username": "", + "version": "0.1.0" +} diff --git a/docs/jekyll/index.md b/docs/jekyll/index.md new file mode 100644 index 0000000..05840a1 --- /dev/null +++ b/docs/jekyll/index.md @@ -0,0 +1,26 @@ +--- +layout: default +title: python3-cookiecutter +nav_order: 1 +description: Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation. +--- + + + +{% include snippet_loader.html %} + +{% if site.carousel_images %} + {% include image-carousel.html %} +{% endif %} + + +{% include_relative README.md %} + + +# โ˜• Support Me +If you enjoy this project, please consider buying me a coffee or making a code contribution. + +# Social Links + +{% include social-bar.html %} + diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py new file mode 100644 index 0000000..c632e70 --- /dev/null +++ b/hooks/post_gen_project.py @@ -0,0 +1,52 @@ +# post_gen_project.py for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +import json +import os + +from nutrimatic.core import make +from nutrimatic.hooks.post_gen_logic import ( + generate_ansible_dirs, + generate_docs_templates, + get_make_cmds, +) + + +def main() -> None: + """Cookiecutter Post Generation Scripts""" + # Detect CI (e.g. GitHub Actions, GitLab CI, etc.) + if os.getenv("CI"): + print("โš™๏ธ Detected CI environment โ€” skipping GitHub Docs generation.") + return + os.environ["COOKIECUTTER_HOOKS"] = "true" + + # Access cookiecutter context safely + context = json.loads("""{{ cookiecutter | jsonify }}""") + generate_docs_templates(context) + generate_ansible_dirs() + + # Run make commands to get project seeded + make_cmds: list[str] = get_make_cmds(context) + + for cmd in make_cmds: + make(cmd) + + +if __name__ == "__main__": + main() diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py new file mode 100644 index 0000000..81e404a --- /dev/null +++ b/hooks/pre_gen_project.py @@ -0,0 +1,36 @@ +# pre_gen_project.py for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + + +import json +import os + + +def main() -> None: + """Cookiecutter Pre Generation Scripts""" + # Detect CI (e.g. GitHub Actions, GitLab CI, etc.) + if os.getenv("CI"): + print("โš™๏ธ Detected CI environment โ€” skipping GitHub Docs generation.") + return + context = json.loads("""{{ cookiecutter | jsonify }}""") + print(f"Context: {context}") + + +if __name__ == "__main__": + main() diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..f7ae4c6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,255 @@ +# pyproject.toml for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + + +[build-system] +requires = ["setuptools>=80.0.0", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "python3-cookiecutter" +version = "0.1.0" +description = "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation." +authors = [ + { name="Jared Cook", email="jcook3701+github@gmail.com" } +] +readme = "README.md" +license = "GPL-3.0" +license-files = ["LICENSE"] +requires-python = ">=3.11" +dependencies = [ + "nutri-matic>=0.1", +] +keywords = ["python3", "cookiecutter", "template", "automation"] +classifiers = [ + "Programming Language :: Python :: 3", + "Operating System :: OS Independent", +] + +[project.urls] +Homepage = "https://github.com/jcook3701/python3-cookiecutter" +Repository = "https://github.com/jcook3701/python3-cookiecutter" +Documentation = "https://github.com/jcook3701/python3-cookiecutter/docs/jekyll" + +[project.optional-dependencies] +dev = [ + "bump-my-version>=1.2", + "black>=25.11", + "codespell>=2.4", + "cookiecutter>=2.6", + "cookiecutter-project-upgrader>=1.3", + "coverage>=7.12", + "deptry>=0.24", + "json-lint-tools>=0.1", + "jinja2-cli>=0.8", + "mypy==1.9", + "nameisok>=0.1", + "pip-audit>=2.10", + "pre-commit>=4.5", + "pytest>=9.0", + "pytest-cookies>=0.7", + "pytest-cov>=7.0", + "ruff>=0.14.0", + "tomllint>=0.3", + "yamllint>=1.0", +] +docs = [ + "sphinx>=8.0", + "sphinx-rtd-theme>=3.0", + "sphinx-markdown-builder>=0.6", + "sphinx-autodoc-typehints>=3.5", +] + +# ==================================== +# Setuptools Configuration: +# ==================================== +[tool.setuptools.packages.find] +where = [ + "hooks", +] +include = [ + "*", +] +# ==================================== +# Black Configuration: (Formatting) +# ==================================== +[tool.black] +line-length = 88 # Maximum line length (default is 88) +target-version = ["py311"] # Target Python version(s) +skip-string-normalization = false # Whether to skip normalizing string quotes +include = '\.pyi?$' # Which files to include (regex) +exclude = ''' +/( + \.git + | \.hg + | \.mypy_cache + | \.tox + | \.venv + | _build + | buck-out + | build + | dist +)/ +''' +# ==================================== +# Version Bumping (bump-my-version): +# ==================================== +[tool.bumpversion] +current_version = "0.1.0" +parse = "(?P\\d+)\\.(?P\\d+)\\.(?P\\d+)" +serialize = ["{major}.{minor}.{patch}"] +search = "{current_version}" +replace = "{new_version}" +tag = false +commit = false + +[[tool.bumpversion.files]] +filename = "Makefile" +[[tool.bumpversion.files]] +filename = "README.md" +[[tool.bumpversion.files]] +filename = "docs/cookiecutter_input.json" +# ==================================== +# Codespell Configuration: +# ==================================== +[tool.codespell] +# files/patterns to ignore +skip = [ + "./changelogs/*", + "cspell.json", + "./docs/jekyll/_site", + "*.svg", + "*.css", + "*.html", + "*.lock", +] +# words to ignore globally +ignore-words-list = ["crate", "ba"] + +# extra options +check-filenames = true +quiet-level = 2 +# ==================================== +# Deptry Configuration: +# ==================================== +[tool.deptry] +ignore_notebooks = true +exclude = [ + "tests/*", + "docs/*", +] +# ==================================== +# Ruff Configuration: +# ==================================== +[tool.ruff] +# Target Python version +target-version = "py311" +# Directories to lint and format +src = [ + "hooks", + "tests", +] + +# Exclude these paths +exclude = [ + ".venv", + "build", + "dist", + "__pycache__", + "docs", + "*.egg-info", + ".git", + ".github", + "*{{*cookiecutter.project_slug*}}*", +] +force-exclude = true +# Maximum line length +line-length = 120 +# ==================================== +# Ruff Lint Configuration: +# ==================================== +[tool.ruff.lint] +# Enable linting rules +select = [ + "W", # PyCodeStyle warnings + "E", # pycodestyle errors + "F", # pyflakes + "I", # isort (import sorting) + "N", # pep8-naming + "UP", # pyupgrade + "B", # flake8-bugbear + "A", # flake8-builtins + "C4", # comprehensions + "TID", # tidy imports + "FA", # future annotations + "PL", # pylint-style checks + "RUF", # ruff-specific +] +# Ignore specific rules +ignore = [ + "E501", # line too long (handled by formatter) + "PLR2004", # magic value comparison + "B008", # function call in default argument + "RUF200", # invalid pyproject.toml file that does not conform to the relevant specifications (PEPs) +] +# ==================================== +# Import Sorting Configuration: (Python helper scripts) +# ==================================== +[tool.ruff.lint.isort] +combine-as-imports = true +known-first-party = [ + "python3-cookiecutter", + "hooks" +] +# ==================================== +# Formatter Configuration: +# Ruff also formats YAML, TOML, and Markdown +# ==================================== +[tool.ruff.format] +quote-style = "double" +indent-style = "space" +line-ending = "lf" +skip-magic-trailing-comma = false +docstring-code-format = true +# ==================================== +# Mypy (type-checker) Configuration: +# ==================================== +[tool.mypy] +python_version = "3.11" +mypy_path = [ + "hooks", + "tests", +] +strict = true +warn_unused_ignores = true +warn_unused_configs = true +disallow_untyped_defs = true +ignore_missing_imports = true +# ==================================== +# Pytest Configuration: +# ==================================== +[tool.pytest.ini_options] +minversion = "7.0" +addopts = ["-v", "--maxfail=1", "-W always", "-rw", "--strict-markers"] +testpaths = [ + "tests", +] +pythonpath = [ + "hooks", +] diff --git a/tests/test_bake_project.py b/tests/test_bake_project.py new file mode 100644 index 0000000..702bc81 --- /dev/null +++ b/tests/test_bake_project.py @@ -0,0 +1,45 @@ +# test_bake_project.py for python3-cookiecutter +# +# Copyright (c) 2026, Jared Cook +# SPDX-License-Identifier: GPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + + +from pytest_cookies.plugin import Cookies + + +def test_bake_with_defaults(cookies: Cookies) -> None: + """Ensure the template bakes correctly with default context.""" + result = cookies.bake() + assert result.exit_code == 0 + assert result.exception is None + assert result.project_path.is_dir() + + # Optional sanity checks + project_name = result.project_path.name + assert project_name # non-empty + test_file = result.project_path / "LICENSE" + assert test_file.exists() + + +def test_bake_with_custom_name(cookies: Cookies) -> None: + """Ensure custom project_name works.""" + result = cookies.bake(extra_context={"project_name": "Test Project"}) + print(result) + assert result.exit_code == 0 + assert result.exception is None + assert result.project_path.is_dir() + assert result.project_path.name == "jcook3701.test_project" From 84bbc31e46b965ba0bb6017b479e45422b5046ca Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Sat, 3 Jan 2026 23:02:48 -0800 Subject: [PATCH 2/7] Update template --- .gitignore | 9 --------- docs/cookiecutter_input.json | 2 +- hooks/post_gen_project.py | 4 ++-- tests/test_bake_project.py | 4 ++-- 4 files changed, 5 insertions(+), 14 deletions(-) diff --git a/.gitignore b/.gitignore index 184c420..70cafae 100644 --- a/.gitignore +++ b/.gitignore @@ -21,15 +21,6 @@ # ========================================= .vscode/ # ========================================= -# Ansible Galaxy Ignores # -# ========================================= -ansible.cfg -hosts -inventory.yml -**/vault.yml -/group_vars -/host_vars -# ========================================= # Python project ignores # # ========================================= __pycache__/ diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index f678e71..b7dccc8 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -49,7 +49,7 @@ "project_name": "python3-cookiecutter", "project_slug": "python3-cookiecutter", "python_version": "3.11", - "template_type": "ansible", + "template_type": "python", "theme": "pmarsceill/just-the-docs", "twitter_username": "", "version": "0.1.0" diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index c632e70..a98a7b3 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -22,7 +22,7 @@ from nutrimatic.core import make from nutrimatic.hooks.post_gen_logic import ( - generate_ansible_dirs, + generate_cliff_changelog_dirs, generate_docs_templates, get_make_cmds, ) @@ -39,7 +39,7 @@ def main() -> None: # Access cookiecutter context safely context = json.loads("""{{ cookiecutter | jsonify }}""") generate_docs_templates(context) - generate_ansible_dirs() + generate_cliff_changelog_dirs() # Run make commands to get project seeded make_cmds: list[str] = get_make_cmds(context) diff --git a/tests/test_bake_project.py b/tests/test_bake_project.py index 702bc81..19c4041 100644 --- a/tests/test_bake_project.py +++ b/tests/test_bake_project.py @@ -31,7 +31,7 @@ def test_bake_with_defaults(cookies: Cookies) -> None: # Optional sanity checks project_name = result.project_path.name assert project_name # non-empty - test_file = result.project_path / "LICENSE" + test_file = result.project_path / "pyproject.toml" assert test_file.exists() @@ -42,4 +42,4 @@ def test_bake_with_custom_name(cookies: Cookies) -> None: assert result.exit_code == 0 assert result.exception is None assert result.project_path.is_dir() - assert result.project_path.name == "jcook3701.test_project" + assert result.project_path.name == "test-project" From 8542e143cec9dddc36e4a19810c34c690ab41e85 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Wed, 7 Jan 2026 01:09:56 -0800 Subject: [PATCH 3/7] Update template --- docs/cookiecutter_input.json | 2 +- docs/jekyll/docs/cookiecutter_input.json | 5 +++++ tests/test_bake_project.py | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index b7dccc8..25f801d 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -49,7 +49,7 @@ "project_name": "python3-cookiecutter", "project_slug": "python3-cookiecutter", "python_version": "3.11", - "template_type": "python", + "template_type": "cookiecutter", "theme": "pmarsceill/just-the-docs", "twitter_username": "", "version": "0.1.0" diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json index 483fc66..6c369be 100644 --- a/docs/jekyll/docs/cookiecutter_input.json +++ b/docs/jekyll/docs/cookiecutter_input.json @@ -4,6 +4,11 @@ "README.md", "_includes/*" ], + "_extensions": [ + "jinja2.ext.do", + "jinja2.ext.loopcontrols" + ], + "_is_sub_template": true, "_jinja2_env_vars": { "lstrip_blocks": true, "trim_blocks": true diff --git a/tests/test_bake_project.py b/tests/test_bake_project.py index 19c4041..a14368f 100644 --- a/tests/test_bake_project.py +++ b/tests/test_bake_project.py @@ -31,7 +31,7 @@ def test_bake_with_defaults(cookies: Cookies) -> None: # Optional sanity checks project_name = result.project_path.name assert project_name # non-empty - test_file = result.project_path / "pyproject.toml" + test_file = result.project_path / "Makefile" assert test_file.exists() From 788f6ba8a49e97a56336bb9d013091c2809eb089 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Sat, 31 Jan 2026 14:51:58 -0800 Subject: [PATCH 4/7] Update template --- .../community_health_files/__init__.j2 | 35 + .../community_health_files/code_of_conduct.j2 | 125 +++ .../community_health_files/codeowners.j2 | 25 + .../community_health_files/contributing.j2 | 148 ++++ .../community_health_files/funding.j2 | 34 + .../issue_template/01-bug-report.j2 | 82 ++ .../issue_template/02-feature-request.j2 | 74 ++ .../issue_template/__init__.j2 | 30 + .../issue_template/config.j2 | 39 + .../issue_template/z-developer-issue.j2 | 46 ++ .../pull_request_template.j2 | 28 + .../01-default-pull-request.j2 | 47 ++ .../pull_request_template/02-bug-fix.j2 | 43 ++ .../03-feature-request.j2 | 44 ++ .../pull_request_template/__init__.j2 | 27 + .../community_health_files/security.j2 | 47 ++ .../community_health_files/support.j2 | 59 ++ .cookiecutter_includes/gitignore.j2 | 18 +- .cookiecutter_includes/license/0bsd.j2 | 42 ++ .cookiecutter_includes/license/__init__.j2 | 25 + .cookiecutter_includes/license/agpl-3.0.j2 | 699 +++++++++++++++++ .cookiecutter_includes/license/apache-2.0.j2 | 237 ++++++ .../license/bsd-2-clause.j2 | 55 ++ .../license/bsd-3-clause.j2 | 54 ++ .cookiecutter_includes/license/gpl-3.0.j2 | 714 ++++++++++++++++++ .../license/license-data.j2 | 157 ++++ .../license/license-header.j2 | 84 +++ .cookiecutter_includes/license/license.j2 | 41 + .cookiecutter_includes/license/mit.j2 | 49 ++ .cookiecutter_includes/license/unlicense.j2 | 50 ++ .cookiecutter_includes/license_header.j2 | 149 ---- .cookiecutter_includes/make/__init__.j2 | 16 +- .cookiecutter_includes/make/clean.j2 | 16 +- .cookiecutter_includes/make/docs.j2 | 23 +- .cookiecutter_includes/make/help.j2 | 16 +- .cookiecutter_includes/make/lint.j2 | 115 ++- .cookiecutter_includes/make/phony.j2 | 18 +- .cookiecutter_includes/make/python.j2 | 16 +- .cookiecutter_includes/make/settings.j2 | 18 +- .cookiecutter_includes/make/version.j2 | 16 +- .cookiecutter_includes/pyproject/__init__.j2 | 16 +- .cookiecutter_includes/tests/__init__.j2 | 16 +- .cookiecutter_includes/tests/bake.j2 | 24 +- .cookiecutter_includes/workflows/__init__.j2 | 40 + .../workflows/contributor-assistant.j2 | 77 ++ .../workflows/dependency-check.j2 | 55 ++ .../workflows/format-check.j2 | 55 ++ .../workflows/jekyll-gh-pages.j2 | 100 +++ .../workflows/lint-check.j2 | 68 ++ .../workflows/security-audit.j2 | 55 ++ .../workflows/spellcheck.j2 | 55 ++ .cookiecutter_includes/workflows/tests.j2 | 55 ++ .cookiecutter_includes/workflows/typecheck.j2 | 55 ++ .github/CODEOWNERS | 2 + .github/CODE_OF_CONDUCT.md | 102 +++ .github/CONTRIBUTING.md | 119 +++ .github/FUNDING.yml | 18 +- .github/ISSUE_TEMPLATE/01-bug-report.yml | 69 ++ .github/ISSUE_TEMPLATE/02-feature-request.yml | 61 ++ .github/ISSUE_TEMPLATE/config.yml | 26 + .github/ISSUE_TEMPLATE/z-developer-issue.yml | 33 + .../01-default-pull-request.md | 24 + .github/PULL_REQUEST_TEMPLATE/02-bug-fix.md | 20 + .../03-feature-request.md | 21 + .github/SECURITY.md | 24 + .github/SUPPORT.md | 36 + .github/pull_request_template.md | 5 + .github/workflows/cla.yml | 64 ++ .github/workflows/dependency-check.yml | 19 +- .github/workflows/format-check.yml | 19 +- .github/workflows/jekyll-gh-pages.yml | 41 +- .github/workflows/lint-check.yml | 21 +- .github/workflows/security-audit.yml | 19 +- .github/workflows/spellcheck.yml | 19 +- .github/workflows/tests.yml | 19 +- .github/workflows/typecheck.yml | 19 +- .gitignore | 17 +- .jinja-runtime.json | 14 + .markdownlint.yaml | 63 ++ .pre-commit-config.yaml | 17 +- .yamllint | 17 +- LICENSE | 678 ----------------- LICENSE.md | 660 ++++++++++++++++ Makefile | 47 +- cliff.toml | 18 +- cspell.json | 21 +- docs/cookiecutter_input.json | 27 +- .../appspecific/com.chrome.devtools.json | 1 + docs/jekyll/Gemfile | 22 +- docs/jekyll/Makefile | 19 +- docs/jekyll/README.md | 48 +- docs/jekyll/_config.yml | 64 +- .../contribute/create-feature-request.md | 59 ++ .../_manual/contribute/create-pull-request.md | 18 + .../_manual/contribute/developer-guide.md | 82 ++ .../_manual/contribute/git-commit-message.md | 39 + docs/jekyll/_manual/contribute/index.md | 21 + .../_manual/contribute/merge-pull-request.md | 61 ++ .../_manual/contribute/style-guides/index.md | 12 + .../_manual/contribute/style-guides/python.md | 7 + .../contribute/style-guides/typescript.md | 7 + .../_manual/contribute/style-guides/yaml.md | 7 + .../developer-resources/cla-privacy-policy.md | 20 + .../jekyll/_manual/developer-resources/cla.md | 26 + .../_manual/developer-resources/contribute.md | 33 + .../_manual/developer-resources/index.md | 13 + .../_manual/introduction/getting-started.md | 53 ++ docs/jekyll/_manual/introduction/index.md | 10 + .../introduction/installation-guide.md | 7 + docs/jekyll/_manual/setup-guide/index.md | 9 + .../_manual/setup-guide/requirements.md | 30 + docs/jekyll/_manual/troubleshooting/faq.md | 8 + docs/jekyll/_manual/troubleshooting/index.md | 9 + .../_manual/tutorials/create-virtual-env.md | 27 + docs/jekyll/_manual/tutorials/index.md | 10 + docs/jekyll/_manual/tutorials/nutri-matic.md | 25 + docs/jekyll/_manual/upgrade-guide/index.md | 13 + docs/jekyll/_manual/whatsnew/index.md | 7 + docs/jekyll/_resources/repository-link.md | 5 + docs/jekyll/docs/cookiecutter_input.json | 18 +- docs/jekyll/index.md | 12 +- hooks/post_gen_project.py | 17 +- hooks/pre_gen_project.py | 17 +- pyproject.toml | 35 +- tests/test_bake_project.py | 17 +- 125 files changed, 6334 insertions(+), 1165 deletions(-) create mode 100644 .cookiecutter_includes/community_health_files/__init__.j2 create mode 100644 .cookiecutter_includes/community_health_files/code_of_conduct.j2 create mode 100644 .cookiecutter_includes/community_health_files/codeowners.j2 create mode 100644 .cookiecutter_includes/community_health_files/contributing.j2 create mode 100644 .cookiecutter_includes/community_health_files/funding.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/__init__.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/config.j2 create mode 100644 .cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2 create mode 100644 .cookiecutter_includes/community_health_files/pull_request_template/__init__.j2 create mode 100644 .cookiecutter_includes/community_health_files/security.j2 create mode 100644 .cookiecutter_includes/community_health_files/support.j2 create mode 100644 .cookiecutter_includes/license/0bsd.j2 create mode 100644 .cookiecutter_includes/license/__init__.j2 create mode 100644 .cookiecutter_includes/license/agpl-3.0.j2 create mode 100644 .cookiecutter_includes/license/apache-2.0.j2 create mode 100644 .cookiecutter_includes/license/bsd-2-clause.j2 create mode 100644 .cookiecutter_includes/license/bsd-3-clause.j2 create mode 100644 .cookiecutter_includes/license/gpl-3.0.j2 create mode 100644 .cookiecutter_includes/license/license-data.j2 create mode 100644 .cookiecutter_includes/license/license-header.j2 create mode 100644 .cookiecutter_includes/license/license.j2 create mode 100644 .cookiecutter_includes/license/mit.j2 create mode 100644 .cookiecutter_includes/license/unlicense.j2 delete mode 100644 .cookiecutter_includes/license_header.j2 create mode 100644 .cookiecutter_includes/workflows/__init__.j2 create mode 100644 .cookiecutter_includes/workflows/contributor-assistant.j2 create mode 100644 .cookiecutter_includes/workflows/dependency-check.j2 create mode 100644 .cookiecutter_includes/workflows/format-check.j2 create mode 100644 .cookiecutter_includes/workflows/jekyll-gh-pages.j2 create mode 100644 .cookiecutter_includes/workflows/lint-check.j2 create mode 100644 .cookiecutter_includes/workflows/security-audit.j2 create mode 100644 .cookiecutter_includes/workflows/spellcheck.j2 create mode 100644 .cookiecutter_includes/workflows/tests.j2 create mode 100644 .cookiecutter_includes/workflows/typecheck.j2 create mode 100644 .github/CODEOWNERS create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/z-developer-issue.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/01-default-pull-request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/02-bug-fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/03-feature-request.md create mode 100644 .github/SECURITY.md create mode 100644 .github/SUPPORT.md create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/cla.yml create mode 100644 .jinja-runtime.json create mode 100644 .markdownlint.yaml delete mode 100644 LICENSE create mode 100644 LICENSE.md create mode 100644 docs/jekyll/.well-known/appspecific/com.chrome.devtools.json create mode 100644 docs/jekyll/_manual/contribute/create-feature-request.md create mode 100644 docs/jekyll/_manual/contribute/create-pull-request.md create mode 100644 docs/jekyll/_manual/contribute/developer-guide.md create mode 100644 docs/jekyll/_manual/contribute/git-commit-message.md create mode 100644 docs/jekyll/_manual/contribute/index.md create mode 100644 docs/jekyll/_manual/contribute/merge-pull-request.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/index.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/python.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/typescript.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/yaml.md create mode 100644 docs/jekyll/_manual/developer-resources/cla-privacy-policy.md create mode 100644 docs/jekyll/_manual/developer-resources/cla.md create mode 100644 docs/jekyll/_manual/developer-resources/contribute.md create mode 100644 docs/jekyll/_manual/developer-resources/index.md create mode 100644 docs/jekyll/_manual/introduction/getting-started.md create mode 100644 docs/jekyll/_manual/introduction/index.md create mode 100644 docs/jekyll/_manual/introduction/installation-guide.md create mode 100644 docs/jekyll/_manual/setup-guide/index.md create mode 100644 docs/jekyll/_manual/setup-guide/requirements.md create mode 100644 docs/jekyll/_manual/troubleshooting/faq.md create mode 100644 docs/jekyll/_manual/troubleshooting/index.md create mode 100644 docs/jekyll/_manual/tutorials/create-virtual-env.md create mode 100644 docs/jekyll/_manual/tutorials/index.md create mode 100644 docs/jekyll/_manual/tutorials/nutri-matic.md create mode 100644 docs/jekyll/_manual/upgrade-guide/index.md create mode 100644 docs/jekyll/_manual/whatsnew/index.md create mode 100644 docs/jekyll/_resources/repository-link.md diff --git a/.cookiecutter_includes/community_health_files/__init__.j2 b/.cookiecutter_includes/community_health_files/__init__.j2 new file mode 100644 index 0000000..607f91b --- /dev/null +++ b/.cookiecutter_includes/community_health_files/__init__.j2 @@ -0,0 +1,35 @@ +{# +# community_health_files/__init__.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/community_health_files/code_of_conduct.j2' as _code_of_conduct with context %} +{% import '.cookiecutter_includes/community_health_files/codeowners.j2' as _codeowners with context %} +{% import '.cookiecutter_includes/community_health_files/contributing.j2' as _contributing with context %} +{% import '.cookiecutter_includes/community_health_files/funding.j2' as _funding with context %} +{% import '.cookiecutter_includes/community_health_files/pull_request_template.j2' as _pull_request_template with context %} +{% import '.cookiecutter_includes/community_health_files/security.j2' as _security with context %} +{% import '.cookiecutter_includes/community_health_files/support.j2' as _support with context %} + +{% set code_of_conduct = _code_of_conduct %} +{% set codeowners = _codeowners %} +{% set contributing = _contributing %} +{% set funding = _funding %} +{% set pull_request_template = _pull_request_template %} +{% set security = _security %} +{% set support = _support %} diff --git a/.cookiecutter_includes/community_health_files/code_of_conduct.j2 b/.cookiecutter_includes/community_health_files/code_of_conduct.j2 new file mode 100644 index 0000000..082ebb8 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/code_of_conduct.j2 @@ -0,0 +1,125 @@ +{# +# code_of_conduct.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +# Community Code of Conduct + +## Our Pledge + +We pledge to make our community welcoming, safe, and equal for all. + +We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant. + + +## Encouraged Behaviors + +While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language. + +With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including: + +1. Respecting the **purpose of our community**, our activities, and our ways of gathering. +2. Engaging **kindly and honestly** with others. +3. Respecting **different viewpoints** and experiences. +4. **Taking responsibility** for our actions and contributions. +5. Gracefully giving and accepting **constructive feedback**. +6. Committing to **repairing harm** when it occurs. +7. Behaving in other ways that promote and sustain the **well-being of our community**. + + +## Restricted Behaviors + +We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct. + +1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop. +2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. +3. **Stereotyping or discrimination.** Characterizing anyoneโ€™s personality or behavior on the basis of immutable identities or traits. +4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. +5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission. +6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. +7. Behaving in other ways that **threaten the well-being** of our community. + +### Other Restrictions + +1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions. +2. **Failing to credit sources.** Not properly crediting the sources of content you contribute. +3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community. +4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. + + +## Reporting an Issue + +Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. + +When an incident does occur, it is important to report it promptly. + +To report a possible violation, please email [{{ cookiecutter.github_username }}'s Email](mailto:{{ cookiecutter.email }}?subject=Report:%20Community%20Code%20of%20Conduct). + +All reports will be handled with strict confidentiality. Your email should include: + +* **Date and time** of the incident. +* **A description** of what occurred. +* **Links or screenshots** to any relevant public or private messages/logs. +* **Witnesses**, if any were present. + + + +Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution. + + +## Addressing and Repairing Harm + +If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped. + +1) Warning + 1) Event: A violation involving a single incident or series of incidents. + 2) Consequence: A private, written warning from the Community Moderators. + 3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations. +2) Temporarily Limited Activities + 1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation. + 2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members. + 3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over. +3) Temporary Suspension + 1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation. + 2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions. + 3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted. +4) Permanent Ban + 1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member. + 2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior. + 3) Repair: There is no possible repair in cases of this severity. + +This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community. + + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + + +## Attribution + +This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). This version has been modified to replace "equity" with "equal." + +Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) + +For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozillaโ€™s code of conduct team](https://github.com/mozilla/inclusion). +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/codeowners.j2 b/.cookiecutter_includes/community_health_files/codeowners.j2 new file mode 100644 index 0000000..a1b2798 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/codeowners.j2 @@ -0,0 +1,25 @@ +{# +# codeowners.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +# Global owner for the repository +* @{{ cookiecutter.github_username }} +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/contributing.j2 b/.cookiecutter_includes/community_health_files/contributing.j2 new file mode 100644 index 0000000..d68f6c8 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/contributing.j2 @@ -0,0 +1,148 @@ +{# +# contributing.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +# Contributing to {{ cookiecutter.project_name }} + +You want to contribute to {{ cookiecutter.project_name }}? Welcome! Please read this document to understand what you can do: + +* [Help Others](#help-others) +* [Analyze Issues](#analyze-issues) +* [Report an Issue](#report-an-issue) +* [Contribute Code](#contribute-code) + +## Help Others + +You can help {{ cookiecutter.project_name }} by helping others who use it and need support. + +## Analyze Issues + +Analyzing issue reports can be a lot of effort. Any help is welcome! +Go to [the GitHub issue tracker]({{ cookiecutter.repo_url }}/issues?state=open) and find an open issue which needs additional work or a bugfix (e.g. issues labeled with "help wanted" or "bug"). + +Additional work could include any further information, or a gist, or it might be a hint that helps understanding the issue. Maybe you can even find and [contribute](#contribute-code) a bugfix? + +## Report an Issue + +If you find a bug - behavior of {{ cookiecutter.project_name }} code contradicting your expectation - you are welcome to report it. +We can only handle well-reported, actual bugs, so please follow the guidelines below. + +Once you have familiarized with the guidelines, you can go to the [GitHub issue tracker for {{ cookiecutter.project_name }}]({{ cookiecutter.repo_url }}/issues/new) to report the issue. + +### Quick Checklist for Bug Reports + +Issue report checklist: +* Real, current bug +* No duplicate +* Reproducible +* Good summary +* Well-documented +* Minimal example +* Use the [bug template](ISSUE_TEMPLATE/01-bug-report.yml) + +### Issue handling process + +When an issue is reported, a committer will look at it and either confirm it as a real issue, close it if it is not an issue, or ask for more details. + +An issue that is about a real bug is closed as soon as the fix is committed. + +### Reporting Security Issues + +If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. +Please send the related information to [jcook3701's email](mailto:jcook3701+{{ cookiecutter.project_slug }}@gmail.com?subject=Report:%20Security%20Vulnerability). + +### Usage of Labels + +GitHub offers labels to categorize issues. We defined the following labels so far: + +Labels for issue categories: +* bug: this issue is a bug in the code +* feature: this issue is a request for a new functionality or an enhancement request +* design: this issue relates to the UI or UX design of the tool + +Status of open issues: +* help wanted: the feature request is approved and you are invited to contribute + +Status/resolution of closed issues: +* wontfix: while acknowledged to be an issue, a fix cannot or will not be provided + +The labels can only be set and modified by committers. + +### Issue Reporting Disclaimer + +We want to improve the quality of, {{ cookiecutter.project_name }}, and good bug reports are welcome! But our capacity is limited, thus we reserve the right to close or to not process insufficient bug reports in favor of those which are very cleanly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it will not happen - remember: {{ cookiecutter.project_name }} is Open Source and comes without warranty. + +Bug report analysis support is very welcome! (e.g. pre-analysis or proposing solutions) + +## Contribute Code + +You are welcome to contribute code to {{ cookiecutter.project_name }} in order to fix bugs or to implement new features. + +There are three important things to know: +1. You must be aware that you need to submit [{{ cookiecutter.contribution_model | upper }}]({{ cookiecutter.github_io }}/manual/developer-resources/{{ cookiecutter.contribution_model | lower }}) in order for your contribution to be accepted. This is common practice in all major Open Source projects. +2. There are **several requirements regarding code style, quality, and product standards** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines. +3. **Not all proposed contributions can be accepted**. Some features may e.g. just fit a third-party add-on better. The code must fit the overall direction of {{ cookiecutter.project_name }} and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the feature you plan to implement (make it clear you intend to contribute). + +{% if cookiecutter.contribution_model|lower == 'cla' %} +## Contributor License Agreement (CLA) + +Due to legal reasons, contributors will be asked to accept a [CLA]({{ cookiecutter.github_io }}/manual/developer-resources/cla) before they submit the first pull request to this project, this happens in an automated fashion during the submission process. We use a derivative of the [ASF Contributor Agreements](https://www.apache.org/licenses/contributor-agreements.html) as can be found below. + +* [ICLA](https://www.apache.org/licenses/icla.pdf) +* [CCLA](https://www.apache.org/licenses/cla-corporate.pdf). +{% elif cookiecutter.contribution_model|lower == 'dco' %} +## Developer Certificate of Origin (DCO) + +Due to legal reasons, contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. We use [the standard DCO text of the Linux Foundation](https://developercertificate.org/). +{% endif %} + +### Contribution Content Guidelines + +These are some of the rules we try to follow: +* Apply a clean coding style adapted to the surrounding code, even though we are aware the existing code is not fully clean +* Use (4)spaces for indentation (except if the modified file consistently uses tabs) +* Use variable naming conventions like in the other files you are seeing (underscore) +* No console.log() - use logging service +* Run all ci/cd code checks and make sure they succeed +* Comment your code where it gets non-trivial +* Keep an eye on performance and memory consumption, properly destroy objects when not used anymore +* Write a unit test +* Do not do any incompatible changes, especially do not modify the name or behavior of public API methods or properties + +### How to contribute - the Process + +1. Make sure the change would be welcome (e.g. a bugfix or a useful feature); best do so by proposing it in a GitHub issue +2. Create a branch forking the {{ cookiecutter.project_slug }} repository and do your change +3. Commit and push your changes on that branch +4. In the commit message + * Describe the problem you fix with this change. + * Describe the effect that this change has from a user's point of view. App crashes and lockups are pretty convincing for example, but not all bugs are that obvious and should be mentioned in the text. + * Describe the technical details of what you changed. It is important to describe the change in a most understandable way so the reviewer is able to verify that the code is behaving as you intend it to. +5. If your change fixes an issue reported at GitHub, add the following line to the commit message: + * ```Fixes #(issueNumber)``` + * Do NOT add a colon after "Fixes" - this prevents automatic closing. +6. Create a Pull Request +7. Follow the link posted by the, {{ cookiecutter.project_name }}, project to your pull request and accept it, as described in detail above. +8. Wait for our code review and approval, possibly enhancing your change on request + * Note that the {{ cookiecutter.project_name }} developers also have their regular duties, so depending on the required effort for reviewing, testing and clarification this may take a while +9. Once the change has been approved we will inform you in a comment +10. We will close the pull request, feel free to delete the now obsolete branch +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/funding.j2 b/.cookiecutter_includes/community_health_files/funding.j2 new file mode 100644 index 0000000..bfbd27f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/funding.j2 @@ -0,0 +1,34 @@ +{# +# funding.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='FUNDING.yml', + comment_style='hash') -}} +--- + +# github: ["{{ cookiecutter.github_username }}"] +buy_me_a_coffee: "{{ cookiecutter.buymeacoffee_username }}" +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2 b/.cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2 new file mode 100644 index 0000000..b7122ec --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2 @@ -0,0 +1,82 @@ +{# +# 01-bug-report.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='01-bug-report.yml', + comment_style='hash') -}} +--- +name: ๐Ÿž Bug Report +description: File a bug report for this template. +title: "[Bug]: " +labels: ["bug"] +assignees: + - {{ cookiecutter.github_username }} +body: + - type: markdown + attributes: + value: | + Thanks for reporting a bug! Please provide as much detail as possible to help us fix it. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: What did you expect to happen vs what actually happened? + placeholder: Describe the error here... + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating System + description: What OS are you running cookiecutter on? + options: + - Windows + - macOS + - Linux + validations: + required: true + - type: input + id: cc-version + attributes: + label: Cookiecutter Version + description: Run 'cookiecutter --version' and paste the output. + placeholder: e.g. 2.6.0 + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output or Error Message + description: Please copy and paste the traceback or error message here. + render: shell + - type: checkboxes + id: terms + attributes: + label: Acknowledgement + options: + - label: I have checked the existing issues for similar reports. + required: true +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2 b/.cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2 new file mode 100644 index 0000000..4048ce4 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2 @@ -0,0 +1,74 @@ +{# +# 02-feature-request.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='02-feature-request.yml', + comment_style='hash') -}} +--- +name: ๐Ÿ’ก Feature Request +description: Suggest an idea for this cookiecutter template. +title: "[Feature]: " +labels: ["enhancement"] +assignees: + - {{ cookiecutter.github_username }} +body: + - type: markdown + attributes: + value: | + Got a great idea for this template? We'd love to hear it! + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: "Ex. I'm always frustrated when [...]" + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + placeholder: "Ex. It would be great if the template automatically [...]" + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + - type: checkboxes + id: contribution + attributes: + label: Contribution + options: + - label: I would be willing to submit a pull request to implement this feature myself! +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/issue_template/__init__.j2 b/.cookiecutter_includes/community_health_files/issue_template/__init__.j2 new file mode 100644 index 0000000..837c0c8 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/__init__.j2 @@ -0,0 +1,30 @@ +{# +# community_health_files/issue_template/__init__.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/community_health_files/issue_template/01-bug-report.j2' as _bug_report with context %} +{% import '.cookiecutter_includes/community_health_files/issue_template/02-feature-request.j2' as _feature_request with context %} +{% import '.cookiecutter_includes/community_health_files/issue_template/config.j2' as _config with context %} +{% import '.cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2' as _developer_issue with context %} + + +{% set bug_report = _bug_report %} +{% set feature_request = _feature_request %} +{% set config = _config %} +{% set developer_issue = _developer_issue %} diff --git a/.cookiecutter_includes/community_health_files/issue_template/config.j2 b/.cookiecutter_includes/community_health_files/issue_template/config.j2 new file mode 100644 index 0000000..e402301 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/config.j2 @@ -0,0 +1,39 @@ +{# +# config.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='ISSUE_TEMPLATE/config.yml.yml', + comment_style='hash') -}} +--- +blank_issues_enabled: false +contact_links: + - name: GitHub Community Support + url: https://github.com/orgs/community/discussions + about: Please ask and answer questions here. + - name: GitHub Security Bug Bounty + url: https://bounty.github.com/ + about: Please report security vulnerabilities here. +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2 b/.cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2 new file mode 100644 index 0000000..bf1b5a9 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/issue_template/z-developer-issue.j2 @@ -0,0 +1,46 @@ +{# +# z-developer-issues.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='z-developer-issue.yml', + comment_style='hash') -}} +--- +name: "๐Ÿ› ๏ธ Developer / General Issue" +description: "Blank template for contributors and maintainers (no form)." +title: "[Dev]: " +labels: ["internal"] +assignees: + - {{ cookiecutter.github_username }} +body: + - type: textarea + id: content + attributes: + label: Issue Content + description: "Free-form text area for developer tasks, refactoring, or general notes." + placeholder: "Describe the task or internal update..." + validations: + required: true +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/pull_request_template.j2 b/.cookiecutter_includes/community_health_files/pull_request_template.j2 new file mode 100644 index 0000000..433f2f5 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template.j2 @@ -0,0 +1,28 @@ +{# +# pull_request_template.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +### ๐Ÿ“‹ Select a Pull Request Template +Please switch to the **Preview** tab and select the correct type: +* [Standard PR](?template=01-default-pull-request.md) +* [Bug Fix](?template=02-bug-fix.md) +* [Feature Request](?template=03-feature-request.md) +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2 b/.cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2 new file mode 100644 index 0000000..67a73ef --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2 @@ -0,0 +1,47 @@ +{# +# 01-default-pull-request.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +## Description + + +## Related Issue + +Fixes # + +## Type of Change +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update + +## How Has This Been Tested? + +- [ ] Unit tests pass locally +- [ ] Manual verification (provide details below) + +## Checklist +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2 b/.cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2 new file mode 100644 index 0000000..38fc40c --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2 @@ -0,0 +1,43 @@ +{# +# 02-bug-fix.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +## ๐Ÿž Bug Fix Description + + +**Related Issue:** Fixes # + +### ๐Ÿ› ๏ธ Changes Made +- [ ] List specific changes or files modified. +- [ ] Describe how the fix addresses the root cause. + +### ๐Ÿงช How to Reproduce & Test +1. **Steps to reproduce:** (e.g., click X, then Y) +2. **Current behavior:** (before this fix) +3. **Expected behavior:** (after this fix) +4. **Testing performed:** (e.g., ran `pytest` or actions performed to recreate live testing situation) + +### โœ… Checklist +- [ ] My code follows the project style guidelines. +- [ ] I have performed a self-review of my code. +- [ ] I have added tests that prove my fix is effective. +- [ ] All new and existing tests passed. +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2 b/.cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2 new file mode 100644 index 0000000..ddc5c5f --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2 @@ -0,0 +1,44 @@ +{# +# 03-feature-request.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +## โœจ New Feature Description + + +**Related Issue:** Resolves # + +### ๐Ÿš€ Proposed Changes +- [ ] Detail the new components, logic, or UI added. +- [ ] Mention any new dependencies introduced. + +### ๐Ÿ“ธ Screenshots / Demos (If Applicable) + + +### ๐Ÿ› ๏ธ Technical Details +- [ ] Architecture changes (if any). +- [ ] New environment variables or configurations required. + +### โœ… Checklist +- [ ] My code follows the project style guidelines. +- [ ] I have updated the documentation accordingly. +- [ ] I have added/updated tests for this feature. +- [ ] My changes generate no new warnings or console errors. +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/pull_request_template/__init__.j2 b/.cookiecutter_includes/community_health_files/pull_request_template/__init__.j2 new file mode 100644 index 0000000..068cbbb --- /dev/null +++ b/.cookiecutter_includes/community_health_files/pull_request_template/__init__.j2 @@ -0,0 +1,27 @@ +{# +# community_health_files/pull_request_template/__init__.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/community_health_files/pull_request_template/01-default-pull-request.j2' as _default_pull_request with context %} +{% import '.cookiecutter_includes/community_health_files/pull_request_template/02-bug-fix.j2' as _bug_fix with context %} +{% import '.cookiecutter_includes/community_health_files/pull_request_template/03-feature-request.j2' as _feature_request with context %} + +{% set default_pull_request = _default_pull_request %} +{% set bug_fix = _bug_fix %} +{% set feature_request = _feature_request %} diff --git a/.cookiecutter_includes/community_health_files/security.j2 b/.cookiecutter_includes/community_health_files/security.j2 new file mode 100644 index 0000000..15bba62 --- /dev/null +++ b/.cookiecutter_includes/community_health_files/security.j2 @@ -0,0 +1,47 @@ +{# +# security.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +# Security Vulnerabilities + +The {{ cookiecutter.project_name }} project is built with security and data privacy in mind to ensure your data is safe. + +## Reporting +We are grateful for security researchers and users reporting a vulnerability to us, first. To ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities can be assured, please follow the below guideline. + +**Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.** + +For reporting a vulnerability, please send an email directly to [jcook3701's email](mailto:jcook3701+security-vulnerability@gmail.com?subject=Report:%20Security%20Vulnerability). + +To help us verify and resolve issues efficiently, please ensure your security vulnerability report includes the following: + +* **Vulnerability Type** and the specific component or URL affected. +* **Detailed Steps** to Reproduce the issue, including any specific configurations needed. +* **Proof of Concept (PoC)** such as HTTP requests, scripts, or screen recordings. +* **Impact Assessment** describing what a successful exploit would allow an attacker to do. +* **Reproduction Environment** details, including the browser, OS, or software version used. +* **Suggested Mitigation** or fix, if you have identified one. + +All reports are handled with strict confidentiality. We ask that you follow responsible disclosure by giving us reasonable time to investigate and fix the issue before sharing any details publicly. + +## Disclosure Handling +We are committed to timely review and respond to your request. The resolution of code defects will be handled by a dedicated group of security experts and prepared in a private GitHub repository. The project will inform the public about resolved security vulnerabilities via GitHub Security Advisories. +{% endmacro %} diff --git a/.cookiecutter_includes/community_health_files/support.j2 b/.cookiecutter_includes/community_health_files/support.j2 new file mode 100644 index 0000000..8a012dd --- /dev/null +++ b/.cookiecutter_includes/community_health_files/support.j2 @@ -0,0 +1,59 @@ +{# +# support.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +# Support Guidelines + +Thank you for using the {{ cookiecutter.project_name }} project! To help us maintain it efficiently, please check these resources before opening an issue. + +## ๐Ÿ› ๏ธ Getting Help +* **Documentation:** Start by reading our [Project Wiki]({{ cookiecutter.github_io }}). +* **FAQ:** Common questions are answered in our [Frequently Asked Questions]({{ cookiecutter.github_io }}/manual/troubleshooting/faq). +* **Community Forums:** For general questions and "how-to" help, please use [GitHub Discussions]({{ cookiecutter.repo_url }}/discussions) instead of Issues. + +## ๐Ÿ› Reporting Bugs +If you have found a bug, please: +1. Search existing [Issues]({{ cookiecutter.repo_url }}/issues?state=open) to see if it has already been reported. +2. Follow the [bug report template](ISSUE_TEMPLATE/01-bug-report.yml) to provide a reproducible example. + +## ๐Ÿ”’ Security Vulnerabilities +Please **do not** report security vulnerabilities via public issues. Instead, follow our [Security Policy]({{ cookiecutter.repo_url }}/blob/{{ cookiecutter._default_branch }}/.github/SECURITY.md) to report them privately. + +## โณ Response Times +This is an open-source project maintained by volunteers. We try to respond within **48-72 hours**, but please be patient as we balance this with other commitments. + +## ๐ŸŒฑ Funding and Sponsorship + +{{ cookiecutter.project_name }} is an open-source project maintained by volunteers. Your financial support helps sustain the project by covering: + +* **Infrastructure costs:** Domain names, hosting, and CI/CD services. +* **Time:** Allowing maintainers to dedicate more time to bug fixes and new features. + +If this project has helped you, please consider supporting us through one of the following methods: + +* **[Buy Me a Coffee](https://buymeacoffee.com/{{ cookiecutter.buymeacoffee_username }}):** A simple way to provide a one-time donation. + +We greatly appreciate your support! +{% endmacro %} diff --git a/.cookiecutter_includes/gitignore.j2 b/.cookiecutter_includes/gitignore.j2 index c05f9db..7c9336e 100644 --- a/.cookiecutter_includes/gitignore.j2 +++ b/.cookiecutter_includes/gitignore.j2 @@ -1,21 +1,21 @@ {# # gitignore.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {% macro gitignore( @@ -58,7 +58,7 @@ dist/ *.o *.a *.out -{% elif template_type in ["cookiecutter", "python"] %} +{% elif template_type in ["cookiecutter", "documentation", "python"] %} {{ python }} {% elif template_type == "ros2" %} # ========================================= diff --git a/.cookiecutter_includes/license/0bsd.j2 b/.cookiecutter_includes/license/0bsd.j2 new file mode 100644 index 0000000..45e8d45 --- /dev/null +++ b/.cookiecutter_includes/license/0bsd.j2 @@ -0,0 +1,42 @@ +{# +# obsd.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% set spdx = ["0BSD"] %} + +{% set license_header %}{% endset %} + +{% macro license( + copyright +) %} +# BSD Zero Clause License + +{{ copyright }} + +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. +{% endmacro %} diff --git a/.cookiecutter_includes/license/__init__.j2 b/.cookiecutter_includes/license/__init__.j2 new file mode 100644 index 0000000..d6e073a --- /dev/null +++ b/.cookiecutter_includes/license/__init__.j2 @@ -0,0 +1,25 @@ +{# +# license/__init__.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/license/license.j2' as _license with context %} +{% import '.cookiecutter_includes/license/license-header.j2' as _license_header with context %} + +{% set license = _license %} +{% set license_header = _license_header %} diff --git a/.cookiecutter_includes/license/agpl-3.0.j2 b/.cookiecutter_includes/license/agpl-3.0.j2 new file mode 100644 index 0000000..8d9a049 --- /dev/null +++ b/.cookiecutter_includes/license/agpl-3.0.j2 @@ -0,0 +1,699 @@ +{# +# agpl-3.0.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% set spdx = ["AGPL-3.0-or-later", "AGPL-3.0-only"] %} + +{% set license_header %} +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as +published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . +{% endset %} + +{% set license %} +# GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU AGPL, see . +{% endset %} diff --git a/.cookiecutter_includes/license/apache-2.0.j2 b/.cookiecutter_includes/license/apache-2.0.j2 new file mode 100644 index 0000000..59068af --- /dev/null +++ b/.cookiecutter_includes/license/apache-2.0.j2 @@ -0,0 +1,237 @@ +{# +# apache-2.0.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% set spdx = ["Apache-2.0"] %} + +{% set license_header %} +SPDX-License-Identifier: Apache-2.0 + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + www.apache.org + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +{% endset %} + +{# TODO: This still needs NOTICE file. #} +{# TODO: Remove notice file with post-gen-hooks if Apache-2.0 not set. #} + + +{% set license %} +# Apache License + +_Version 2.0, January 2004_ +_<>_ + +### Terms and Conditions for use, reproduction, and distribution + +#### 1. Definitions + +โ€œLicenseโ€ shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +โ€œLicensorโ€ shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +โ€œLegal Entityโ€ shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, โ€œcontrolโ€ means **(i)** the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the +outstanding shares, or **(iii)** beneficial ownership of such entity. + +โ€œYouโ€ (or โ€œYourโ€) shall mean an individual or Legal Entity exercising +permissions granted by this License. + +โ€œSourceโ€ form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +โ€œObjectโ€ form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +โ€œWorkโ€ shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +โ€œDerivative Worksโ€ shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +โ€œContributionโ€ shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +โ€œsubmittedโ€ means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as โ€œNot a Contribution.โ€ + +โ€œContributorโ€ shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +#### 2. Grant of Copyright License + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +#### 3. Grant of Patent License + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +#### 4. Redistribution + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +* **(a)** You must give any other recipients of the Work or Derivative Works a copy of +this License; and +* **(b)** You must cause any modified files to carry prominent notices stating that You +changed the files; and +* **(c)** You must retain, in the Source form of any Derivative Works that You distribute, +all copyright, patent, trademark, and attribution notices from the Source form +of the Work, excluding those notices that do not pertain to any part of the +Derivative Works; and +* **(d)** If the Work includes a โ€œNOTICEโ€ text file as part of its distribution, then any +Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices +that do not pertain to any part of the Derivative Works, in at least one of the +following places: within a NOTICE text file distributed as part of the +Derivative Works; within the Source form or documentation, if provided along +with the Derivative Works; or, within a display generated by the Derivative +Works, if and wherever such third-party notices normally appear. The contents of +the NOTICE file are for informational purposes only and do not modify the +License. You may add Your own attribution notices within Derivative Works that +You distribute, alongside or as an addendum to the NOTICE text from the Work, +provided that such additional attribution notices cannot be construed as +modifying the License. + +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +#### 5. Submission of Contributions + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +#### 6. Trademarks + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +#### 7. Disclaimer of Warranty + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an โ€œAS ISโ€ BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +#### 8. Limitation of Liability + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +#### 9. Accepting Warranty or Additional Liability + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. + +_END OF TERMS AND CONDITIONS_ + +### APPENDIX: How to apply the Apache License to your work + +To apply the Apache License to your work, attach the following boilerplate +notice, with the fields enclosed by brackets `[]` replaced with your own +identifying information. (Don't include the brackets!) The text should be +enclosed in the appropriate comment syntax for the file format. We also +recommend that a file or class name and description of purpose be included on +the same โ€œprinted pageโ€ as the copyright notice for easier identification within +third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +{% endset %} diff --git a/.cookiecutter_includes/license/bsd-2-clause.j2 b/.cookiecutter_includes/license/bsd-2-clause.j2 new file mode 100644 index 0000000..84df612 --- /dev/null +++ b/.cookiecutter_includes/license/bsd-2-clause.j2 @@ -0,0 +1,55 @@ +{# +# bsd-2-clause.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% set spdx = ["BSD-2-Clause"] %} + +{% set license_header %}{% endset %} + +{%- macro license( + copyright +) -%} +# BSD 2-Clause License + +{{ copyright }} + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS โ€œAS ISโ€ AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The views and conclusions contained in the software and documentation are those +of the authors and should not be interpreted as representing official policies, +either expressed or implied, of the FreeBSD Project. +{% endmacro %} diff --git a/.cookiecutter_includes/license/bsd-3-clause.j2 b/.cookiecutter_includes/license/bsd-3-clause.j2 new file mode 100644 index 0000000..5b0e68e --- /dev/null +++ b/.cookiecutter_includes/license/bsd-3-clause.j2 @@ -0,0 +1,54 @@ +{# +# bsd-3-clause.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% set spdx = ["BSD-3-Clause"] %} + +{% set license_header %}{% endset %} + +{%- macro license( + copyright +) -%} +# BSD 3-Clause License + +{{ copyright }} + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. Neither the name of the `` nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS โ€œAS ISโ€ AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL `` BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +{% endmacro %} diff --git a/.cookiecutter_includes/license/gpl-3.0.j2 b/.cookiecutter_includes/license/gpl-3.0.j2 new file mode 100644 index 0000000..75a72a1 --- /dev/null +++ b/.cookiecutter_includes/license/gpl-3.0.j2 @@ -0,0 +1,714 @@ +{# +# gpl-3.0.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% set spdx = ["GPL-3.0-or-later", "GPL-3.0-only"] %} + +{% set license_header %} +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +{% endset %} + +{% set license %} +# GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . +{% endset %} diff --git a/.cookiecutter_includes/license/license-data.j2 b/.cookiecutter_includes/license/license-data.j2 new file mode 100644 index 0000000..e71d57c --- /dev/null +++ b/.cookiecutter_includes/license/license-data.j2 @@ -0,0 +1,157 @@ +{# +# license-data.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/license/0bsd.j2' as _0bsd with context %} +{% import '.cookiecutter_includes/license/agpl-3.0.j2' as _agpl_3_0 with context %} +{% import '.cookiecutter_includes/license/apache-2.0.j2' as _apache_2_0 with context %} +{% import '.cookiecutter_includes/license/bsd-2-clause.j2' as _bsd_2_clause with context %} +{% import '.cookiecutter_includes/license/bsd-3-clause.j2' as _bsd_3_clause with context %} +{% import '.cookiecutter_includes/license/gpl-3.0.j2' as _gpl_3_0 with context %} +{% import '.cookiecutter_includes/license/mit.j2' as _mit with context %} +{% import '.cookiecutter_includes/license/unlicense.j2' as _unlicense with context %} + +{% set zero_bsd = _0bsd %} +{% set agpl_3_0 = _agpl_3_0 %} +{% set apache_2_0 = _apache_2_0 %} +{% set bsd_2_clause = _bsd_2_clause %} +{% set bsd_3_clause = _bsd_3_clause %} +{% set gpl_3_0 = _gpl_3_0 %} +{% set mit = _mit %} +{% set unlicense = _unlicense %} + +{%- macro spdx( + license, + copyright, + project_name +) -%} + {# + This renders license SPDX. + + Args: + license (str): The SPDX identifier (e.g., 'MIT', 'BSD-3-Clause'). + copyright (str): The copyright holder line (e.g., '2026 Jane Doe'). + project_name (str): Name of project for copyright. + + Returns: + str: the formatted license SPDX text. + #} + {%- set year %}{% now "utc", "%Y" %}{% endset -%} + {%- set spdx_copyright = "SPDX-FileCopyrightText: " ~ copyright -%} + {%- set spdx_license = "SPDX-License-Identifier: " ~ license -%} + {%- set sdpx_text -%} + {{- spdx_copyright -}}{{- "\n" -}} + {{- spdx_license -}} + {%- endset -%} + {{ sdpx_text }} +{%- endmacro -%} + +{%- macro get_licence_header_summery( + license +) -%} + {# + This renders license header depending on user license selection. + + Args: + license (str): The SPDX identifier (e.g., 'MIT', 'BSD-3-Clause'). + + Returns: + str: the license header text + #} + {% if license == "0BSD" -%} + {{- zero_bsd.license_header -}} + {%- elif license in agpl_3_0.spdx -%} + {{- agpl_3_0.license_header -}} + {%- elif license == "Apache-2.0" -%} + {{- apache_2_0.license_header -}} + {%- elif license == "BSD-2-Clause" -%} + {{- bsd_2_clause.license_header -}} + {%- elif license == "BSD-3-Clause" -%} + {{- bsd_3_clause.license_header -}} + {%- elif license in gpl_3_0.spdx -%} + {{- gpl_3_0.license_header -}} + {%- elif license == "MIT" -%} + {{- mit.license_header -}} + {%- elif license == "Unlicense" -%} + {{- unlicense.license_header -}} + {%- endif -%} +{%- endmacro -%} + +{%- macro get_licence_header( + license, + copyright, + project_name, + file_name='none' +) -%} + {# + This renders license header depending on user license selection. + + Args: + license (str): The SPDX identifier (e.g., 'MIT', 'BSD-3-Clause'). + copyright(str): The copyright holder line (e.g., '2026 Jane Doe'). + project_name(str): project_name (str): Name of project for file header. + file_name(str): Name of file for license header. + + Returns: + str: the license header text + #} + {{- file_name }} for {{ project_name -}} + {{- "\n\n" -}} + {{- spdx(license, copyright, project_name) -}} + {%- set header_notice = get_licence_header_summery(license) -%} + {%- if header_notice != "" -%} + {{- "\n\n" -}} + {{- header_notice -}} + {%- endif -%} +{%- endmacro -%} + +{%- macro get_license( + license, + copyright +) -%} + {# + This renders license depending on user license selection. Some licenses are templates + themselves and explicitly require insertion of copyright notice directly into the + license text itself. This is handled within this function otherwise license file is copied + verbatim. + + Args: + license (str): The SPDX identifier (e.g., 'MIT', 'BSD-3-Clause'). + + Returns: + str: The license text + #} + {% if license == '0BSD' %} + {{- zero_bsd.license(copyright) -}} + {% elif license in agpl_3_0.spdx %} + {{- agpl_3_0.license -}} + {% elif license == 'Apache-2.0' %} + {{- apache_2_0.license -}} + {% elif license == 'BSD-2-Clause' %} + {{- bsd_2_clause.license(copyright) -}} + {% elif license == 'BSD-3-Clause' %} + {{- bsd_3_clause.license(copyright) -}} + {% elif license in gpl_3_0.spdx %} + {{- gpl_3_0.license -}} + {% elif license == 'MIT' %} + {{- mit.license(copyright) -}} + {% elif license == 'Unlicense' %} + {{- unlicense.license -}} + {% endif %} +{%- endmacro -%} diff --git a/.cookiecutter_includes/license/license-header.j2 b/.cookiecutter_includes/license/license-header.j2 new file mode 100644 index 0000000..db688b4 --- /dev/null +++ b/.cookiecutter_includes/license/license-header.j2 @@ -0,0 +1,84 @@ +{# +# license-header.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/license/license-data.j2' as lics %} + +{%- macro create( + license, + copyright, + project_name, + file_name='none', + comment_style='hash' +) -%} + {# + This renders license header depending on user license selection. + + Args: + license (str): The SPDX identifier (e.g., 'MIT', 'BSD-3-Clause'). + copyright (str): The copyright holder line (e.g., '2026 Jane Doe'). + project_name (str): Name of project for file header. + file_name (str): Name of file for license header. + comment_style (str): File comment style (e.g., 'hash', 'python', 'html'). + + Returns: + str: the formatted license header text defined by the comment_style. + #} + {# This macro generates the correct license header based on input #} + {# Define variables for start/end comment delimiters #} + {%- set start_comment = '' -%} + {%- set end_comment = '' -%} + {%- set newline = '\n' -%} + {# Determine the correct comment style #} + {%- if comment_style == 'python' -%} + {# djlint:off T027 #} + {%- set start_comment = '"""' + newline -%} + {%- set end_comment = newline + '"""' -%} + {# djlint:on #} + {%- elif comment_style == 'html' -%} + {%- set start_comment = '' -%} + {%- else -%} + {# Default to hash/pound symbol for yaml, toml, shell scripts, etc. #} + {%- set start_comment = '#' -%} + {%- set end_comment = newline -%} + {%- endif -%} + {# Generate the core license text #} + {%- set license_text -%} + {{- lics.get_licence_header(license, copyright, project_name, file_name) }} + {%- endset -%} + {# Wrap the generated text with the appropriate start and end delimiters #} + {%- if comment_style == 'python' or comment_style == 'html' -%} + {{- start_comment -}} + {{- license_text | trim }} + {{- end_comment -}} + {%- else -%} + {%- set text = license_text.split('\n') -%} + {# For hash comments, prefix every line with '#' #} + {%- for line in text -%} + {%- set content = line.strip() -%} + {%- if content != '' -%} + {{- "# " }}{{ content -}}{{- "\n" -}} + {%- elif not loop.last and not loop.first -%} + {# This handles intentional blank lines between text blocks #} + {{- "#" }}{{- "\n" -}} + {%- endif -%} + {% endfor -%} + {%- endif -%} +{%- endmacro -%} diff --git a/.cookiecutter_includes/license/license.j2 b/.cookiecutter_includes/license/license.j2 new file mode 100644 index 0000000..b22b099 --- /dev/null +++ b/.cookiecutter_includes/license/license.j2 @@ -0,0 +1,41 @@ +{# +# license.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/license/license-data.j2' as lics %} + +{% macro create( + license, + copyright +) %} + {# + Generates a license based on the selected SPDX identifier. + + This macro maps a license string to its corresponding full + text stored in the `lics` data object. + + Args: + license (str): The SPDX identifier (e.g., 'MIT', 'BSD-3-Clause'). + copyright (str): The copyright holder line (e.g., '2026 Jane Doe'). + + Returns: + str: The formatted license text as Markdown. + #} + {{- lics.get_license(license, copyright) -}} +{% endmacro %} diff --git a/.cookiecutter_includes/license/mit.j2 b/.cookiecutter_includes/license/mit.j2 new file mode 100644 index 0000000..e307b6a --- /dev/null +++ b/.cookiecutter_includes/license/mit.j2 @@ -0,0 +1,49 @@ +{# +# mit.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% set spdx = ["MIT"] %} + +{% set license_header %}{% endset %} + +{% macro license( + copyright +) %} +# The MIT License (MIT) + +{{ copyright }} + +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. +{% endmacro %} diff --git a/.cookiecutter_includes/license/unlicense.j2 b/.cookiecutter_includes/license/unlicense.j2 new file mode 100644 index 0000000..4de7455 --- /dev/null +++ b/.cookiecutter_includes/license/unlicense.j2 @@ -0,0 +1,50 @@ +{# +# unlicense.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% set spdx = ["Unlicense"] %} + +{% set license_header %}{% endset %} + +{% set license %} +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 +{% endset %} diff --git a/.cookiecutter_includes/license_header.j2 b/.cookiecutter_includes/license_header.j2 deleted file mode 100644 index 8368a2c..0000000 --- a/.cookiecutter_includes/license_header.j2 +++ /dev/null @@ -1,149 +0,0 @@ -{# -# license_header.j2 for cookiecutter-cookiecutter -# -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -#} - -{%- macro license_header( - license_type, - author, - project_name, - file_name='none', - comment_style='hash' -) -%} - {# - This renders license header depending on user selection of cookiecutter.license. - Args: license_type, author, file_name, comment_style. - #} -{# This macro generates the correct license header based on input #} -{# Define variables for start/end comment delimiters #} -{%- set start_comment = "" -%} -{%- set end_comment = "" -%} -{%- set newline = "\n" -%} -{# Determine the correct comment style #} -{%- if comment_style == 'python' -%} - {%- set start_comment = '"""' + newline -%} - {%- set end_comment = newline + '"""' -%} -{%- elif comment_style == 'html' -%} - {%- set start_comment = '' -%} -{%- else -%} - {# Default to hash/pound symbol for yaml, toml, shell scripts, etc. #} - {%- set start_comment = '#' -%} - {%- set end_comment = newline -%} -{%- endif -%} -{# Generate the core license text #} -{% set license_text %} -{{ file_name }} for {{ project_name }} - -Copyright (c) {% now 'utc', '%Y' %}, {{ author }} -{% if license_type == "Apache-2.0" -%} -SPDX-License-Identifier: Apache-2.0 - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - www.apache.org - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -{% elif license_type == "BSD-3-Clause" -%} -SPDX-License-Identifier: BSD-3-Clause - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -{% elif license_type == "GPL-3.0" -%} -SPDX-License-Identifier: GPL-3.0-or-later - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see . -{% elif license_type == "MIT" -%} -SPDX-License-Identifier: MIT - -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. -{% endif -%} -{%- endset -%} -{# Wrap the generated text with the appropriate start and end delimiters #} -{%- if comment_style == 'python' or comment_style == 'html' -%} -{{ start_comment -}} -{{ license_text | trim }} -{{- end_comment }} -{%- else -%} -{%- set text = license_text.split('\n') -%} -{# For hash comments, prefix every line with '#' #} -{%- for line in text -%} -{%- if line == '' or line == '\n' -%} -{%- set commented_line = line -%} -{%- else -%} -{%- set commented_line = " " + line -%} -{%- endif -%} -#{{ commented_line }} -{% endfor -%} -{%- endif -%} -{%- endmacro -%} diff --git a/.cookiecutter_includes/make/__init__.j2 b/.cookiecutter_includes/make/__init__.j2 index a05de03..02ce555 100644 --- a/.cookiecutter_includes/make/__init__.j2 +++ b/.cookiecutter_includes/make/__init__.j2 @@ -1,21 +1,21 @@ {# # make/__init__.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {% import '.cookiecutter_includes/make/clean.j2' as _clean with context %} diff --git a/.cookiecutter_includes/make/clean.j2 b/.cookiecutter_includes/make/clean.j2 index 9de47b0..2802933 100644 --- a/.cookiecutter_includes/make/clean.j2 +++ b/.cookiecutter_includes/make/clean.j2 @@ -1,21 +1,21 @@ {# # make/clean.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {% macro clean( diff --git a/.cookiecutter_includes/make/docs.j2 b/.cookiecutter_includes/make/docs.j2 index 6b3a5a5..c273206 100644 --- a/.cookiecutter_includes/make/docs.j2 +++ b/.cookiecutter_includes/make/docs.j2 @@ -1,21 +1,21 @@ {# # make/docs.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {% macro sphinx_cmds() -%} @@ -27,6 +27,9 @@ sphinx: {% macro jekyll_cmds() -%} {# formatted jekyll command string. #} +ruby-install: + $(MAKE) -C $(JEKYLL_DIR) ruby-install; + jekyll: $(MAKE) -C $(JEKYLL_DIR) all; @@ -79,7 +82,7 @@ readme: {% if sphinx_enabled and jekyll_enabled %} {{ sphinx_cmds }} -{{ jekyll_cmds}} +{{ jekyll_cmds }} {% elif sphinx_enabled %} {{ sphinx_cmds }} {% elif jekyll_enabled %} @@ -105,7 +108,7 @@ run-docs: jekyll-serve jekyll_enabled, sphinx_enabled, macro -)%} +) %} {% if not sphinx_enabled and not jekyll_enabled %} {% else %} {{ macro }} diff --git a/.cookiecutter_includes/make/help.j2 b/.cookiecutter_includes/make/help.j2 index 73a22ed..8a8adea 100644 --- a/.cookiecutter_includes/make/help.j2 +++ b/.cookiecutter_includes/make/help.j2 @@ -1,21 +1,21 @@ {# # make/help.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {# TODO: I should probably add pre-commit, pre-release, & release to the menu. #} diff --git a/.cookiecutter_includes/make/lint.j2 b/.cookiecutter_includes/make/lint.j2 index 160873d..dfd7853 100644 --- a/.cookiecutter_includes/make/lint.j2 +++ b/.cookiecutter_includes/make/lint.j2 @@ -1,19 +1,118 @@ {# # make/lint.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} + +{%- macro header( + ansible, + jinja, + ruff, + toml, + yaml +) -%} + {%- set title -%} + {% if ansible -%}Sphinx{%- endif -%} + {% if sphinx_enabled and jekyll_enabled %} + {% endif -%} + {% if jekyll_enabled -%}Jekyll + nutrimatic{%- endif -%} + {%- endset -%} +# -------------------------------------------------- +# ๐Ÿ” Linting (ruff, yaml, jinja2) +# -------------------------------------------------- +{%- endmacro -%} + + +{%- macro settings( + ansible, + jinja, + ruff, + toml, + yaml +) -%} +RUFF := $(PYTHON) -m ruff +TOMLLINT := tomllint +YAMLLINT := $(PYTHON) -m yamllint +JINJA := $(ACTIVATE) && jinja2 --strict \ + --extension=cookiecutter.extensions.JsonifyExtension \ + --extension=cookiecutter.extensions.RandomStringExtension \ + --extension=cookiecutter.extensions.SlugifyExtension \ + --extension=cookiecutter.extensions.TimeExtension \ + --extension=cookiecutter.extensions.UUIDExtension +{%- endmacro -%} + + +{% macro actions( + ansible, + jinja, + ruff, + toml, + yaml +) -%} + +# -------------------------------------------------- +# ๐Ÿ” Linting (jinja2, ruff, toml, & yaml) +# -------------------------------------------------- +render-cookiecutter: + $(AT)rm -rf $(RENDERED_COOKIE_DIR) + $(AT)$(COOKIECUTTER) . --no-input \ + --output-dir $(RENDERED_COOKIE_DIR) \ + --overwrite-if-exists + +jinja2-lint-check: + $(AT)echo "๐Ÿ” jinja2 lint..." + $(AT)jq '{cookiecutter: .}' cookiecutter.json > /tmp/_cc_wrapped.json + $(AT)$(JINJA_FILE_LIST) | tr '\0' '\n' + $(AT)$(ACTIVATE) && $(JINJA_FILE_LIST) | \ + while IFS= read -r -d '' f; do \ + if file "$$f" | grep -q text; then \ + echo "Checking $$f"; \ + $(JINJA) "$$f" /tmp/_cc_wrapped.json || exit 1; \ + fi; \ + done + $(AT)echo "โœ… Finished linting check of jinja2 macro files with jinja2!" + +ruff-lint-check: + $(AT)echo "๐Ÿ” Running ruff linting..." + $(AT)$(MAKE) list-folders + $(AT)$(RUFF) check --config pyproject.toml $(SRC_DIR) $(TESTS_DIR) \ + --force-exclude '$(COOKIE_DIR)/pyproject.toml' + $(AT)echo "โœ… Finished linting check of Python code with Ruff!" + +ruff-lint-fix: + $(AT)echo "๐ŸŽจ Running ruff lint fixes..." + $(AT)$(RUFF) check --config pyproject.toml --show-files $(SRC_DIR) $(TESTS_DIR) + $(AT)$(RUFF) check --config pyproject.toml --fix $(SRC_DIR) $(TESTS_DIR) \ + --force-exclude '$(COOKIE_DIR)/pyproject.toml' + $(AT)echo "โœ… Finished linting Python code with Ruff!" + +toml-lint-check: + $(AT)echo "๐Ÿ” Running Tomllint..." + $(AT)$(TOML_FILE_LIST) | tr '\0' '\n' + $(AT)$(ACTIVATE) && \ + $(TOML_FILE_LIST) \ + | xargs -0 -n 1 $(TOMLLINT) + $(AT)echo "โœ… Finished linting check of toml files with Tomllint!" + +yaml-lint-check: + $(AT)echo "๐Ÿ” Running yamllint..." + $(AT)$(YAMLLINT) $(PROJECT_ROOT) + $(AT)$(YAMLLINT) $(RENDERED_COOKIE_DIR) + $(AT)echo "โœ… Finished linting check of yaml files with yamllint!" + +lint-check: render-cookiecutter ruff-lint-check toml-lint-check yaml-lint-check +lint-fix: ruff-lint-fix +{%- endmacro -%} diff --git a/.cookiecutter_includes/make/phony.j2 b/.cookiecutter_includes/make/phony.j2 index c8270c3..1c5fbbe 100644 --- a/.cookiecutter_includes/make/phony.j2 +++ b/.cookiecutter_includes/make/phony.j2 @@ -1,21 +1,21 @@ {# # make/phony.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {% macro phony( @@ -26,7 +26,7 @@ 'all', 'list-folders' ] -%} {%- set python_targets = [ - 'venv', 'install', 'pre-commit-init', 'security', + 'venv', 'python-install', 'pre-commit-init', 'security', 'dependency-check', 'black-formatter-check', 'black-formatter-fix', 'render-cookiecutter', 'jinja2-lint-check', 'ruff-lint-check', 'ruff-lint-fix', 'toml-lint-check', 'yaml-lint-check' diff --git a/.cookiecutter_includes/make/python.j2 b/.cookiecutter_includes/make/python.j2 index 2d454c0..c64b493 100644 --- a/.cookiecutter_includes/make/python.j2 +++ b/.cookiecutter_includes/make/python.j2 @@ -1,19 +1,19 @@ {# # make/python.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} diff --git a/.cookiecutter_includes/make/settings.j2 b/.cookiecutter_includes/make/settings.j2 index 9efcbcd..aed9555 100644 --- a/.cookiecutter_includes/make/settings.j2 +++ b/.cookiecutter_includes/make/settings.j2 @@ -1,21 +1,21 @@ {# # make/settings.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {% macro settings( @@ -67,7 +67,7 @@ CHANGELOG_RELEASE_FILE := $(CHANGELOG_RELEASE_DIR)/$(RELEASE).md # ๐Ÿช Template Directories (cookiecutter) # -------------------------------------------------- {%- raw %} -COOKIE_DIR := $(PROJECT_ROOT)/{{ cookiecutter.project_slug }} +COOKIE_DIR := {{ cookiecutter.project_slug }} {% endraw %} COOKIE_MACRO_DIR := $(COOKIE_DIR)/.cookiecutter_includes RENDERED_COOKIE_DIR := /tmp/rendered diff --git a/.cookiecutter_includes/make/version.j2 b/.cookiecutter_includes/make/version.j2 index 9c6cc02..7a64204 100644 --- a/.cookiecutter_includes/make/version.j2 +++ b/.cookiecutter_includes/make/version.j2 @@ -1,21 +1,21 @@ {# # make/version.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {% macro version() -%} diff --git a/.cookiecutter_includes/pyproject/__init__.j2 b/.cookiecutter_includes/pyproject/__init__.j2 index 2649eb1..69f16d5 100644 --- a/.cookiecutter_includes/pyproject/__init__.j2 +++ b/.cookiecutter_includes/pyproject/__init__.j2 @@ -1,19 +1,19 @@ {# # pyproject/__init__.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} diff --git a/.cookiecutter_includes/tests/__init__.j2 b/.cookiecutter_includes/tests/__init__.j2 index fd59d57..94611f6 100644 --- a/.cookiecutter_includes/tests/__init__.j2 +++ b/.cookiecutter_includes/tests/__init__.j2 @@ -1,21 +1,21 @@ {# # tests/__init__.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} {% import '.cookiecutter_includes/tests/bake.j2' as _bake with context %} diff --git a/.cookiecutter_includes/tests/bake.j2 b/.cookiecutter_includes/tests/bake.j2 index 778e70a..e496c83 100644 --- a/.cookiecutter_includes/tests/bake.j2 +++ b/.cookiecutter_includes/tests/bake.j2 @@ -1,21 +1,21 @@ {# # tests/bake.j2 for cookiecutter-cookiecutter # -# Copyright (c) 2025, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . #} @@ -23,9 +23,9 @@ template_type ) -%} {# returns the test_file name depending on the template type. #} - {% if template_type in ["ansible", "c", "c++", "c/cc", "c/c++", "ros2"] -%} - LICENSE - {%- elif template_type == "cookiecutter" -%} + {% if template_type in ["ansible", "c", "c++", "ros2"] -%} + LICENSE.md + {%- elif template_type in ["cookiecutter", "documentation"] -%} Makefile {%- elif template_type == "python" -%} pyproject.toml @@ -67,7 +67,7 @@ def test_bake_with_defaults(cookies: Cookies) -> None: #} {%- set use_default_slug = [ "c", "c++", "c/cc", "c/c++", - "cookiecutter", "python", "ros2", + "cookiecutter", "documentation", "python", "ros2", "typescript"] -%} {% if template_type == "ansible" -%} diff --git a/.cookiecutter_includes/workflows/__init__.j2 b/.cookiecutter_includes/workflows/__init__.j2 new file mode 100644 index 0000000..0768e99 --- /dev/null +++ b/.cookiecutter_includes/workflows/__init__.j2 @@ -0,0 +1,40 @@ +{# +# workflows/__init__.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + +{% import '.cookiecutter_includes/workflows/contributor-assistant.j2' as _contributor_assistant with context %} +{% import '.cookiecutter_includes/workflows/dependency-check.j2' as _dependency_check with context %} +{% import '.cookiecutter_includes/workflows/format-check.j2' as _format_check with context %} +{% import '.cookiecutter_includes/workflows/jekyll-gh-pages.j2' as _jekyll_gh_pages with context %} +{% import '.cookiecutter_includes/workflows/lint-check.j2' as _lint_check with context %} +{% import '.cookiecutter_includes/workflows/security-audit.j2' as _security_audit with context %} +{% import '.cookiecutter_includes/workflows/spellcheck.j2' as _spellcheck with context %} +{% import '.cookiecutter_includes/workflows/tests.j2' as _tests with context %} +{% import '.cookiecutter_includes/workflows/typecheck.j2' as _typecheck with context %} + + +{% set contributor_assistant = _contributor_assistant %} +{% set dependency_check = _dependency_check %} +{% set format_check = _format_check %} +{% set jekyll_gh_pages = _jekyll_gh_pages %} +{% set lint_check = _lint_check %} +{% set security_audit = _security_audit %} +{% set spellcheck = _spellcheck %} +{% set tests = _tests %} +{% set typecheck = _typecheck %} diff --git a/.cookiecutter_includes/workflows/contributor-assistant.j2 b/.cookiecutter_includes/workflows/contributor-assistant.j2 new file mode 100644 index 0000000..6abef65 --- /dev/null +++ b/.cookiecutter_includes/workflows/contributor-assistant.j2 @@ -0,0 +1,77 @@ +{# +# contributor-assistant.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name=cookiecutter.contribution_model|lower ~ '.yml', + comment_style='hash') -}} +--- +name: "{{ cookiecutter.contribution_model | upper }} Assistant" +on: + issue_comment: + types: [created] + pull_request_target: + types: [ + opened, + closed, + synchronize + ] + +# explicitly configure permissions, in case your GITHUB_TOKEN +# workflow permissions are set to read-only in repository settings +permissions: + actions: write + contents: write # this can be 'read' if the signatures are in remote repository + pull-requests: write + statuses: write + +jobs: + CLAAssistant: + runs-on: ubuntu-latest + steps: + - name: "{{ cookiecutter.contribution_model | upper }} Assistant" + if: >- + (github.event.comment.body == 'recheck' || + github.event.comment.body == 'I have read the {{ cookiecutter.contribution_model | upper }} Document and I hereby sign the {{ cookiecutter.contribution_model | upper }}') || + github.event_name == 'pull_request_target' + uses: contributor-assistant/github-action@v2.6.1 + env: + GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw +%} + with: + path-to-signatures: "{{ cookiecutter.contribution_model | lower }}/v1/signatures.json" + path-to-document: "{{ cookiecutter.github_io }}/manual/developer-resources/{{ cookiecutter.contribution_model | lower }}" + # branch should not be protected + branch: "{{ cookiecutter._default_branch }}" # Should match the branch that github pages are hosted from. + allowlist: "{{ cookiecutter.github_username }},github-actions[bot],dependabot[bot],bot*" + + # If the below optional inputs are not given, then default values will be taken: + create-file-commit-message: "chore({{ cookiecutter.contribution_model | upper }}): Creating file for storing {{ cookiecutter.contribution_model | upper }} Signatures." + signed-commit-message: "chore({{ cookiecutter.contribution_model | upper }}): $contributorName has signed the {{ cookiecutter.contribution_model | upper }}." + # custom-notsigned-prcomment: "pull request comment with Introductory message to ask new contributors to sign" + # custom-pr-sign-comment: "The signature to be committed in order to sign the {{ cookiecutter.contribution_model | upper }}" + # custom-allsigned-prcomment: "**{{ cookiecutter.contribution_model | upper }} Assistant Lite bot** All Contributors have signed the {{ cookiecutter.contribution_model | upper }}." + lock-pullrequest-aftermerge: true + use-dco-flag: {{ 'true' if cookiecutter.contribution_model|lower == 'dco' else 'false' }} # If you are using DCO instead of CLA +{% endmacro %} diff --git a/.cookiecutter_includes/workflows/dependency-check.j2 b/.cookiecutter_includes/workflows/dependency-check.j2 new file mode 100644 index 0000000..a8418a6 --- /dev/null +++ b/.cookiecutter_includes/workflows/dependency-check.j2 @@ -0,0 +1,55 @@ +{# +# dependency-check.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='dependency-check.yml', + comment_style='hash') -}} +--- +name: Cookiecutter Template Dependency Check + +on: [push, pull_request] + +jobs: + dependency-check: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install deptry + run: | + make python-install + + - name: Run Dependency Check + run: | + make dependency-check +{% endmacro %} diff --git a/.cookiecutter_includes/workflows/format-check.j2 b/.cookiecutter_includes/workflows/format-check.j2 new file mode 100644 index 0000000..c638598 --- /dev/null +++ b/.cookiecutter_includes/workflows/format-check.j2 @@ -0,0 +1,55 @@ +{# +# format-check.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='black-format.yml', + comment_style='hash') -}} +--- +name: Cookiecutter Template Format Check + +on: [push, pull_request] + +jobs: + black-format-check: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install Formatting Tools + run: | + make python-install + + - name: Black Format Check + run: | + make black-formatter-check +{% endmacro %} diff --git a/.cookiecutter_includes/workflows/jekyll-gh-pages.j2 b/.cookiecutter_includes/workflows/jekyll-gh-pages.j2 new file mode 100644 index 0000000..dc5a46e --- /dev/null +++ b/.cookiecutter_includes/workflows/jekyll-gh-pages.j2 @@ -0,0 +1,100 @@ +{# +# jekyll-gh-pages.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='jekyll-gh-pages.yml', + comment_style='hash') -}} +--- +name: Deploy Jekyll with GitHub Pages dependencies preinstalled + +on: + push: + branches: + - master + - main + paths: + - "docs/**" + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false +{% raw %} +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + - name: Install Python Tools + run: | + make python-install + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: "3.3" # Recommended for Jekyll 4.4 in 2026 + bundler-cache: true # Runs "bundle install" and caches gems automatically + working-directory: ./docs/jekyll + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Build with Jekyll site in /docs/jekyll + run: make jekyll + env: + PAGES_REPO_NWO: ${{ github.repository }} + JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + JEKYLL_ENV: production + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/jekyll/_site + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 +{% endraw %} +{% endmacro %} diff --git a/.cookiecutter_includes/workflows/lint-check.j2 b/.cookiecutter_includes/workflows/lint-check.j2 new file mode 100644 index 0000000..cdfcc6e --- /dev/null +++ b/.cookiecutter_includes/workflows/lint-check.j2 @@ -0,0 +1,68 @@ +{# +# lint-check.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='lint-check.yml', + comment_style='hash') -}} +--- +name: Cookiecutter Template Lint Check + +on: [push, pull_request] + +jobs: + jinja2-lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install Linting Tools + run: | + make python-install + + - name: Render Cookiecutter Template + run: | + make render-cookiecutter + + - name: Lint Jinja templates + run: | + make djlint-lint-check + - name: Run Ruff Lint Check + run: | + make ruff-lint-check + - name: Run Toml Lint Check + run: | + make toml-lint-check + - name: Run YAML Lint Check + run: | + make yaml-lint-check +{% endmacro %} diff --git a/.cookiecutter_includes/workflows/security-audit.j2 b/.cookiecutter_includes/workflows/security-audit.j2 new file mode 100644 index 0000000..e40b831 --- /dev/null +++ b/.cookiecutter_includes/workflows/security-audit.j2 @@ -0,0 +1,55 @@ +{# +# security-audit.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='security-audit.yml', + comment_style='hash') -}} +--- +name: Cookiecutter Template Security Audit + +on: [push, pull_request] + +jobs: + security-audit: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install pip-audit + run: | + make python-install + + - name: Run Security Check + run: | + make security +{% endmacro %} diff --git a/.cookiecutter_includes/workflows/spellcheck.j2 b/.cookiecutter_includes/workflows/spellcheck.j2 new file mode 100644 index 0000000..b34a61e --- /dev/null +++ b/.cookiecutter_includes/workflows/spellcheck.j2 @@ -0,0 +1,55 @@ +{# +# spellcheck.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='spellcheck.yml', + comment_style='hash') -}} +--- +name: Cookiecutter Template Spellcheck + +on: [push, pull_request] + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install codespell + run: | + make python-install + + - name: Run Spellcheck + run: | + make spellcheck +{% endmacro %} diff --git a/.cookiecutter_includes/workflows/tests.j2 b/.cookiecutter_includes/workflows/tests.j2 new file mode 100644 index 0000000..b3f68fe --- /dev/null +++ b/.cookiecutter_includes/workflows/tests.j2 @@ -0,0 +1,55 @@ +{# +# tests.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='tests.yml', + comment_style='hash') -}} +--- +name: Cookiecutter Template Tests + +on: [push, pull_request] + +jobs: + tests: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install pytest + run: | + make python-install + + - name: Run tests + run: | + make test +{% endmacro %} diff --git a/.cookiecutter_includes/workflows/typecheck.j2 b/.cookiecutter_includes/workflows/typecheck.j2 new file mode 100644 index 0000000..a50a263 --- /dev/null +++ b/.cookiecutter_includes/workflows/typecheck.j2 @@ -0,0 +1,55 @@ +{# +# typecheck.j2 for cookiecutter-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +#} + + +{% macro create() %} +{% import '.cookiecutter_includes/license/__init__.j2' as license_macros with context %} +{{- license_macros.license_header.create( + cookiecutter.license, + cookiecutter.copyright, + cookiecutter.project_slug, + file_name='typecheck.yml', + comment_style='hash') -}} +--- +name: Cookiecutter Template Typecheck + +on: [push, pull_request] + +jobs: + typecheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install mypy + run: | + make python-install + + - name: Run typecheck + run: | + make typecheck +{% endmacro %} diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..7274f8b --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# Global owner for the repository +* @jcook3701 diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..861caad --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,102 @@ +# Community Code of Conduct + +## Our Pledge + +We pledge to make our community welcoming, safe, and equal for all. + +We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant. + + +## Encouraged Behaviors + +While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language. + +With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including: + +1. Respecting the **purpose of our community**, our activities, and our ways of gathering. +2. Engaging **kindly and honestly** with others. +3. Respecting **different viewpoints** and experiences. +4. **Taking responsibility** for our actions and contributions. +5. Gracefully giving and accepting **constructive feedback**. +6. Committing to **repairing harm** when it occurs. +7. Behaving in other ways that promote and sustain the **well-being of our community**. + + +## Restricted Behaviors + +We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct. + +1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop. +2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. +3. **Stereotyping or discrimination.** Characterizing anyoneโ€™s personality or behavior on the basis of immutable identities or traits. +4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. +5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission. +6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. +7. Behaving in other ways that **threaten the well-being** of our community. + +### Other Restrictions + +1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions. +2. **Failing to credit sources.** Not properly crediting the sources of content you contribute. +3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community. +4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. + + +## Reporting an Issue + +Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. + +When an incident does occur, it is important to report it promptly. + +To report a possible violation, please email [jcook3701's Email](mailto:jcook3701+github@gmail.com?subject=Report:%20Community%20Code%20of%20Conduct). + +All reports will be handled with strict confidentiality. Your email should include: + +* **Date and time** of the incident. +* **A description** of what occurred. +* **Links or screenshots** to any relevant public or private messages/logs. +* **Witnesses**, if any were present. + + + +Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution. + + +## Addressing and Repairing Harm + +If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped. + +1) Warning + 1) Event: A violation involving a single incident or series of incidents. + 2) Consequence: A private, written warning from the Community Moderators. + 3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations. +2) Temporarily Limited Activities + 1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation. + 2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members. + 3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over. +3) Temporary Suspension + 1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation. + 2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions. + 3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted. +4) Permanent Ban + 1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member. + 2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior. + 3) Repair: There is no possible repair in cases of this severity. + +This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community. + + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + + +## Attribution + +This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). This version has been modified to replace "equity" with "equal." + +Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) + +For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozillaโ€™s code of conduct team](https://github.com/mozilla/inclusion). diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..3a2f52e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,119 @@ +# Contributing to python3-cookiecutter + +You want to contribute to python3-cookiecutter? Welcome! Please read this document to understand what you can do: + +* [Help Others](#help-others) +* [Analyze Issues](#analyze-issues) +* [Report an Issue](#report-an-issue) +* [Contribute Code](#contribute-code) + +## Help Others + +You can help python3-cookiecutter by helping others who use it and need support. + +## Analyze Issues + +Analyzing issue reports can be a lot of effort. Any help is welcome! +Go to [the GitHub issue tracker](https://github.com/jcook3701/python3-cookiecutter/issues?state=open) and find an open issue which needs additional work or a bugfix (e.g. issues labeled with "help wanted" or "bug"). + +Additional work could include any further information, or a gist, or it might be a hint that helps understanding the issue. Maybe you can even find and [contribute](#contribute-code) a bugfix? + +## Report an Issue + +If you find a bug - behavior of python3-cookiecutter code contradicting your expectation - you are welcome to report it. +We can only handle well-reported, actual bugs, so please follow the guidelines below. + +Once you have familiarized with the guidelines, you can go to the [GitHub issue tracker for python3-cookiecutter](https://github.com/jcook3701/python3-cookiecutter/issues/new) to report the issue. + +### Quick Checklist for Bug Reports + +Issue report checklist: +* Real, current bug +* No duplicate +* Reproducible +* Good summary +* Well-documented +* Minimal example +* Use the [bug template](ISSUE_TEMPLATE/01-bug-report.yml) + +### Issue handling process + +When an issue is reported, a committer will look at it and either confirm it as a real issue, close it if it is not an issue, or ask for more details. + +An issue that is about a real bug is closed as soon as the fix is committed. + +### Reporting Security Issues + +If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. +Please send the related information to [jcook3701's email](mailto:jcook3701+python3-cookiecutter@gmail.com?subject=Report:%20Security%20Vulnerability). + +### Usage of Labels + +GitHub offers labels to categorize issues. We defined the following labels so far: + +Labels for issue categories: +* bug: this issue is a bug in the code +* feature: this issue is a request for a new functionality or an enhancement request +* design: this issue relates to the UI or UX design of the tool + +Status of open issues: +* help wanted: the feature request is approved and you are invited to contribute + +Status/resolution of closed issues: +* wontfix: while acknowledged to be an issue, a fix cannot or will not be provided + +The labels can only be set and modified by committers. + +### Issue Reporting Disclaimer + +We want to improve the quality of, python3-cookiecutter, and good bug reports are welcome! But our capacity is limited, thus we reserve the right to close or to not process insufficient bug reports in favor of those which are very cleanly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it will not happen - remember: python3-cookiecutter is Open Source and comes without warranty. + +Bug report analysis support is very welcome! (e.g. pre-analysis or proposing solutions) + +## Contribute Code + +You are welcome to contribute code to python3-cookiecutter in order to fix bugs or to implement new features. + +There are three important things to know: +1. You must be aware that you need to submit [CLA](https://jcook3701.github.io/python3-cookiecutter/manual/developer-resources/cla) in order for your contribution to be accepted. This is common practice in all major Open Source projects. +2. There are **several requirements regarding code style, quality, and product standards** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines. +3. **Not all proposed contributions can be accepted**. Some features may e.g. just fit a third-party add-on better. The code must fit the overall direction of python3-cookiecutter and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the feature you plan to implement (make it clear you intend to contribute). + +## Contributor License Agreement (CLA) + +Due to legal reasons, contributors will be asked to accept a [CLA](https://jcook3701.github.io/python3-cookiecutter/manual/developer-resources/cla) before they submit the first pull request to this project, this happens in an automated fashion during the submission process. We use a derivative of the [ASF Contributor Agreements](https://www.apache.org/licenses/contributor-agreements.html) as can be found below. + +* [ICLA](https://www.apache.org/licenses/icla.pdf) +* [CCLA](https://www.apache.org/licenses/cla-corporate.pdf). + +### Contribution Content Guidelines + +These are some of the rules we try to follow: +* Apply a clean coding style adapted to the surrounding code, even though we are aware the existing code is not fully clean +* Use (4)spaces for indentation (except if the modified file consistently uses tabs) +* Use variable naming conventions like in the other files you are seeing (underscore) +* No console.log() - use logging service +* Run all ci/cd code checks and make sure they succeed +* Comment your code where it gets non-trivial +* Keep an eye on performance and memory consumption, properly destroy objects when not used anymore +* Write a unit test +* Do not do any incompatible changes, especially do not modify the name or behavior of public API methods or properties + +### How to contribute - the Process + +1. Make sure the change would be welcome (e.g. a bugfix or a useful feature); best do so by proposing it in a GitHub issue +2. Create a branch forking the python3-cookiecutter repository and do your change +3. Commit and push your changes on that branch +4. In the commit message + * Describe the problem you fix with this change. + * Describe the effect that this change has from a user's point of view. App crashes and lockups are pretty convincing for example, but not all bugs are that obvious and should be mentioned in the text. + * Describe the technical details of what you changed. It is important to describe the change in a most understandable way so the reviewer is able to verify that the code is behaving as you intend it to. +5. If your change fixes an issue reported at GitHub, add the following line to the commit message: + * ```Fixes #(issueNumber)``` + * Do NOT add a colon after "Fixes" - this prevents automatic closing. +6. Create a Pull Request +7. Follow the link posted by the, python3-cookiecutter, project to your pull request and accept it, as described in detail above. +8. Wait for our code review and approval, possibly enhancing your change on request + * Note that the python3-cookiecutter developers also have their regular duties, so depending on the required effort for reviewing, testing and clarification this may take a while +9. Once the change has been approved we will inform you in a comment +10. We will close the pull request, feel free to delete the now obsolete branch diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index dd36db4..199016a 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,4 +1,20 @@ -# These are supported funding model platforms +# FUNDING.yml for python3-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- # github: ["jcook3701"] diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 0000000..a59229e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -0,0 +1,69 @@ +# 01-bug-report.yml for python3-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: ๐Ÿž Bug Report +description: File a bug report for this template. +title: "[Bug]: " +labels: ["bug"] +assignees: + - jcook3701 +body: + - type: markdown + attributes: + value: | + Thanks for reporting a bug! Please provide as much detail as possible to help us fix it. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: What did you expect to happen vs what actually happened? + placeholder: Describe the error here... + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating System + description: What OS are you running cookiecutter on? + options: + - Windows + - macOS + - Linux + validations: + required: true + - type: input + id: cc-version + attributes: + label: Cookiecutter Version + description: Run 'cookiecutter --version' and paste the output. + placeholder: e.g. 2.6.0 + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output or Error Message + description: Please copy and paste the traceback or error message here. + render: shell + - type: checkboxes + id: terms + attributes: + label: Acknowledgement + options: + - label: I have checked the existing issues for similar reports. + required: true diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 0000000..e2b029a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -0,0 +1,61 @@ +# 02-feature-request.yml for python3-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: ๐Ÿ’ก Feature Request +description: Suggest an idea for this cookiecutter template. +title: "[Feature]: " +labels: ["enhancement"] +assignees: + - jcook3701 +body: + - type: markdown + attributes: + value: | + Got a great idea for this template? We'd love to hear it! + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: "Ex. I'm always frustrated when [...]" + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + placeholder: "Ex. It would be great if the template automatically [...]" + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + - type: checkboxes + id: contribution + attributes: + label: Contribution + options: + - label: I would be willing to submit a pull request to implement this feature myself! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8fa5224 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,26 @@ +# ISSUE_TEMPLATE/config.yml.yml for python3-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +blank_issues_enabled: false +contact_links: + - name: GitHub Community Support + url: https://github.com/orgs/community/discussions + about: Please ask and answer questions here. + - name: GitHub Security Bug Bounty + url: https://bounty.github.com/ + about: Please report security vulnerabilities here. diff --git a/.github/ISSUE_TEMPLATE/z-developer-issue.yml b/.github/ISSUE_TEMPLATE/z-developer-issue.yml new file mode 100644 index 0000000..3ae3977 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/z-developer-issue.yml @@ -0,0 +1,33 @@ +# z-developer-issue.yml for python3-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: "๐Ÿ› ๏ธ Developer / General Issue" +description: "Blank template for contributors and maintainers (no form)." +title: "[Dev]: " +labels: ["internal"] +assignees: + - jcook3701 +body: + - type: textarea + id: content + attributes: + label: Issue Content + description: "Free-form text area for developer tasks, refactoring, or general notes." + placeholder: "Describe the task or internal update..." + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE/01-default-pull-request.md b/.github/PULL_REQUEST_TEMPLATE/01-default-pull-request.md new file mode 100644 index 0000000..403d1f6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/01-default-pull-request.md @@ -0,0 +1,24 @@ +## Description + + +## Related Issue + +Fixes # + +## Type of Change +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update + +## How Has This Been Tested? + +- [ ] Unit tests pass locally +- [ ] Manual verification (provide details below) + +## Checklist +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings diff --git a/.github/PULL_REQUEST_TEMPLATE/02-bug-fix.md b/.github/PULL_REQUEST_TEMPLATE/02-bug-fix.md new file mode 100644 index 0000000..1fa1f3a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/02-bug-fix.md @@ -0,0 +1,20 @@ +## ๐Ÿž Bug Fix Description + + +**Related Issue:** Fixes # + +### ๐Ÿ› ๏ธ Changes Made +- [ ] List specific changes or files modified. +- [ ] Describe how the fix addresses the root cause. + +### ๐Ÿงช How to Reproduce & Test +1. **Steps to reproduce:** (e.g., click X, then Y) +2. **Current behavior:** (before this fix) +3. **Expected behavior:** (after this fix) +4. **Testing performed:** (e.g., ran `pytest` or actions performed to recreate live testing situation) + +### โœ… Checklist +- [ ] My code follows the project style guidelines. +- [ ] I have performed a self-review of my code. +- [ ] I have added tests that prove my fix is effective. +- [ ] All new and existing tests passed. diff --git a/.github/PULL_REQUEST_TEMPLATE/03-feature-request.md b/.github/PULL_REQUEST_TEMPLATE/03-feature-request.md new file mode 100644 index 0000000..0301212 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/03-feature-request.md @@ -0,0 +1,21 @@ +## โœจ New Feature Description + + +**Related Issue:** Resolves # + +### ๐Ÿš€ Proposed Changes +- [ ] Detail the new components, logic, or UI added. +- [ ] Mention any new dependencies introduced. + +### ๐Ÿ“ธ Screenshots / Demos (If Applicable) + + +### ๐Ÿ› ๏ธ Technical Details +- [ ] Architecture changes (if any). +- [ ] New environment variables or configurations required. + +### โœ… Checklist +- [ ] My code follows the project style guidelines. +- [ ] I have updated the documentation accordingly. +- [ ] I have added/updated tests for this feature. +- [ ] My changes generate no new warnings or console errors. diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..e466f0c --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,24 @@ +# Security Vulnerabilities + +The python3-cookiecutter project is built with security and data privacy in mind to ensure your data is safe. + +## Reporting +We are grateful for security researchers and users reporting a vulnerability to us, first. To ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities can be assured, please follow the below guideline. + +**Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.** + +For reporting a vulnerability, please send an email directly to [jcook3701's email](mailto:jcook3701+security-vulnerability@gmail.com?subject=Report:%20Security%20Vulnerability). + +To help us verify and resolve issues efficiently, please ensure your security vulnerability report includes the following: + +* **Vulnerability Type** and the specific component or URL affected. +* **Detailed Steps** to Reproduce the issue, including any specific configurations needed. +* **Proof of Concept (PoC)** such as HTTP requests, scripts, or screen recordings. +* **Impact Assessment** describing what a successful exploit would allow an attacker to do. +* **Reproduction Environment** details, including the browser, OS, or software version used. +* **Suggested Mitigation** or fix, if you have identified one. + +All reports are handled with strict confidentiality. We ask that you follow responsible disclosure by giving us reasonable time to investigate and fix the issue before sharing any details publicly. + +## Disclosure Handling +We are committed to timely review and respond to your request. The resolution of code defects will be handled by a dedicated group of security experts and prepared in a private GitHub repository. The project will inform the public about resolved security vulnerabilities via GitHub Security Advisories. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..820ee6b --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,36 @@ +# Support Guidelines + +Thank you for using the python3-cookiecutter project! To help us maintain it efficiently, please check these resources before opening an issue. + +## ๐Ÿ› ๏ธ Getting Help +* **Documentation:** Start by reading our [Project Wiki](https://jcook3701.github.io/python3-cookiecutter). +* **FAQ:** Common questions are answered in our [Frequently Asked Questions](https://jcook3701.github.io/python3-cookiecutter/manual/troubleshooting/faq). +* **Community Forums:** For general questions and "how-to" help, please use [GitHub Discussions](https://github.com/jcook3701/python3-cookiecutter/discussions) instead of Issues. + +## ๐Ÿ› Reporting Bugs +If you have found a bug, please: +1. Search existing [Issues](https://github.com/jcook3701/python3-cookiecutter/issues?state=open) to see if it has already been reported. +2. Follow the [bug report template](ISSUE_TEMPLATE/01-bug-report.yml) to provide a reproducible example. + +## ๐Ÿ”’ Security Vulnerabilities +Please **do not** report security vulnerabilities via public issues. Instead, follow our [Security Policy](https://github.com/jcook3701/python3-cookiecutter/blob/master/.github/SECURITY.md) to report them privately. + +## โณ Response Times +This is an open-source project maintained by volunteers. We try to respond within **48-72 hours**, but please be patient as we balance this with other commitments. + +## ๐ŸŒฑ Funding and Sponsorship + +python3-cookiecutter is an open-source project maintained by volunteers. Your financial support helps sustain the project by covering: + +* **Infrastructure costs:** Domain names, hosting, and CI/CD services. +* **Time:** Allowing maintainers to dedicate more time to bug fixes and new features. + +If this project has helped you, please consider supporting us through one of the following methods: + +* **[Buy Me a Coffee](https://buymeacoffee.com/jcook3701):** A simple way to provide a one-time donation. + +We greatly appreciate your support! diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8123ec5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,5 @@ +### ๐Ÿ“‹ Select a Pull Request Template +Please switch to the **Preview** tab and select the correct type: +* [Standard PR](?template=01-default-pull-request.md) +* [Bug Fix](?template=02-bug-fix.md) +* [Feature Request](?template=03-feature-request.md) diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml new file mode 100644 index 0000000..e06cf2f --- /dev/null +++ b/.github/workflows/cla.yml @@ -0,0 +1,64 @@ +# cla.yml for python3-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: "CLA Assistant" +on: + issue_comment: + types: [created] + pull_request_target: + types: [ + opened, + closed, + synchronize + ] + +# explicitly configure permissions, in case your GITHUB_TOKEN +# workflow permissions are set to read-only in repository settings +permissions: + actions: write + contents: write # this can be 'read' if the signatures are in remote repository + pull-requests: write + statuses: write + +jobs: + CLAAssistant: + runs-on: ubuntu-latest + steps: + - name: "CLA Assistant" + if: >- + (github.event.comment.body == 'recheck' || + github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || + github.event_name == 'pull_request_target' + uses: contributor-assistant/github-action@v2.6.1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + path-to-signatures: "cla/v1/signatures.json" + path-to-document: "https://jcook3701.github.io/python3-cookiecutter/manual/developer-resources/cla" + # branch should not be protected + branch: "master" # Should match the branch that github pages are hosted from. + allowlist: "jcook3701,github-actions[bot],dependabot[bot],bot*" + + # If the below optional inputs are not given, then default values will be taken: + create-file-commit-message: "chore(CLA): Creating file for storing CLA Signatures." + signed-commit-message: "chore(CLA): $contributorName has signed the CLA." + # custom-notsigned-prcomment: "pull request comment with Introductory message to ask new contributors to sign" + # custom-pr-sign-comment: "The signature to be committed in order to sign the CLA" + # custom-allsigned-prcomment: "**CLA Assistant Lite bot** All Contributors have signed the CLA." + lock-pullrequest-aftermerge: true + use-dco-flag: false # If you are using DCO instead of CLA diff --git a/.github/workflows/dependency-check.yml b/.github/workflows/dependency-check.yml index 50afdb0..d60f5ca 100644 --- a/.github/workflows/dependency-check.yml +++ b/.github/workflows/dependency-check.yml @@ -1,21 +1,20 @@ # dependency-check.yml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- name: Cookiecutter Template Dependency Check @@ -36,7 +35,7 @@ jobs: - name: Install deptry run: | - make install + make python-install - name: Run Dependency Check run: | diff --git a/.github/workflows/format-check.yml b/.github/workflows/format-check.yml index f516813..279cc2c 100644 --- a/.github/workflows/format-check.yml +++ b/.github/workflows/format-check.yml @@ -1,21 +1,20 @@ # black-format.yml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- name: Cookiecutter Template Format Check @@ -36,7 +35,7 @@ jobs: - name: Install Formatting Tools run: | - make install + make python-install - name: Black Format Check run: | diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml index ce2acb4..843c669 100644 --- a/.github/workflows/jekyll-gh-pages.yml +++ b/.github/workflows/jekyll-gh-pages.yml @@ -1,21 +1,20 @@ # jekyll-gh-pages.yml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- name: Deploy Jekyll with GitHub Pages dependencies preinstalled @@ -48,15 +47,31 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + - name: Install Python Tools + run: | + make python-install + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: "3.3" # Recommended for Jekyll 4.4 in 2026 + bundler-cache: true # Runs "bundle install" and caches gems automatically + working-directory: ./docs/jekyll - name: Setup Pages uses: actions/configure-pages@v5 - name: Build with Jekyll site in /docs/jekyll - uses: actions/jekyll-build-pages@v1 - with: - source: ./docs/jekyll - destination: ./_site + run: make jekyll + env: + PAGES_REPO_NWO: ${{ github.repository }} + JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + JEKYLL_ENV: production - name: Upload artifact uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/jekyll/_site # Deployment job deploy: diff --git a/.github/workflows/lint-check.yml b/.github/workflows/lint-check.yml index 58a93b3..17aef01 100644 --- a/.github/workflows/lint-check.yml +++ b/.github/workflows/lint-check.yml @@ -1,21 +1,20 @@ # lint-check.yml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- name: Cookiecutter Template Lint Check @@ -36,7 +35,7 @@ jobs: - name: Install Linting Tools run: | - make install + make python-install - name: Render Cookiecutter Template run: | @@ -44,7 +43,7 @@ jobs: - name: Lint Jinja templates run: | - make jinja2-lint-check + make djlint-lint-check - name: Run Ruff Lint Check run: | make ruff-lint-check diff --git a/.github/workflows/security-audit.yml b/.github/workflows/security-audit.yml index 610028a..4c79a04 100644 --- a/.github/workflows/security-audit.yml +++ b/.github/workflows/security-audit.yml @@ -1,21 +1,20 @@ # security-audit.yml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- name: Cookiecutter Template Security Audit @@ -36,7 +35,7 @@ jobs: - name: Install pip-audit run: | - make install + make python-install - name: Run Security Check run: | diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 0dc38d7..7924e86 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -1,21 +1,20 @@ # spellcheck.yml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- name: Cookiecutter Template Spellcheck @@ -36,7 +35,7 @@ jobs: - name: Install codespell run: | - make install + make python-install - name: Run Spellcheck run: | diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index da6ca27..5d201e8 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,21 +1,20 @@ # tests.yml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- name: Cookiecutter Template Tests @@ -36,7 +35,7 @@ jobs: - name: Install pytest run: | - make install + make python-install - name: Run tests run: | diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml index adef872..07bf788 100644 --- a/.github/workflows/typecheck.yml +++ b/.github/workflows/typecheck.yml @@ -1,21 +1,20 @@ # typecheck.yml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- name: Cookiecutter Template Typecheck @@ -36,7 +35,7 @@ jobs: - name: Install mypy run: | - make install + make python-install - name: Run typecheck run: | diff --git a/.gitignore b/.gitignore index 70cafae..c22df9b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,21 +1,20 @@ # .gitignore for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . # ========================================= # text editor ignores # # ========================================= diff --git a/.jinja-runtime.json b/.jinja-runtime.json new file mode 100644 index 0000000..c846ff2 --- /dev/null +++ b/.jinja-runtime.json @@ -0,0 +1,14 @@ +{ + "templates": { + "search_paths": [ + ".", + "./.cookiecutter_includes", + "./{{ cookiecutter.project_slug }}" + ], + "base_dir": "." + }, + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true + } +} diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..bea4a34 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,63 @@ +# .markdownlint.yaml for python3-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +# Enable all built-in rules by default +default: true + +# MD007/ul-indent: Set unordered list indentation to 2 spaces +MD007: + indent: 2 + +# MD013/line-length: Disable or adjust long line warnings +# Many developers disable this to allow long URLs or technical prose +MD013: false + +# MD014/commands-show-output: Dollar signs used before commands without showing output +# This prevents copy-paste errors by ensuring leading dollar signs are only used when +# output is also present to distinguish them. +MD014: false + +# MD022/blanks-around-headings: Headings should be surrounded by blank lines +# Disabling this allows headings to be immediately preceded or followed by text +MD022: false + +# MD024/no-duplicate-heading: Allow duplicate headings if they are not siblings +MD024: + siblings_only: true + +# MD029/ol-prefix: Use 1. 2. 3. for ordered lists (default is "one" i.e., 1. 1. 1.) +MD029: + style: "ordered" + +# MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank linesmarkdownlintMD031 +MD031: false + +# MD032/blanks-around-lists: Lists should be surrounded by blank lines +# Setting this to false ignores the rule entirely +MD032: false + +# MD033/no-inline-html: Allow specific HTML tags if needed +MD033: + allowed_elements: ["br", "details", "summary"] + +# MD041/first-line-h1: Ensure the file starts with a top-level heading +MD041: true + +# MD046/code-block-style: Enforce fenced code blocks (```) +MD046: + style: "fenced" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9bc7457..39c6076 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,21 +1,20 @@ # pre-commit-config.yaml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- default_install_hook_types: - pre-commit diff --git a/.yamllint b/.yamllint index 8a0973a..5033dcf 100644 --- a/.yamllint +++ b/.yamllint @@ -1,21 +1,20 @@ # .yamllint for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- extends: default ignore: diff --git a/LICENSE b/LICENSE deleted file mode 100644 index af26be5..0000000 --- a/LICENSE +++ /dev/null @@ -1,678 +0,0 @@ -GPL-3.0 License - -Copyright (c) 2026 Jared Cook - - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..c6f01c6 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,660 @@ +# GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU AGPL, see . diff --git a/Makefile b/Makefile index adb0c36..7fb206a 100644 --- a/Makefile +++ b/Makefile @@ -1,21 +1,20 @@ # Makefile for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . # -------------------------------------------------- # โš™๏ธ Environment Settings # -------------------------------------------------- @@ -107,7 +106,7 @@ CHANGELOG_RELEASE_FILE := $(CHANGELOG_RELEASE_DIR)/$(RELEASE).md # -------------------------------------------------- # ๐Ÿช Template Directories (cookiecutter) # -------------------------------------------------- -COOKIE_DIR := $(PROJECT_ROOT)/{{ cookiecutter.project_slug }} +COOKIE_DIR := {{ cookiecutter.project_slug }} COOKIE_MACRO_DIR := $(COOKIE_DIR)/.cookiecutter_includes RENDERED_COOKIE_DIR := /tmp/rendered RENDERED_VENV_DIR := $(RENDERED_COOKIE_DIR)/**/.venv @@ -149,6 +148,7 @@ BLACK := $(PYTHON) -m black # -------------------------------------------------- # ๐Ÿ” Linting (ruff, yaml, jinja2) # -------------------------------------------------- +DJLINT := $(ACTIVATE) && djlint RUFF := $(PYTHON) -m ruff TOMLLINT := tomllint YAMLLINT := $(PYTHON) -m yamllint @@ -230,7 +230,7 @@ TOML_FILE_LIST := ( \ ) # -------------------------------------------------- .PHONY: \ - all list-folders venv install \ + all list-folders venv python-install \ pre-commit-init security dependency-check black-formatter-check \ black-formatter-fix render-cookiecutter jinja2-lint-check ruff-lint-check \ ruff-lint-fix toml-lint-check yaml-lint-check format-check \ @@ -243,7 +243,7 @@ TOML_FILE_LIST := ( \ # -------------------------------------------------- # Default: run lint, typecheck, spellcheck, tests, & docs # -------------------------------------------------- -all: install lint-check typecheck spellcheck test build-docs +all: python-install lint-check typecheck spellcheck test build-docs # -------------------------------------------------- # Make Internal Utilities # -------------------------------------------------- @@ -269,7 +269,7 @@ venv: $(AT)$(CREATE_VENV) $(AT)echo "โœ… Virtual environment created." -install: venv +python-install: venv $(AT)echo "๐Ÿ“ฆ Installing project dependencies..." $(AT)$(PIP) install --upgrade pip setuptools wheel # $(AT)$(PIP) install -e $(DEPS) @@ -333,8 +333,20 @@ render-cookiecutter: $(AT)rm -rf $(RENDERED_COOKIE_DIR) $(AT)$(COOKIECUTTER) . --no-input \ --output-dir $(RENDERED_COOKIE_DIR) \ - --overwrite-if-exists + --overwrite-if-exists \ + --keep-project-on-failure + +djlint-lint-check: + $(AT)echo "๐Ÿ” djlint lint..." + $(AT)$(DJLINT) . --lint --profile=jinja + $(AT)echo "โœ… Finished linting check of jinja2 macro files with djlint!" +djlint-lint-fix: + $(AT)echo "๐Ÿ” djlint reformat..." + $(AT)$(DJLINT) . --reformat + $(AT)echo "โœ… Finished reformatting of jinja2 macro files with djlint!" + +# Deprecated for cookiecutter projects (USE: djlint-lint-check) jinja2-lint-check: $(AT)echo "๐Ÿ” jinja2 lint..." $(AT)jq '{cookiecutter: .}' cookiecutter.json > /tmp/_cc_wrapped.json @@ -376,7 +388,7 @@ yaml-lint-check: $(AT)$(YAMLLINT) $(RENDERED_COOKIE_DIR) $(AT)echo "โœ… Finished linting check of yaml files with yamllint!" -lint-check: render-cookiecutter ruff-lint-check toml-lint-check yaml-lint-check +lint-check: render-cookiecutter djlint-lint-check ruff-lint-check toml-lint-check yaml-lint-check lint-fix: ruff-lint-fix # -------------------------------------------------- # ๐ŸŽ“ Spellchecker (codespell) @@ -403,6 +415,9 @@ test: # -------------------------------------------------- # ๐Ÿ“š Documentation (Jekyll + nutrimatic) # -------------------------------------------------- +ruby-install: + $(MAKE) -C $(JEKYLL_DIR) ruby-install; + jekyll: $(MAKE) -C $(JEKYLL_DIR) all; @@ -468,7 +483,7 @@ git-release: # ๐Ÿ“ข Release # -------------------------------------------------- pre-commit: test security dependency-check format-fix lint-check spellcheck typecheck -pre-release: clean install pre-commit build-docs changelog build +pre-release: clean python-install pre-commit build-docs changelog build release: git-release bump-version-patch # -------------------------------------------------- # ๐Ÿงน Clean artifacts diff --git a/cliff.toml b/cliff.toml index a2dbc03..53b1062 100644 --- a/cliff.toml +++ b/cliff.toml @@ -1,22 +1,20 @@ # cliff.toml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# GNU Affero General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -# - +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . # Git-Cliff config for hybrid changelog system [git] conventional_commits = true diff --git a/cspell.json b/cspell.json index 554ed02..b1caecb 100644 --- a/cspell.json +++ b/cspell.json @@ -3,30 +3,47 @@ "language": "en", "useGitignore": true, "words": [ + "antsibull", + "antsichaut", "bumpversion", + "cla", + "ccla", "cli", "codespell", "cookiecutter", "cookiecutter_project_upgrader", + "dco", "deptry", "ehthumbs", + "endmacro", + "endraw", + "endset", + "flatpak", "gitcliff", "githubusercontent", + "icla", "mkdirp", + "nameisok", "nutrimatic", "nutri-matic", + "pkg", + "pkgs", "pipaudit", "pip-audit", "pyproject", "pytest", + "pyupgrade", "rpmnew", + "rustc", "streetsidesoftware", "tomllint", "tsmerge", "upgrader", "venv", "visualstudio", - "vsmarketplacebadge" + "vsmarketplacebadge", + "yaml", + "yamlfixer" ], "flagWords": [ "hte" @@ -35,6 +52,7 @@ "bash", "companies", "css", + "public-licenses", "docker", "django", "filetypes", @@ -45,6 +63,7 @@ "npm", "python", "python-common", + "rust", "softwareTerms", "typescript" ] diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 25f801d..2578c64 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -1,5 +1,4 @@ { - "__copyright": "Copyright (c) 2026 Jared Cook", "__python": { "keywords": [ "python3", @@ -10,25 +9,29 @@ "project_name": "python3-cookiecutter", "target_version": "py311" }, + "__year_range": "2025-2026", "_checkout": "main", "_copy_without_render": [ "{{ '{{' }} cookiecutter.project_slug {{ '}}' }}/*", ".cookiecutter_includes/*", ".cookiecutter_includes/**/*" ], + "_default_branch": "master", "_extensions": [ "jinja2.ext.do", - "jinja2.ext.loopcontrols" + "jinja2.ext.loopcontrols", + "jinja2_time.TimeExtension" ], "_hooks": { "post_gen_make_cmds": { "build-docs": false, "changelog": false, - "git-init": true, - "install": true, - "pre-commit-init": true + "git-init": false, + "pre-commit-init": false, + "python-install": true } }, + "_is_sub_template": false, "_jinja2_env_vars": { "lstrip_blocks": true, "trim_blocks": true @@ -40,17 +43,27 @@ "add_sphinx_docs": false, "author": "Jared Cook", "buymeacoffee_username": "jcook3701", + "changelog": "git-cliff", + "company": null, + "contribution_model": "CLA", + "copyright": "Copyright (c) 2025-2026, Jared Cook", + "current_year": "2026", "description": "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation.", "email": "jcook3701+github@gmail.com", "ga_tracking": "G-C7PWLWSHB9", + "github_io": "https://jcook3701.github.io/python3-cookiecutter", + "github_org": null, "github_username": "jcook3701", - "license": "GPL-3.0", + "license": "AGPL-3.0-or-later", "linkedin_usercode": "jared-cook-b3585a114", "project_name": "python3-cookiecutter", "project_slug": "python3-cookiecutter", + "publication_year": "2025", "python_version": "3.11", + "repo_url": "https://github.com/jcook3701/python3-cookiecutter", "template_type": "cookiecutter", - "theme": "pmarsceill/just-the-docs", + "theme": "just-the-docs/just-the-docs@v0.11.0", + "timezone": "America/Los_Angeles", "twitter_username": "", "version": "0.1.0" } diff --git a/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json b/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json @@ -0,0 +1 @@ +{} diff --git a/docs/jekyll/Gemfile b/docs/jekyll/Gemfile index a3aebeb..0c08968 100755 --- a/docs/jekyll/Gemfile +++ b/docs/jekyll/Gemfile @@ -1,5 +1,21 @@ source 'https://rubygems.org' -gem "faraday", "~> 2.7", ">= 2.7.11" -gem "faraday-retry" -gem "github-pages", group: :jekyll_plugins +# Core Dependencies +gem "faraday", "~> 2.14" +gem "faraday-retry", "~> 2.3" +gem "jekyll", "~> 4.4" +gem "just-the-docs", "~> 0.11" + +gem "bigdecimal" +gem "csv" +gem "logger" +gem "base64" + +group :jekyll_plugins do + gem "jekyll-seo-tag" + gem "jekyll-sitemap" + gem "jekyll-include-cache" + gem "jekyll-github-metadata" + gem "jekyll-remote-theme" + gem "jekyll-redirect-from" +end diff --git a/docs/jekyll/Makefile b/docs/jekyll/Makefile index 9dd6cfc..5359927 100644 --- a/docs/jekyll/Makefile +++ b/docs/jekyll/Makefile @@ -39,22 +39,28 @@ AUTHOR = "Jared Cook" VERSION = "0.1.0" PUBLISHDIR ?= # -------------------------------------------------- -# ๐Ÿ“˜ Documentation (Sphinx + Jekyll) +# ๐Ÿ“š Documentation (Sphinx + Jekyll) # -------------------------------------------------- -JEKYLL_BUILD := bundle exec jekyll build --quiet +RUBY_INSTALL := bundle install +JEKYLL_BUILD := bundle exec jekyll build --trace --verbose JEKYLL_CLEAN := bundle exec jekyll clean JEKYLL_SERVE := bundle exec jekyll serve # -------------------------------------------------- -.PHONY: all jekyll jekyll-serve build run clean help +.PHONY: all ruby-install jekyll jekyll-serve build run clean help # -------------------------------------------------- # Default: # -------------------------------------------------- -all: build +all: ruby-install build # -------------------------------------------------- -# ๐Ÿ“˜ Documentation (Jekyll) +# โ™ฆ๏ธ Ruby +# -------------------------------------------------- +ruby-install: + $(AT)$(RUBY_INSTALL) +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Jekyll) # -------------------------------------------------- jekyll: - $(AT)echo "๐Ÿ”จ Building Jekyll site ๐Ÿ“˜..." + $(AT)echo "๐Ÿ”จ Building Jekyll site ๐Ÿ“š..." $(AT)$(JEKYLL_BUILD) $(AT)echo "โœ… Full documentation build complete!" @@ -80,6 +86,7 @@ help: $(AT)echo " version: $(PACKAGE_VERSION)" $(AT)echo "" $(AT)echo "Usage:" + $(AT)echo " make ruby-install Installs Gemfile packages." $(AT)echo " make build Generate Jekyll documentation" $(AT)echo " make run Serve Jekyll site locally" $(AT)echo " make clean Clean Jekyll build artifacts" diff --git a/docs/jekyll/README.md b/docs/jekyll/README.md index 2f2e9af..dcfeb6b 100644 --- a/docs/jekyll/README.md +++ b/docs/jekyll/README.md @@ -1,7 +1,51 @@ # {{ site.title }} -__Author:__ {{ site.author }} -__Version:__ {{ site.version }} +[![License](https://img.shields.io/github/license/{{ site.github_username }}{{ site.baseurl }})](LICENSE.md) + +**Author:** {{ site.author }} +**Version:** {{ site.version }} ## Overview + {{ site.description }} + +*** + +**CI/CD Check List:** + +* ![dependency-check]({{ site.repo_url }}/actions/workflows/dependency-check.yml/badge.svg) +* ![format-check]({{ site.repo_url }}/actions/workflows/format-check.yml/badge.svg) +* ![lint-check]({{ site.repo_url }}/actions/workflows/lint-check.yml/badge.svg) +* ![security-audit]({{ site.repo_url }}/actions/workflows/security-audit.yml/badge.svg) +* ![spellcheck]({{ site.repo_url }}/actions/workflows/spellcheck.yml/badge.svg) +* ![tests]({{ site.repo_url }}/actions/workflows/tests.yml/badge.svg) +* ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg) + +*** + + + +## Getting Started + +* [Requirements]({{ site.github_io_url }}/manual/setup-guide/requirements) +* [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide) + +## Documentation + +The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}). + +## Contributing + +If you're interested in contributing to the {{ site.title }} project: +* Start by reading the [contributing guide]({{ site.github_io_url }}/manual/developer-resources/contribute). +* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/manual/contribute/developer-guide). +* Look through our [style guide]({{ site.github_io_url }}/manual/contribute/style-guides/index). + +## License + +{{ site.copyright }} + +This project is licensed under the **{{ site.license }} License**. +See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text. + +SPDX-License-Identifier: {{ site.license }} diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml index e049703..a4b030e 100755 --- a/docs/jekyll/_config.yml +++ b/docs/jekyll/_config.yml @@ -1,17 +1,51 @@ # python3-cookiecutter Documentation --- - title: "python3-cookiecutter" author: "Jared Cook" version: "0.1.0" +license: "AGPL-3.0-or-later" +copyright: "Copyright (c) 2025-2026, Jared Cook" +timezone: "America/Los_Angeles" description: "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation." -remote_theme: "pmarsceill/just-the-docs" +remote_theme: "just-the-docs/just-the-docs@v0.11.0" ga_tracking: "G-C7PWLWSHB9" -repo_name: "python3-cookiecutter" +repo_url: "https://github.com/jcook3701/python3-cookiecutter" +repo_blob: "https://github.com/jcook3701/python3-cookiecutter/blob/master" +github_io_url: "https://jcook3701.github.io/python3-cookiecutter" +repository: "jcook3701/python3-cookiecutter" + +# Specifies the site's subpath for correct URL generation baseurl: "/python3-cookiecutter" -repo_url: > - https://github.com/jcook3701/python3-cookiecutter + +collections: + manual: + output: true + permalink: /:collection/:path + + resources: + output: true + permalink: /:collection/:path + +just_the_docs: + collections: + manual: + name: Manual + nav_fold: true + nav_exclude: false + + resources: + name: "External Links" + nav_fold: false + nav_exclude: false + +plugins: + - jekyll-remote-theme + - jekyll-redirect-from + - jekyll-seo-tag + - jekyll-github-metadata + - jekyll-include-cache + - jekyll-sitemap # Author Remote User Accounts # twitter_username: "" @@ -64,19 +98,14 @@ aux_links_new_tab: false # using page variables or the minimal layout nav_enabled: true -# External navigation links -nav_external_links: - - title: "python3-cookiecutter on GitHub" - url: "https://github.com/jcook3701/python3-cookiecutter" - # Back to top link back_to_top: true back_to_top_text: "Back to top" footer_content: >- - Copyright © 2025 Jared Cook. Distributed by an - - MIT license. + Copyright (c) 2025-2026, Jared Cook. Distributed by an + + AGPL-3.0-or-later license. @@ -118,15 +147,12 @@ callouts: title: Warning color: red -plugins: - - jekyll-seo-tag - - jekyll-github-metadata - - jekyll-include-cache - - jekyll-sitemap - kramdown: auto_ids: true +include: + - .well-known + # Exclude files/folders from Jekyll processing exclude: - node_modules diff --git a/docs/jekyll/_manual/contribute/create-feature-request.md b/docs/jekyll/_manual/contribute/create-feature-request.md new file mode 100644 index 0000000..b6d454e --- /dev/null +++ b/docs/jekyll/_manual/contribute/create-feature-request.md @@ -0,0 +1,59 @@ +--- +layout: default +title: Create a feature request +nav_order: 1 +parent: Contribute +--- +## Create a feature request + +Feature requests help us understand what you need from python3-cookiecutter. This document guides you through writing effective feature requests that help maintainers understand your needs and prioritize improvements. + +## Before you begin + +We're excited to hear your ideas! Before you submit a feature request, consider these resources: + +- Read the [Code of Conduct]({{ site.repo_blob }}/.github/CODE_OF_CONDUCT.md) to understand our community guidelines. +- Search [existing feature requests](https://github.com/jcook3701/python3-cookiecutter/issues?q=is%3Aissue+is%3Aopen+label%3Atype%2Ffeature-request) to see if someone already suggested something similar. + +## Your first feature request + +When you're ready to submit a feature request, use the [feature request template](https://github.com/jcook3701/python3-cookiecutter/issues/new?template=02-feature-request.yml). The template has three sections that help maintainers understand what you need and why. + + + +## Best practices for feature requests + +Follow these guidelines to increase the chances of your feature request being accepted: + +### Keep it focused + +Request one feature at a time. If you have multiple ideas, create separate feature requests for each one. This makes it easier to discuss, prioritize, and implement each feature independently. + +### Research first + +Before submitting, search for similar requests. If you find an existing request that's close to your idea, add your use case and context to that discussion instead of creating a duplicate. + +### Provide context + +The more context you provide, the better maintainers can understand your needs. Include: + +- Your environment or setup (which data sources, plugins, or features you're using) +- Your workflow or process +- Why this matters to you +- Any workarounds you've tried + +### Be open to alternatives + +Maintainers might suggest different approaches to solve your problem. Be open to these alternatives as they might be easier to implement or more maintainable in the long term. + +### Stay engaged + +After submitting your feature request, monitor the discussion. Answer questions from maintainers and provide clarification when needed. This helps move your request forward. + +## Contributing the feature yourself + +If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines]({% link _manual/contribute/create-pull-request.md %}). + +We welcome community contributions and appreciate your help making python3-cookiecutter better! diff --git a/docs/jekyll/_manual/contribute/create-pull-request.md b/docs/jekyll/_manual/contribute/create-pull-request.md new file mode 100644 index 0000000..e51ef3d --- /dev/null +++ b/docs/jekyll/_manual/contribute/create-pull-request.md @@ -0,0 +1,18 @@ +--- +layout: default +title: Create a pull request +nav_order: 1 +parent: Contribute +--- + +## Create a pull request + +Every contribution to python3-cookiecutter's software begins with a [pull request](https://help.github.com/en/articles/about-pull-requests/). This document guides you through the process of creating a PR. + +## Before you begin + +We know you're excited to create your first pull request. Before we get started, read these resources first: + +- Get started [contributing to python3-cookiecutter]({{ site.repo_blob }}/.github/CONTRIBUTING.md). +- Make sure your code follows the relevant [style guides]({% link _manual/contribute/style-guides/index.md %}). +- It's recommended you [set up precommit hooks]({% link _manual/contribute/developer-guide.md %}) to auto-format when you commit. diff --git a/docs/jekyll/_manual/contribute/developer-guide.md b/docs/jekyll/_manual/contribute/developer-guide.md new file mode 100644 index 0000000..e6bbf72 --- /dev/null +++ b/docs/jekyll/_manual/contribute/developer-guide.md @@ -0,0 +1,82 @@ +--- +layout: default +title: Developer Guide +nav_order: 1 +parent: Contribute +--- + +## Developer guide + +This guide helps you get started developing python3-cookiecutter. + +## Development Strategy + +All Makefile commands are used in __ci/cd__ to ensure that if they pass locally they should also pass once pushed to github. + +### ๐Ÿ๏ธ Build environment (.venv) + +``` shell +$ make install +``` + +### ๐Ÿงฌ Dependency Management (deptry) + +```shell +$ make dependency-check +``` + +### ๐Ÿ›ก๏ธ Security Audit (pip-audit) + +```shell +$ make security +``` + +### ๐ŸŽจ Formatting (black) + +```shell +$ make format-check +``` + +```shell +$ make format-fix +``` + +### ๐Ÿ” Linting (djlint, ruff, tomllint, & yaml-lint) + +``` shell +$ make lint-check +``` + +``` shell +$ make lint-fix +``` + +### ๐ŸŽ“ Spellchecking (codespell) + +```shell +$ make spellcheck +``` + +### ๐Ÿง  Typechecking (mypy) + +``` shell +$ make typecheck +``` + +### ๐Ÿงช Testing (pytest) + +``` shell +$ make test +``` + +### ๐Ÿš€ Release (git tag) + +```shell +$ make release +``` + +### โ“ Build Help + +``` shell +$ make help +``` diff --git a/docs/jekyll/_manual/contribute/git-commit-message.md b/docs/jekyll/_manual/contribute/git-commit-message.md new file mode 100644 index 0000000..9262f8c --- /dev/null +++ b/docs/jekyll/_manual/contribute/git-commit-message.md @@ -0,0 +1,39 @@ +--- +layout: default +title: "Git Commit Message" +nav_order: 1 +parent: Contribute +--- +## Git Commit Message Format Guide + +Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by [pre-commit](https://pre-commit.com/). + +**options (default):** + +* docs +* chore +* feat +* fix +* refactor +* ci +* test +* perf +* revert +* build +* style + +**example:** + +```shell +[optional scope]: + +[optional body] + +[optional footer(s)] +``` + +* ``````: A required noun that describes the nature of the change. +* ```[optional scope]```: An optional phrase within parentheses that specifies the part of the codebase being affected (e.g., fix(parser):). +* ``````: A required short, imperative-mood summary of the changes. +* ```[optional body]```: A longer description providing additional context and "what and why" details. +* ```[optional footer(s)]```: Used for adding meta-information, such as issue references (Fixes #123) or indicating breaking changes. diff --git a/docs/jekyll/_manual/contribute/index.md b/docs/jekyll/_manual/contribute/index.md new file mode 100644 index 0000000..793ce4a --- /dev/null +++ b/docs/jekyll/_manual/contribute/index.md @@ -0,0 +1,21 @@ +--- +layout: default +title: Contribute +nav_order: 1 +has_children: true +--- +## Contribute to the python3-cookiecutter project + +We're excited that you're considering making a contribution to the python3-cookiecutter project! This is the place to find guides for contributors to our open-source project. + +These are some good resources to explore for developers: + +* [Create a pull request]({% link _manual/contribute/create-pull-request.md %}) +* [Create a feature request]({% link _manual/contribute/create-feature-request.md %}) +* [Developer guide]({% link _manual/contribute/developer-guide.md %}) +* [Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) + +Find [style guides]({% link _manual/contribute/style-guides/index.md %}) for the python3-cookiecutter software project: +* [Python]({% link _manual/contribute/style-guides/python.md %}) style guide. +* [Typescript]({% link _manual/contribute/style-guides/typescript.md %}) style guide. +* [YAML]({% link _manual/contribute/style-guides/yaml.md %}) style guide. diff --git a/docs/jekyll/_manual/contribute/merge-pull-request.md b/docs/jekyll/_manual/contribute/merge-pull-request.md new file mode 100644 index 0000000..af1e1de --- /dev/null +++ b/docs/jekyll/_manual/contribute/merge-pull-request.md @@ -0,0 +1,61 @@ +--- +layout: default +title: Merge a pull request +nav_order: 1 +parent: Contribute +--- +## Merge a pull request + +When a pull request has been reviewed and approved by at least one person and all checks have passed, then it's time to merge the pull request. + +## Who is expected to merge a pull request? + +Maintainers are responsible for merging all pull requests. If a maintainer has opened a pull request, then the general rule is that the same maintainer merges the pull request. If a non-maintainer has opened a pull request, then it's suggested that one of the maintainers who reviews the pull request should merge the pull request. + +## Checklist of considerations + +Consider (and ask about) the items on the following checklist before merging a pull request: + +- Is it reviewed and approved? +- Have all checks passed? +- Does it have a proper pull request title? +- Does it need to be added to the changelog (release notes)? +- Does it need backporting? + +## Before merge + +Before actually merging a pull request, consider the following things: + +### Status checks + +Before you can merge a pull request, it must have a review approval, and all the required status checks must pass. + +### Format the pull request title + + + +### Changelog (automated) + +## Doing the actual merge + +The best time to actually merge the pull request varies from case to case. All commits in a pull request are squashed. + +You can change the commit message before merging. Please remember that developers might use the commit information for tasks like reviewing changes of files, doing Git blame, and resolving merge conflicts. + +While there aren't formal best practices around this process, you can consider the following guidance: + +**Do:** + +- Make sure the pull request title is formatted properly before merging. Doing so automatically gives you a good and short summary of the commit. +- Leave `Co-authored-by:` lines as is so that co-authors are credited for the contribution. +- Remove any commit information that doesn't bring any context to the change. + +**Consider:** + +- Keep any references to issues that the pull request fixes, closes, or references. Doing this allows cross-reference between the commit and referenced issue or issues. + +To finalize the merge, click the **Confirm squash and merge** button. + +## After the merge + +Make sure to close any referenced or related issues. We recommend that you assign the same milestone on the issues that the pull request fixes or closes, but this isn't required. diff --git a/docs/jekyll/_manual/contribute/style-guides/index.md b/docs/jekyll/_manual/contribute/style-guides/index.md new file mode 100644 index 0000000..c8d761a --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/index.md @@ -0,0 +1,12 @@ +--- +layout: default +title: "Style Guide" +nav_order: 1 +has_children: true +parent: Contribute +--- + +## Style Guides +* [Python]({% link _manual/contribute/style-guides/python.md %}) style guide. +* [Typescript]({% link _manual/contribute/style-guides/typescript.md %}) style guide. +* [YAML]({% link _manual/contribute/style-guides/yaml.md %}) style guide. diff --git a/docs/jekyll/_manual/contribute/style-guides/python.md b/docs/jekyll/_manual/contribute/style-guides/python.md new file mode 100644 index 0000000..c2b3dbf --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/python.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "Python Style Guide" +nav_order: 1 +parent: "Style Guide" +--- +## Python Style Guide diff --git a/docs/jekyll/_manual/contribute/style-guides/typescript.md b/docs/jekyll/_manual/contribute/style-guides/typescript.md new file mode 100644 index 0000000..df8c660 --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/typescript.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "Typescript Style Guide" +nav_order: 1 +parent: "Style Guide" +--- +## Typescript Style Guide diff --git a/docs/jekyll/_manual/contribute/style-guides/yaml.md b/docs/jekyll/_manual/contribute/style-guides/yaml.md new file mode 100644 index 0000000..815b81d --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/yaml.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "YAML Style Guide" +nav_order: 1 +parent: "Style Guide" +--- +## YAML Style Guide diff --git a/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md b/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md new file mode 100644 index 0000000..0c9f0a0 --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md @@ -0,0 +1,20 @@ +--- +layout: default +title: CLA Privacy Policy +nav_order: 1 +parent: "Developer Resources" +--- +## python3-cookiecutter CLA Privacy Policy + +## Collection and storage of personal data and the nature and purpose of their use + +Most Project business is conducted publicly, and privacy of submitted information is not expected. + +Specifically, information is exchanged via public email lists and public code repositories. Public code repositories use patch submission, pull requests, discussions, and bug reports. None of these tools keep submitted information private. They are publicly accessible and archived in multiple locations around the world, by the Project and third parties. + +You should never submit personally identifiable information (PII) via any of these mechanisms. + + diff --git a/docs/jekyll/_manual/developer-resources/cla.md b/docs/jekyll/_manual/developer-resources/cla.md new file mode 100644 index 0000000..db2167a --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/cla.md @@ -0,0 +1,26 @@ +--- +layout: default +title: Contributor License Agreement (CLA) +nav_order: 1 +parent: "Developer Resources" +--- +## python3-cookiecutter Contributor License Agreement ("Agreement") V1.0 + +This agreement is based on the Apache Software Foundation Individual Contributor License Agreement ("Agreement") V2.2 + +Thank you for your interest in __The python3-cookiecutter project by Jared Cook,__ dba Jared Cook (the "Project"). To clarify the intellectual property license granted with Contributions from any person or entity, the Project must have on file a signed Contributor License Agreement ("CLA") from each Contributor, indicating agreement with the license terms below. This agreement is for your protection as a Contributor as well as the protection of the Project and its users. It does not change your rights to use your own Contributions for any other purpose. + +You accept and agree to the following terms and conditions for Your Contributions (present and future) that you submit to the Project. In return, the Project shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with its nonprofit status and bylaws in effect at the time of the Contribution. Except for the license granted herein to the Project and recipients of software distributed by the Project, You reserve all right, title, and interest in and to Your Contributions. + +1. __Definitions. "You"__ (or __"Your"__) shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with the Project. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the Project for inclusion in, or documentation of, any of the products owned or managed by the Project (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Project or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." +2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the Project and to recipients of software distributed by the Project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. +3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the Project and to recipients of software distributed by the Project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. +4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the Project, or that your employer has executed a separate Corporate CLA with the Project. +5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions. +6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. +7. Should You wish to submit work that is not Your original creation, You may submit it to the Project separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". +8. You agree to notify the Project of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect. + +This is a legal contract containing Personally Identifiable Information. +Please refer to our [cla-privacy-policy]({% link _manual/developer-resources/cla-privacy-policy.md %}) for the policy +governing how this information is used and shared. diff --git a/docs/jekyll/_manual/developer-resources/contribute.md b/docs/jekyll/_manual/developer-resources/contribute.md new file mode 100644 index 0000000..2323c99 --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/contribute.md @@ -0,0 +1,33 @@ +--- +layout: default +title: Contribute +nav_order: 2 +parent: "Developer Resources" +--- +## Contribute to python3-cookiecutter + +This page lists resources for developers who want to contribute to the python3-cookiecutter ecosystem. + +## Make technical contributions + +### Contribute code to python3-cookiecutter + +* [Developer guide]({% link _manual/contribute/developer-guide.md %}) +* [Create a pull request]({% link _manual/contribute/create-pull-request.md %}) walks you through preparing a clear, descriptive pull request. +* [Create a feature request]({% link _manual/contribute/create-feature-request.md %}) +* [Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) +* Browse all [issues](https://github.com/jcook3701/python3-cookiecutter/issues) to find a good first task. + +### Contribute without code + +* Report a bug with the [bug report template](https://github.com/jcook3701/python3-cookiecutter/issues/new?template=01-bug-report.yml) and include steps to reproduce. +* Submit a [feature request](https://github.com/jcook3701/python3-cookiecutter/issues/new?template=02-feature-request.yml) to propose improvements. +* Report security vulnerabilities following our [security policy]({{ site.repo_blob }}/.github/SECURITY.md). + +### Best practices and style + +Our [style guides]({% link _manual/contribute/style-guides/index.md %}) outline python3-cookiecutter style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding! + +* [Python style guide]({% link _manual/contribute/style-guides/python.md %}). +* [Typescript style guide]({% link _manual/contribute/style-guides/typescript.md %}). +* [YAML style guide]({% link _manual/contribute/style-guides/yaml.md %}). diff --git a/docs/jekyll/_manual/developer-resources/index.md b/docs/jekyll/_manual/developer-resources/index.md new file mode 100644 index 0000000..27af800 --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: "Developer Resources" +nav_order: 1 +has_children: true +--- +## Developer resources + +This section of the documentation contains additional resources for developers and contributors. + +## Contribute to python3-cookiecutter + +Refer to the [Contribute to python3-cookiecutter]({% link _manual/developer-resources/contribute.md %}) guide to learn the various ways you can contribute to python3-cookiecutter. Read the [python3-cookiecutter Contributor License Agreement]({% link _manual/developer-resources/cla.md %}) before making any contribution. diff --git a/docs/jekyll/_manual/introduction/getting-started.md b/docs/jekyll/_manual/introduction/getting-started.md new file mode 100644 index 0000000..2c9f7d1 --- /dev/null +++ b/docs/jekyll/_manual/introduction/getting-started.md @@ -0,0 +1,53 @@ +--- +layout: default +title: Getting Started +nav_order: 1 +parent: Introduction +--- +## Getting started with python3-cookiecutter + +1. [Requirements]({% link _manual/setup-guide/requirements.md %}) include python3, Nutri-Matic (docs & hooks), rust (rustup), and git-cliff (changelogs). + * Python3 Packages + 1. [cookiecutter](https://github.com/cookiecutter/cookiecutter) is required to utilize templates from github. + 2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic) is required to be sourced in python environment for template cookiecutter hooks to work. + +I find that it easiest to clone the nutri-matic repository. Use the included makefile to install all python dependencies with ```make python-install``` from within the cloned directory. Then, source the created file, ```.venv/bin/activate```, or point the below script variable, ```PYTHON_VENV```, to desired python virtual environment. + +### Examples + + Bash script can be copied and pasted into a shell file. Then, used to begin generating new projects. + +__Template Options:__ +* [cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter) to generate new cookiecutter template projects. +* [python3-cookiecutter](https://github.com/jcook3701/python3-cookiecutter) to generate python3 projects. +* [ansible-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter) to generate ansible galaxy project. + + + + + + + + + +```shell +#!/bin/bash + +PYTHON_VENV="~/Documents/git_repo/nutri-matic/.venv/bin/activate" + +PROJECT_NAME="example project name" +TEMPLATE="cookiecutter-cookiecutter" +LICENSE="AGPL-3.0-or-later" +BRANCH="main" +DESCRIPTION="Example cookiecutter template project." + +rm -rf $PROJECT_NAME/ +source $PYTHON_VENV +cookiecutter git@github.com:jcook3701/$TEMPLATE.git \ + --checkout $BRANCH \ + --no-input \ + project_name=$PROJECT_NAME \ + description=$DESCRIPTION \ + license=$LICENSE +deactivate +``` diff --git a/docs/jekyll/_manual/introduction/index.md b/docs/jekyll/_manual/introduction/index.md new file mode 100644 index 0000000..f7e9c03 --- /dev/null +++ b/docs/jekyll/_manual/introduction/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Introduction +nav_order: 1 +has_children: true +--- +## Introduction to python3-cookiecutter + + +* [Getting Started]({% link _manual/introduction/getting-started.md %}) diff --git a/docs/jekyll/_manual/introduction/installation-guide.md b/docs/jekyll/_manual/introduction/installation-guide.md new file mode 100644 index 0000000..7d4c0be --- /dev/null +++ b/docs/jekyll/_manual/introduction/installation-guide.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "Installation Guide" +nav_order: 1 +parent: Introduction +--- +## Installation Guide for python3-cookiecutter (Linux) diff --git a/docs/jekyll/_manual/setup-guide/index.md b/docs/jekyll/_manual/setup-guide/index.md new file mode 100644 index 0000000..2a1ba0e --- /dev/null +++ b/docs/jekyll/_manual/setup-guide/index.md @@ -0,0 +1,9 @@ +--- +layout: default +title: "Setup Guide" +nav_order: 1 +has_children: true +--- +## python3-cookiecutter Setup + +1. Install all [requirements]({% link _manual/setup-guide/requirements.md %}) to effectively pull and utilize cookiecutter template repository effectively. diff --git a/docs/jekyll/_manual/setup-guide/requirements.md b/docs/jekyll/_manual/setup-guide/requirements.md new file mode 100644 index 0000000..349d0ea --- /dev/null +++ b/docs/jekyll/_manual/setup-guide/requirements.md @@ -0,0 +1,30 @@ +--- +layout: default +title: Requirements +nav_order: 1 +parent: "Setup Guide" +--- + +## python3-cookiecutter Requirements + +1. Python 3.11 + ```shell + $ sudo apt install python3.11 python3.11-dev python3.11-venv + ``` +2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic) + __Note:__ + __Example:__ Install with the following command (Recommended that this is installed in a python [virtual environment]({% link _manual/tutorials/create-virtual-env.md %})): + ```shell + $ python -m pip install nutri-matic + ``` +3. [rustup](https://rust-lang.org/tools/install/) + __Note:__ I found that it is easiest to use rustup to manage rustc and cargo but this is not required. + __Example:__ Install rustup with the following: + ```shell + $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + ``` +4. [git-cliff](https://git-cliff.org/) + __Note:__ git-cliff can generate changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers. + ```shell + $ cargo install git-cliff + ``` diff --git a/docs/jekyll/_manual/troubleshooting/faq.md b/docs/jekyll/_manual/troubleshooting/faq.md new file mode 100644 index 0000000..a995a64 --- /dev/null +++ b/docs/jekyll/_manual/troubleshooting/faq.md @@ -0,0 +1,8 @@ +--- +layout: default +title: FAQ +nav_order: 1 +parent: Troubleshooting +--- + +## python3-cookiecutter Frequently Asked Questions diff --git a/docs/jekyll/_manual/troubleshooting/index.md b/docs/jekyll/_manual/troubleshooting/index.md new file mode 100644 index 0000000..4d89f0d --- /dev/null +++ b/docs/jekyll/_manual/troubleshooting/index.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Troubleshooting +nav_order: 1 +has_children: true +--- +## Troubleshooting python3-cookiecutter + +* **[FAQ]({% link _manual/troubleshooting/faq.md %})** Common questions are answered in our Frequently Asked Questions diff --git a/docs/jekyll/_manual/tutorials/create-virtual-env.md b/docs/jekyll/_manual/tutorials/create-virtual-env.md new file mode 100644 index 0000000..bb8d7fc --- /dev/null +++ b/docs/jekyll/_manual/tutorials/create-virtual-env.md @@ -0,0 +1,27 @@ +--- +layout: default +title: Create Virtual Environment +nav_order: 1 +parent: Tutorials +--- +## Install Python3 and Python Virtual Environment + +Either install python 3.10 or 3.11. Below example is to install python 3.11, however, to install and utilize python 3.10 just replace '11' with '10' in each instance below. + +```shell +$ sudo apt install python3.11 python3.11-dev python3.11-venv +``` + +## Create Virtual Environment (Python) + +First you need to decide where you would like you virtual environment to be stored. Personally I use ```~/Documents/python3-venvs``` to store utility python environments. After creating the directory where you would like to store you python environments move into it and run the below command. + +``` shell +$ python3.11 -m venv nutri-matic-venv +``` + +Then source into that python environment. + +```shell +$ source ./nutri-matic-venv/bin/activate +``` diff --git a/docs/jekyll/_manual/tutorials/index.md b/docs/jekyll/_manual/tutorials/index.md new file mode 100644 index 0000000..7f7b0d7 --- /dev/null +++ b/docs/jekyll/_manual/tutorials/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Tutorials +nav_order: 1 +has_children: true +--- +## python3-cookiecutter Tutorials + +* [Create Virtual Environment]({% link _manual/tutorials/create-virtual-env.md %}) +* [Nutri-Matic]({% link _manual/tutorials/nutri-matic.md %}) diff --git a/docs/jekyll/_manual/tutorials/nutri-matic.md b/docs/jekyll/_manual/tutorials/nutri-matic.md new file mode 100644 index 0000000..4fc4bda --- /dev/null +++ b/docs/jekyll/_manual/tutorials/nutri-matic.md @@ -0,0 +1,25 @@ +--- +layout: default +title: "Nutri-Matic" +nav_order: 1 +parent: Tutorials +--- +## Nutri-Matic Setup + +First clone the [Nutri-Matic](https://github.com/jcook3701/nutri-matic) python utility. This is needed to clone all [jcook3701's](https://github.com/jcook3701), cookiecutter templates, with the ```cookiecutter``` command. + +```shell +$ git clone git@github.com:jcook3701/nutri-matic.git +``` + +Next, move into the newly cloned directory, ```cd nutri-matic``` . Then utilize the [developer guide]({% link _manual/contribute/developer-guide.md %}) process and run ```make python-install``` to create a python virtual environment stored within the, ```.venv```, folder. This ensures the latest version of nutri-matic code and is very helpful for development on any of the template repositories. + +Finally, source Nutri-Matic's created virtual environment with the directory, ```.venv```, and begin generating templates. + +```shell +$ source .venv/bin/active +``` + +The Nutri-Matic package is responsible for managing all [jcook3701's](https://github.com/jcook3701) cookiecutter template hooks and build features. + +After the environment is sourced and other project dependencies are installed; templates should be able to be generated using the commands found in our [getting started]({% link _manual/introduction/getting-started.md %}) guide. diff --git a/docs/jekyll/_manual/upgrade-guide/index.md b/docs/jekyll/_manual/upgrade-guide/index.md new file mode 100644 index 0000000..8fc777b --- /dev/null +++ b/docs/jekyll/_manual/upgrade-guide/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: "Upgrade Guide" +nav_order: 1 +has_children: true +--- +## python3-cookiecutter Upgrade Guide + +### ๐Ÿช Project Updater (cookiecutter_project_upgrader) + +```shell +$ source .venv/bin/activate && cookiecutter_project_upgrader --context-file ./docs/cookiecutter_input.json --upgrade-branch main +``` diff --git a/docs/jekyll/_manual/whatsnew/index.md b/docs/jekyll/_manual/whatsnew/index.md new file mode 100644 index 0000000..3366135 --- /dev/null +++ b/docs/jekyll/_manual/whatsnew/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "What's New" +nav_order: 1 +has_children: true +--- +## What's new in python3-cookiecutter diff --git a/docs/jekyll/_resources/repository-link.md b/docs/jekyll/_resources/repository-link.md new file mode 100644 index 0000000..1266c55 --- /dev/null +++ b/docs/jekyll/_resources/repository-link.md @@ -0,0 +1,5 @@ +--- +title: "python3-cookiecutter on GitHub ๐Ÿ”—" +nav_order: 1 +redirect_to: "https://github.com/jcook3701/python3-cookiecutter" +--- diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json index 6c369be..f9848c6 100644 --- a/docs/jekyll/docs/cookiecutter_input.json +++ b/docs/jekyll/docs/cookiecutter_input.json @@ -1,12 +1,15 @@ { + "__year_range": "2025-2026", "_checkout": null, "_copy_without_render": [ "README.md", "_includes/*" ], + "_default_branch": "master", "_extensions": [ "jinja2.ext.do", - "jinja2.ext.loopcontrols" + "jinja2.ext.loopcontrols", + "jinja2_time.TimeExtension" ], "_is_sub_template": true, "_jinja2_env_vars": { @@ -18,14 +21,25 @@ "_template": "https://github.com/jcook3701/github-docs-cookiecutter.git", "author": "Jared Cook", "buymeacoffee_username": "jcook3701", + "company": null, + "contribution_model": "CLA", + "copyright": "Copyright (c) 2025-2026, Jared Cook", + "current_year": "2026", "description": "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation.", "email": "jcook3701+github@gmail.com", "ga_tracking": "G-C7PWLWSHB9", + "github_io": "https://jcook3701.github.io/python3-cookiecutter", + "github_org": null, "github_username": "jcook3701", + "license": "AGPL-3.0-or-later", "linkedin_usercode": "jared-cook-b3585a114", "project_name": "python3-cookiecutter", "project_slug": "python3-cookiecutter", - "theme": "pmarsceill/just-the-docs", + "publication_year": "2025", + "repo_url": "https://github.com/jcook3701/python3-cookiecutter", + "template_type": "cookiecutter", + "theme": "just-the-docs/just-the-docs@v0.11.0", + "timezone": "America/Los_Angeles", "twitter_username": "", "version": "0.1.0" } diff --git a/docs/jekyll/index.md b/docs/jekyll/index.md index 05840a1..94f94b2 100644 --- a/docs/jekyll/index.md +++ b/docs/jekyll/index.md @@ -4,23 +4,17 @@ title: python3-cookiecutter nav_order: 1 description: Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation. --- - - - {% include snippet_loader.html %} {% if site.carousel_images %} - {% include image-carousel.html %} + {% include image-carousel.html %} {% endif %} - {% include_relative README.md %} - -# โ˜• Support Me +## โ˜• Support Me If you enjoy this project, please consider buying me a coffee or making a code contribution. -# Social Links +## Social Links {% include social-bar.html %} - diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index a98a7b3..bb4669c 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -1,21 +1,20 @@ # post_gen_project.py for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . import json import os diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py index 81e404a..7994733 100644 --- a/hooks/pre_gen_project.py +++ b/hooks/pre_gen_project.py @@ -1,21 +1,20 @@ # pre_gen_project.py for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . import json diff --git a/pyproject.toml b/pyproject.toml index f7ae4c6..d7db33b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,21 +1,20 @@ # pyproject.toml for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . [build-system] @@ -30,8 +29,8 @@ authors = [ { name="Jared Cook", email="jcook3701+github@gmail.com" } ] readme = "README.md" -license = "GPL-3.0" -license-files = ["LICENSE"] +license = "AGPL-3.0-or-later" +license-files = ["LICENSE.md"] requires-python = ">=3.11" dependencies = [ "nutri-matic>=0.1", @@ -56,8 +55,10 @@ dev = [ "cookiecutter-project-upgrader>=1.3", "coverage>=7.12", "deptry>=0.24", + "djlint>=1.36", "json-lint-tools>=0.1", "jinja2-cli>=0.8", + "jinja2-time>=0.2", "mypy==1.9", "nameisok>=0.1", "pip-audit>=2.10", @@ -155,6 +156,18 @@ exclude = [ "docs/*", ] # ==================================== +# Djlint Configuration: +# ==================================== +[tool.djlint] +profile = "jinja" +ignore = "H025,H014" +indent = 4 +max_blank_lines=2 +search_path = "." +use_gitignore=true +extension = "j2" +exclude = "docs/jekyll/_site/.*" +# ==================================== # Ruff Configuration: # ==================================== [tool.ruff] diff --git a/tests/test_bake_project.py b/tests/test_bake_project.py index a14368f..968e365 100644 --- a/tests/test_bake_project.py +++ b/tests/test_bake_project.py @@ -1,21 +1,20 @@ # test_bake_project.py for python3-cookiecutter # -# Copyright (c) 2026, Jared Cook -# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# GNU Affero General Public License for more details. # +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . from pytest_cookies.plugin import Cookies From ce75f3aea374fe10bb2a96bd62b3d5ae9704b216 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Sat, 31 Jan 2026 18:13:44 -0800 Subject: [PATCH 5/7] Update template --- docs/cookiecutter_input.json | 2 +- docs/jekyll/README.md | 12 +++++++----- docs/jekyll/_config.yml | 2 +- docs/jekyll/docs/cookiecutter_input.json | 2 +- docs/jekyll/index.md | 4 ++-- pyproject.toml | 2 +- 6 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 2578c64..a35c3e4 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -48,7 +48,7 @@ "contribution_model": "CLA", "copyright": "Copyright (c) 2025-2026, Jared Cook", "current_year": "2026", - "description": "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation.", + "description": "**Python3 cookiecutter** template project + **Github docs** template generation + **Sphinx docs** template generation.", "email": "jcook3701+github@gmail.com", "ga_tracking": "G-C7PWLWSHB9", "github_io": "https://jcook3701.github.io/python3-cookiecutter", diff --git a/docs/jekyll/README.md b/docs/jekyll/README.md index dcfeb6b..9d52f31 100644 --- a/docs/jekyll/README.md +++ b/docs/jekyll/README.md @@ -11,7 +11,7 @@ *** -**CI/CD Check List:** +๐Ÿ› ๏ธ **CI/CD Check List:** * ![dependency-check]({{ site.repo_url }}/actions/workflows/dependency-check.yml/badge.svg) * ![format-check]({{ site.repo_url }}/actions/workflows/format-check.yml/badge.svg) @@ -25,23 +25,25 @@ -## Getting Started +## ๐ŸŒฑ Getting Started * [Requirements]({{ site.github_io_url }}/manual/setup-guide/requirements) * [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide) -## Documentation +## ๐Ÿ“š Documentation The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}). -## Contributing +## ๐Ÿค Contributing If you're interested in contributing to the {{ site.title }} project: * Start by reading the [contributing guide]({{ site.github_io_url }}/manual/developer-resources/contribute). * Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/manual/contribute/developer-guide). * Look through our [style guide]({{ site.github_io_url }}/manual/contribute/style-guides/index). -## License +## ๐Ÿน Authors Notes + +## โš–๏ธ License {{ site.copyright }} diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml index a4b030e..d5e89c4 100755 --- a/docs/jekyll/_config.yml +++ b/docs/jekyll/_config.yml @@ -6,7 +6,7 @@ version: "0.1.0" license: "AGPL-3.0-or-later" copyright: "Copyright (c) 2025-2026, Jared Cook" timezone: "America/Los_Angeles" -description: "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation." +description: "**Python3 cookiecutter** template project + **Github docs** template generation + **Sphinx docs** template generation." remote_theme: "just-the-docs/just-the-docs@v0.11.0" ga_tracking: "G-C7PWLWSHB9" diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json index f9848c6..88f2008 100644 --- a/docs/jekyll/docs/cookiecutter_input.json +++ b/docs/jekyll/docs/cookiecutter_input.json @@ -25,7 +25,7 @@ "contribution_model": "CLA", "copyright": "Copyright (c) 2025-2026, Jared Cook", "current_year": "2026", - "description": "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation.", + "description": "**Python3 cookiecutter** template project + **Github docs** template generation + **Sphinx docs** template generation.", "email": "jcook3701+github@gmail.com", "ga_tracking": "G-C7PWLWSHB9", "github_io": "https://jcook3701.github.io/python3-cookiecutter", diff --git a/docs/jekyll/index.md b/docs/jekyll/index.md index 94f94b2..9f7a08a 100644 --- a/docs/jekyll/index.md +++ b/docs/jekyll/index.md @@ -1,8 +1,8 @@ --- layout: default -title: python3-cookiecutter +title: "python3-cookiecutter" nav_order: 1 -description: Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation. +description: "**Python3 cookiecutter** template project + **Github docs** template generation + **Sphinx docs** template generation." --- {% include snippet_loader.html %} diff --git a/pyproject.toml b/pyproject.toml index d7db33b..c05d9b8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,7 +24,7 @@ build-backend = "setuptools.build_meta" [project] name = "python3-cookiecutter" version = "0.1.0" -description = "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation." +description = "**Python3 cookiecutter** template project + **Github docs** template generation + **Sphinx docs** template generation." authors = [ { name="Jared Cook", email="jcook3701+github@gmail.com" } ] From 3c4342e000186637793ea96910d95e81c64c638e Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Sat, 31 Jan 2026 18:14:07 -0800 Subject: [PATCH 6/7] fix(upgrader): Configuration settings. --- changelogs/CHANGELOG.md | 23 ++++++++++------------- changelogs/releases/v0.1.0.md | 23 ++++++++++------------- docs/cookiecutter_input.json | 2 +- 3 files changed, 21 insertions(+), 27 deletions(-) diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md index d8f3c40..f81873a 100644 --- a/changelogs/CHANGELOG.md +++ b/changelogs/CHANGELOG.md @@ -88,23 +88,20 @@ Develop * fix(upgrader): fixed the upgrader configuration file. * fix(tests): fix to correct test to work for python template. Need to come up with a way to correct this in cookiecutter-cookiecutter in the future. -- Update template -- Update template -- Update template -- Update template -- Merge branch 'cookiecutter-template' into feat-002 +- Feat 002 (#10) -### ๐Ÿ› Fixed +* feat(upgrade): Settings update for cookiecutter_project_upgrader files. -- *(lint)* Linting fixes for license header. +* fix(lint): Linting fixes for license header. -### ๐Ÿš€ Added +* feat(docs): Readme updates. -- *(upgrade)* Settings update for cookiecutter_project_upgrader files. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Updates to community health files for python templates. +* feat(docs): Updates to community health files for python templates. + +* fix(tests): Fix for python cookiecutter hooks tests. +- Merge pull request #11 from jcook3701/develop + +Feat 002 (#10) ### ๐Ÿงช Tests diff --git a/changelogs/releases/v0.1.0.md b/changelogs/releases/v0.1.0.md index 89962b8..ed90021 100644 --- a/changelogs/releases/v0.1.0.md +++ b/changelogs/releases/v0.1.0.md @@ -88,23 +88,20 @@ Develop * fix(upgrader): fixed the upgrader configuration file. * fix(tests): fix to correct test to work for python template. Need to come up with a way to correct this in cookiecutter-cookiecutter in the future. -- Update template -- Update template -- Update template -- Update template -- Merge branch 'cookiecutter-template' into feat-002 +- Feat 002 (#10) -### ๐Ÿ› Fixed +* feat(upgrade): Settings update for cookiecutter_project_upgrader files. -- *(lint)* Linting fixes for license header. +* fix(lint): Linting fixes for license header. -### ๐Ÿš€ Added +* feat(docs): Readme updates. -- *(upgrade)* Settings update for cookiecutter_project_upgrader files. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Readme updates. -- *(docs)* Updates to community health files for python templates. +* feat(docs): Updates to community health files for python templates. + +* fix(tests): Fix for python cookiecutter hooks tests. +- Merge pull request #11 from jcook3701/develop + +Feat 002 (#10) ### ๐Ÿงช Tests diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 2578c64..a35c3e4 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -48,7 +48,7 @@ "contribution_model": "CLA", "copyright": "Copyright (c) 2025-2026, Jared Cook", "current_year": "2026", - "description": "Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation.", + "description": "**Python3 cookiecutter** template project + **Github docs** template generation + **Sphinx docs** template generation.", "email": "jcook3701+github@gmail.com", "ga_tracking": "G-C7PWLWSHB9", "github_io": "https://jcook3701.github.io/python3-cookiecutter", From a37ec45cd59e6937f72ca8780fa80a2ad8431ba0 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Sat, 31 Jan 2026 21:34:50 -0800 Subject: [PATCH 7/7] fix(updater): Added configuration file that should be created for cookiecutter_project_upgrader. --- changelogs/CHANGELOG.md | 6 ++++++ changelogs/releases/v0.1.0.md | 6 ++++++ .../docs/cookiecutter_input.json | 1 + 3 files changed, 13 insertions(+) create mode 100644 {{ cookiecutter.project_slug }}/docs/cookiecutter_input.json diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md index cc1a920..049caf9 100644 --- a/changelogs/CHANGELOG.md +++ b/changelogs/CHANGELOG.md @@ -102,6 +102,12 @@ Develop - Merge pull request #11 from jcook3701/develop Feat 002 (#10) +- Update template +- Update template +- Update template +- Update template +- Update template +- Merge branch 'cookiecutter-template' into feat-003 ### ๐Ÿ› Fixed diff --git a/changelogs/releases/v0.1.0.md b/changelogs/releases/v0.1.0.md index 703cae1..3a0c233 100644 --- a/changelogs/releases/v0.1.0.md +++ b/changelogs/releases/v0.1.0.md @@ -102,6 +102,12 @@ Develop - Merge pull request #11 from jcook3701/develop Feat 002 (#10) +- Update template +- Update template +- Update template +- Update template +- Update template +- Merge branch 'cookiecutter-template' into feat-003 ### ๐Ÿ› Fixed diff --git a/{{ cookiecutter.project_slug }}/docs/cookiecutter_input.json b/{{ cookiecutter.project_slug }}/docs/cookiecutter_input.json new file mode 100644 index 0000000..b07ca2a --- /dev/null +++ b/{{ cookiecutter.project_slug }}/docs/cookiecutter_input.json @@ -0,0 +1 @@ +{{ cookiecutter | jsonify }}