Move from poetry to hatch to manage the environment (Fixes #9)

.github/workflows/changelog.yml

@@ -0,0 +1,37 @@
+name: Changelog check
+on:
+  pull_request:
+    types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
+    branches:
+      - main
+
+env:
+  PYTHON_VERSION: 3.11
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Fetch all history
+          fetch-depth: '0'
+
+      - name: Install hatch
+        run: pipx install hatch
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: 'pip'
+
+      - name: "Install Environment"
+        run: hatch env create
+
+      - name: Check for presence of a Change Log fragment (only pull requests)
+        run: |
+          git fetch --no-tags origin ${BASE_BRANCH}
+          towncrier check
+        env:
+          BASE_BRANCH: ${{ github.base_ref }}
+        if: github.event_name == 'pull_request'

.github/workflows/main.yml

@@ -15,36 +15,36 @@ jobs:
       - name: Checkout codebase
         uses: actions/checkout@v4
 
-      - name: Install poetry
-        run: pipx install poetry
+      - name: Install hatch
+        run: pipx install hatch
 
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'poetry'
+          cache: 'pip'
 
-      - name: "Install Packages"
-        run: poetry install
+      - name: "Install Environment"
+        run: hatch env create
 
       - name: "Run checks"
-        run: poetry run pre-commit run -a
+        run: hatch run check
 
   test:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout codebase
         uses: actions/checkout@v4
 
-      - name: Install poetry
-        run: pipx install poetry
+      - name: Install hatch
+        run: pipx install hatch
 
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'poetry'
+          cache: 'pip'
 
-      - name: "Install Packages"
-        run: poetry install
+      - name: "Install Environment"
+        run: hatch env create
 
       - name: "Test Codebase"
-        run: poetry run pytest --cov --cov-config=pyproject.toml --cov-report=xml
+        run: hatch run tests

.pre-commit-config.yaml

@@ -40,3 +40,8 @@ repos:
       - id: codespell
         additional_dependencies:
           - tomli
+  - repo: https://github.com/regebro/pyroma
+    rev: "4.2"
+    hooks:
+      - id: pyroma
+        args: ["-d", "--min=10", "."]

CHANGES.md

@@ -0,0 +1,10 @@
+# Changelog
+
+<!--
+   You should *NOT* be adding new change log entries to this file.
+   You should create a file in the news directory instead.
+   For helpful instructions, please see:
+   https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
+-->
+
+<!-- towncrier release notes start -->

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Plone Foundation <board@plone.org>
+
+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.

Makefile

@@ -42,41 +42,29 @@ all: help
 help: ## This help message
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
+.PHONY: clean
+clean: ## Clean up the environment
+	@echo "🚀 Cleanup the current environment"
+	@rm -rf .pytest_cache .ruff_cache .coverage coverage.xml .tox .venv
+
 .PHONY: install
-install: ## Install the poetry environment and install the pre-commit hooks
-	@echo "🚀 Creating virtual environment using pyenv and poetry"
-	@poetry install
-	if [ -d $(GIT_FOLDER) ]; then poetry run pre-commit install; else echo "$(RED) Not installing pre-commit$(RESET)";fi
-	@poetry shell
+install: ## Install the default environment
+	@echo "🚀 Creating virtual environment using hatch"
+	@pipx install hatch
+	@hatch env create
+	if [ -d $(GIT_FOLDER) ]; then hatch run pre-commit install; else echo "$(RED) Not installing pre-commit$(RESET)";fi
 
 .PHONY: check
 check: ## Run code quality tools.
-	@echo "🚀 Checking Poetry lock file consistency with 'pyproject.toml': Running poetry lock --check"
-	@poetry lock --check
 	@echo "🚀 Linting code: Running pre-commit"
-	@poetry run pre-commit run -a
+	@hatch run check
 
 .PHONY: test
 test: ## Test the code with pytest
 	@echo "🚀 Testing code: Running pytest"
-	@poetry run pytest --cov --cov-config=pyproject.toml --cov-report=xml
-
-.PHONY: build
-build: clean-build ## Build wheel file using poetry
-	@echo "🚀 Creating wheel file"
-	@poetry build
-
-.PHONY: clean-build
-clean-build: ## clean build artifacts
-	@rm -rf dist
-
-.PHONY: publish
-publish: ## publish a release to pypi.
-	@echo "🚀 Publishing: Dry run."
-	@poetry config pypi-token.pypi $(PYPI_TOKEN)
-	@poetry publish --dry-run
-	@echo "🚀 Publishing."
-	@poetry publish
+	@hatch run test
 
-.PHONY: build-and-publish
-build-and-publish: build publish ## Build and publish.
+.PHONY: release
+release: ## Release the package to pypi.org
+	@echo "🚀 Release package"
+	@hatch run fullrelease

cookieplone/__init__.py

@@ -1 +1,4 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 __version__ = "0.4.1"

cookieplone/__main__.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 """Allow cookieplone to be executable through `python -m cookieplone`."""
 
 from cookieplone.cli import main

cookieplone/cli.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 """Main `cookieplone` CLI."""
 
 import os

cookieplone/data.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 from collections.abc import Callable
 from dataclasses import dataclass
 from pathlib import Path

cookieplone/exceptions.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 class CookieploneException(Exception):
     """Cookieplone base exception."""
 

cookieplone/filters/__init__.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 import os
 
 from cookiecutter.utils import simple_filter

cookieplone/generator.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 import json
 from collections import OrderedDict
 from pathlib import Path

cookieplone/repository.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 import json
 from pathlib import Path
 

cookieplone/settings.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 PLONE_MIN_VERSION = "6"
 
 SUPPORTED_PYTHON_VERSIONS = [

cookieplone/utils/__init__.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 from cookiecutter.utils import rmtree
 
 __all__ = ["rmtree"]

cookieplone/utils/commands/__init__.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 import re
 import subprocess
 import sys

cookieplone/utils/console.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 import os
 from textwrap import dedent
 

cookieplone/utils/containers.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 REGISTRIES = {"docker_hub": "", "github": "ghcr.io/", "gitlab": "registry.gitlab.com/"}
 
 

cookieplone/utils/files.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 from pathlib import Path
 
 from cookiecutter.utils import rmtree

cookieplone/utils/git.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 from pathlib import Path
 
 from git import Commit, Repo

cookieplone/utils/internal.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 import sys
 from datetime import datetime
 from pathlib import Path

cookieplone/utils/sanity.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 from cookieplone import data
 
 

cookieplone/utils/validators.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 import re
 from typing import Any
 from urllib.parse import urlparse

cookieplone/utils/versions.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Plone Foundation <board@plone.org>
+#
+# SPDX-License-Identifier: MIT
 import requests
 from packaging.version import Version
 

news/.changelog_template.jinja

@@ -0,0 +1,15 @@
+{% if sections[""] %}
+{% for category, val in definitions.items() if category in sections[""] %}
+
+### {{ definitions[category]['name'] }}
+
+{% for text, values in sections[""][category].items() %}
+- {{ text }} {{ values|join(', ') }}
+{% endfor %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+
+
+{% endif %}

news/9.internal

@@ -0,0 +1 @@
+Move from poetry to hatch to manage the environment [@ericof]