worker-{{cookiecutter.slug}}/.gitlab-ci.yml

@@ -109,6 +109,7 @@ bump-python-deps:
 
 publish-worker:
   stage: release
+  allow_failure: true
   image: registry.gitlab.teklia.com/arkindex/cli:latest
 
   script:

worker-{{cookiecutter.slug}}/.pre-commit-config.yaml

 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.0.278
+    rev: v0.1.7
     hooks:
+      # Run the linter.
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.11.0
-    hooks:
-    - id: black
+      # Run the formatter.
+      - id: ruff-format
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-ast
       - id: check-docstring-first
@@ -25,9 +24,10 @@ repos:
       - id: name-tests-test
         args: ['--django']
       - id: check-json
+      - id: check-toml
       - id: requirements-txt-fixer
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.2
+    rev: v2.2.6
     hooks:
       - id: codespell
         args: ['--write-changes']

worker-{{cookiecutter.slug}}/Dockerfile

@@ -7,12 +7,12 @@ ENV DEBIAN_FRONTEND=non-interactive
 RUN apt-get update -q -y && apt-get install -q -y --no-install-recommends curl
 
 # Install worker as a package
-COPY worker_{{cookiecutter.slug}} worker_{{cookiecutter.slug}}
-COPY requirements.txt setup.py VERSION ./
+COPY worker_{{cookiecutter.__module}} worker_{{cookiecutter.__module}}
+COPY requirements.txt setup.py pyproject.toml ./
 RUN pip install . --no-cache-dir
 
 # Add archi local CA
 RUN curl https://assets.teklia.com/teklia_dev_ca.pem > /usr/local/share/ca-certificates/arkindex-dev.crt && update-ca-certificates
 ENV REQUESTS_CA_BUNDLE /etc/ssl/certs/ca-certificates.crt
 
-CMD ["worker-{{ cookiecutter.slug }}"]
+CMD ["worker-{{ cookiecutter.__package }}"]

worker-{{cookiecutter.slug}}/MANIFEST.in

 include requirements.txt
-include VERSION

worker-{{cookiecutter.slug}}/Makefile

 .PHONY: release
 
 release:
-	$(eval version:=$(shell cat VERSION))
+	# Grep the version from pyproject.toml, squeeze multiple spaces, delete double and single quotes, get 3rd val.
+	# This command tolerates multiple whitespace sequences around the version number.
+	$(eval version:=$(shell grep -m 1 version pyproject.toml | tr -s ' ' | tr -d '"' | tr -d "'" | cut -d' ' -f3))
 	echo Releasing version $(version)
-	git commit VERSION -m "Version $(version)"
+	git commit pyproject.toml -m "Version $(version)"
 	git tag $(version)
 	git push origin master $(version)

worker-{{cookiecutter.slug}}/README.md

-# {{ cookiecutter.slug }}
+# {{ cookiecutter.name }}
 
 {{ cookiecutter.description }}
 

worker-{{cookiecutter.slug}}/VERSION

-0.1.0

worker-{{cookiecutter.slug}}/pyproject.toml

