chore: project setup with pre-commit settings, .gitignore and renovate config

Author: tmeckel

.envrc

@@ -0,0 +1,69 @@
+# code: language=shellscript insertSpaces=true tabSize=2
+# shellcheck disable=SC2148
+
+dotenv_if_exists
+
+if test -z "${PYTHON_VERSION:-}" && test -f "${PWD}/.python-version"; then
+  PYTHON_VERSION=$(head -n 1 "${PWD}/.python-version")
+fi
+
+if test -z "${PYTHON_VERSION:-}"; then
+  PYTHON_VERSION=$(semver_search /usr/lib python 3)
+fi
+
+if test -z  "${PYTHON_VERSION:-}"; then
+  echo "-> No Python version found. Please create a .python-version file or set PYTHON_VERSION in your environment." >&2
+  exit 1
+fi
+
+export VIRTUAL_ENV="${PWD}/.venv"
+layout python "python${PYTHON_VERSION}"
+
+echo '*' > "${PWD}/.venv/.gitignore"
+
+if ! test -f "${PWD}/.venv/.pip-updated"; then
+  pip install --upgrade pip
+  touch "${PWD}/.venv/.pip-updated"
+fi
+
+if test -z "${PYTHON_NO_INSTALL_REQUIREMENTS:-}"; then
+  all_req_files=("${PWD}"/requirements*.txt)
+  if [[ ${#all_req_files[@]} -gt 0 ]]; then
+
+    install_needed=0
+
+    for req_file in "${all_req_files[@]}"; do
+      watch_file "$req_file"
+
+      venv_file="${PWD}/.venv/.$(basename "$req_file")"
+      if ! test -f "$venv_file" || test "$venv_file" -ot "$req_file"; then
+        install_needed=1
+      fi
+    done
+
+    if [[ "$install_needed" -eq 1 ]]; then
+      pip_install_args=()
+      for req_file in "${all_req_files[@]}"; do
+          pip_install_args+=("-r" "$req_file")
+      done
+
+      if pip install -U "${pip_install_args[@]}"; then
+        for req_file in "${all_req_files[@]}"; do
+          venv_file="${PWD}/.venv/.$(basename "$req_file")"
+          touch "$venv_file"
+        done
+      else
+        echo "-> pip install command failed. Tracking files remain untouched." >&2
+        exit 1
+      fi
+    fi
+  fi
+fi
+
+if  test -f "${PWD}/.pre-commit-config.yaml" && ! test -f "${PWD}/.venv/.pre-commit-installed"; then
+  if test -z "$(pip list 2>/dev/null | grep -oE 'pre[-_]commit')"; then
+    pip install pre-commit
+  fi
+  pre-commit install
+  touch "${PWD}/.venv/.pre-commit-installed"
+fi

.gitignore

@@ -0,0 +1,4 @@
+**/.env*
+!.envrc
+**/.venv
+**/venv

.markdownlint.yaml

@@ -0,0 +1,2 @@
+---
+MD013: false

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: fix-byte-order-marker
+      - id: check-case-conflict
+      - id: check-json
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: check-merge-conflict
+
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.29.0
+    hooks:
+      - id: yamllint
+
+  - repo: https://github.com/hadolint/hadolint
+    rev: v2.12.0
+    hooks:
+    - id: hadolint-docker
+      files: ^Dockerfile
+
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.13.0
+    hooks:
+    - id: markdownlint-cli2-docker
+
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.1
+    hooks:
+    - id: actionlint-docker
+
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.31.0
+    hooks:
+    - id: typos

.python-version

@@ -0,0 +1 @@
+3.10

.typos.toml

@@ -0,0 +1,32 @@
+# For more information on how to configure typos, see:
+# - https://github.com/crate-ci/typos/blob/master/docs/reference.md
+# - https://github.com/crate-ci/typos/blob/master/README.md#false-positives
+
+[files]
+# By default, typos will not check files that are ignored by git.
+# You can override this behavior here.
+# For example, to check all files, you would set:
+# ignore-vcs = false
+extend-exclude = [
+  "**/.envrc",
+]
+
+[default]
+# This section contains the default configuration for all file types.
+# You can override these settings for specific file types below.
+
+# A list of words that should be considered correct.
+# This is useful for words that are specific to your project.
+# For example:
+# extend-words = {
+#   "myawesomeword" = "myawesomeword",
+#   "another" = "another",
+# }
+
+# A list of regular expressions that should be ignored.
+# This is useful for things like URLs, or other patterns that
+# are not words.
+# For example, to ignore all URLs:
+# extend-ignore-re = [
+#   "https?://[^`\\s]+",
+# ]

.yamllint

@@ -0,0 +1,3 @@
+---
+rules:
+  line-length: disable

renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}