+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "worker_{{ cookiecutter.__module }}"
+version = "0.1.0"
+description = "{{ cookiecutter.description }}"
+dynamic = ["dependencies"]
+authors = [
+    { name = "{{ cookiecutter.author }}", email = "{{ cookiecutter.email }}" },
+]
+maintainers = [
+    { name = "{{ cookiecutter.author }}", email = "{{ cookiecutter.email }}" },
+]
+requires-python = ">=3.10"
+readme = { file = "README.md", content-type = "text/markdown" }
+keywords = ["python"]
+classifiers = [
+    # Specify the Python versions you support here.
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+
+[project.scripts]
+worker-{{ cookiecutter.__package }} = "worker_{{ cookiecutter.__module }}.worker:main"
+
+[tool.setuptools.dynamic]
+dependencies = { file = ["requirements.txt"] }
+
 [tool.ruff]
 exclude = [".git", "__pycache__"]
 ignore = ["E501"]
-select = ["E", "F", "T1", "W", "I"]
+select = [
+    # pycodestyle
+    "E",
+    "W",
+    # Pyflakes
+    "F",
+    # Flake8 Debugger
+    "T1",
+    # Isort
+    "I",
+    # Implicit Optional
+    "RUF013",
+    # Invalid pyproject.toml
+    "RUF200",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # flake8-pytest-style
+    "PT",
+    # flake8-use-pathlib
+    "PTH",
+]
+
+[tool.ruff.per-file-ignores]
+# Ignore `pytest-composite-assertion` rules of `flake8-pytest-style` linter for non-test files
+"worker_{{ cookiecutter.__module }}/**/*.py" = ["PT018"]
 
 [tool.ruff.isort]
 known-first-party = ["arkindex", "arkindex_worker"]

worker-{{cookiecutter.slug}}/setup.py

 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-import re
-from pathlib import Path
-from typing import List
-
 from setuptools import find_packages, setup
 
-MODULE = "worker_{{cookiecutter.slug}}"
-COMMAND = "worker-{{cookiecutter.slug}}"
-
-SUBMODULE_PATTERN = re.compile("-e ((?:(?!#egg=).)*)(?:#egg=)?(.*)")
-
-
-def parse_requirements_line(line: str) -> str:
-    # Special case for git requirements
-    if line.startswith("git+http"):
-        assert "@" in line, "Branch should be specified with suffix (ex: @master)"
-        assert (
-            "#egg=" in line
-        ), "Package name should be specified with suffix (ex: #egg=kraken)"
-        package_name: str = line.split("#egg=")[-1]
-        return f"{package_name} @ {line}"
-    # Special case for submodule requirements
-    elif line.startswith("-e"):
-        package_path, package_name = SUBMODULE_PATTERN.match(line).groups()
-        package_path: Path = Path(package_path).resolve()
-        # Package name is optional: use folder name by default
-        return f"{package_name or package_path.name} @ file://{package_path}"
-    else:
-        return line
-
-
-def parse_requirements() -> List[str]:
-    path = Path(__file__).parent.resolve() / "requirements.txt"
-    assert path.exists(), f"Missing requirements: {path}"
-    return list(
-        map(parse_requirements_line, map(str.strip, path.read_text().splitlines()))
-    )
-
-
-setup(
-    name=MODULE,
-    version=open("VERSION").read(),
-    description="{{ cookiecutter.description }}",
-    author="{{ cookiecutter.author }}",
-    author_email="{{ cookiecutter.email }}",
-    install_requires=parse_requirements(),
-    entry_points={"console_scripts": [f"{COMMAND}={MODULE}.worker:main"]},
-    packages=find_packages(),
-    python_requires=">=3.10",
-)
+setup(packages=find_packages())

worker-{{cookiecutter.slug}}/tests/conftest.py

-# -*- coding: utf-8 -*-
 import os
 
 import pytest
@@ -8,7 +7,7 @@ from arkindex_worker.worker.base import BaseWorker
 
 
 @pytest.fixture(autouse=True)
-def setup_environment(responses, monkeypatch) -> None:
+def _setup_environment(responses, monkeypatch) -> None:
     """Setup needed environment variables"""
 
     # Allow accessing remote API schemas

worker-{{cookiecutter.slug}}/tests/test_worker.py

-# -*- coding: utf-8 -*-
 import importlib
 
 
@@ -8,6 +7,6 @@ def test_dummy():
 
 def test_import():
     """Import our newly created module, through importlib to avoid parsing issues"""
-    worker = importlib.import_module("worker_{{ cookiecutter.slug }}.worker")
+    worker = importlib.import_module("worker_{{ cookiecutter.__module }}.worker")
     assert hasattr(worker, "Demo")
     assert hasattr(worker.Demo, "process_element")

worker-{{cookiecutter.slug}}/tox.ini

 [tox]
-envlist = worker-{{ cookiecutter.slug }}
+envlist = worker-{{ cookiecutter.__package }}
 
 [testenv]
 passenv = ARKINDEX_API_SCHEMA_URL

worker-{{cookiecutter.slug}}/worker_{{cookiecutter.slug}}/__init__.py → worker-{{cookiecutter.slug}}/worker_{{cookiecutter.__module}}/__init__.py

-# -*- coding: utf-8 -*-
 import logging
 
 logging.basicConfig(

worker-{{cookiecutter.slug}}/worker_{{cookiecutter.slug}}/worker.py → worker-{{cookiecutter.slug}}/worker_{{cookiecutter.__module}}/worker.py

-# -*- coding: utf-8 -*-
 from logging import Logger, getLogger
 
 from arkindex_worker.models import Element