cappysan-dotfiles 0.0.31__tar.gz

cappysan_dotfiles-0.0.31/.answers.yml

@@ -0,0 +1,39 @@
+---
+# The following file enables recreating a templated output dir by executing:
+#   mk-scaffold clone "https://gitlab.com/cappysan/scaffolds/python-template" --input-file .answers.yml --output-dir output
+#
+
+answers:
+  # File generated with mk-scaffold:
+  #   cf. nitpick/scaffold-tpl-version-check.toml
+  template_used: "https://gitlab.com/cappysan/scaffolds/python-template"
+  template_version: "1.2.2"
+
+  author: "Julien Lecomte"
+  email: "julien@cappysan.dev"
+
+  project_name: "dotfile-scripts"
+  project_slug: "dotfile-scripts"
+  project_url: "https://gitlab.com/cappysan/dotfiles/dotfiles"
+  project_description: ""
+
+  package_name: "cappysan-dotfile-scripts"
+  executable_name: ""
+  is_app: False
+  is_lib: False
+
+  documentation_url: "https://gitlab.com/cappysan/dotfiles/dotfiles"
+  source_code_url: "https://gitlab.com/cappysan/dotfiles/dotfiles"
+  bug_tracker_url: "https://gitlab.com/cappysan/dotfiles/dotfiles/-/issues"
+  pypi_url: "https://pypi.org/project/cappysan-dotfiles"
+
+  python_min_version: "3.11"
+  has_pytest_plugin: False
+
+  license: "MIT"
+
+  version: "0.0.31"
+
+  # Hidden fields
+  creation_year: "2025"
+  last_update: "2025-11-16 13:56:05"

cappysan_dotfiles-0.0.31/.gitignore

@@ -0,0 +1,29 @@
+# SPDX-License-Identifier: MIT
+#
+### Project specifics ###
+
+### Generic ###
+/.env
+/.cache/
+/public/
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+/.pytest_cache/
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+/build/
+/dist/
+/*.egg-info/
+
+# Unit test / coverage reports
+*.py,cover
+/.coverage
+
+# Virtual env
+/.python-version
+/.tox/
+/.venv/

cappysan_dotfiles-0.0.31/.gitlab/ci/core.yml

@@ -0,0 +1,208 @@
+# SPDX-License-Identifier: MIT
+#
+---
+variables:
+  DEBIAN_FRONTEND: "noninteractive"
+
+  APTGET_INSTALL_FLAGS:
+    value: ""
+    description: "Flags to pass to apt-get"
+
+  # Used by jobs other than than just python.yml
+  # cf: https://gitlab.com/cappysan/images/container_registry/6574223
+  PYTHON_JOB_IMAGE_NAMESPACE:
+    value: "registry.gitlab.com/cappysan/images"
+    description: "Docker namespace to use for building environments for version matrix"
+  PYTHON_JOB_IMAGE:
+    value: "$PYTHON_JOB_IMAGE_NAMESPACE/python:3.11"
+    description: "Docker image to use for building environment"
+
+# ------------------------------------------------------------------------------
+# Reference parts
+# ------------------------------------------------------------------------------
+# The following section add functions to the bash executor of the image.
+#   * we disable PS4 (used by `set -x`)
+#   * we create functions to create collapsible timed sections
+#   * we create some coloring functions
+#
+# Collapsible sections:
+#   https://docs.gitlab.com/ee/ci/jobs/#custom-collapsible-sections
+#
+# Usage:
+#   - !reference [".core:functions", script]
+.core:functions:
+  script:
+    - |
+      # !reference [".core:functions", script]
+      set -e
+      set -o pipefail
+      export PS4=''
+      # Sections
+      section_start()    { echo -e "section_start:`date +%s`:${1}${3}\r\e[0K\e[34;1m${2}\e[0m"; }
+      section_start_c()  { section_start "$1" "$2" "[collapsed=true]"; }
+      section_start_nc() { section_start "$1" "$2" "[collapsed=false]"; }
+      section_end()      { echo -e "section_end:`date +%s`:${1}\r\e[0K"; }
+      # Titles are bluish like section starts
+      color_title()      { echo -e "\e[1;34m"${@}"\e[0m"; }
+      color_error()      { echo -e "\e[1;31m"${@}"\e[0m" >&2; }
+      color_warning()    { echo -e "\e[1;33m"${@}"\e[0m" >&2; }
+      #
+      color_command()    { echo -e "\e[1;32m"\$ ${@}"\e[0m" >&2; }
+
+
+# ------------------------------------------------------------------------------
+# .core:prolog
+# ------------------------------------------------------------------------------
+# Print debugging info, notably details that allow
+# to retrieve instance, project, pipeline and job
+# from the raw log files on the server.
+#
+# Of interest: https://docs.gitlab.com/ci/variables/predefined_variables/
+.core:prolog:
+  script:
+    - |
+      # !reference [".core:prolog", script]
+      section_start_c "core_prolog" "Core information"
+      cat <<_EOF >&2
+      Current:
+        time:           $(date -R)
+        server:         ${CI_SERVER_URL}
+        project:        ${CI_PROJECT_URL}
+        pipeline:       ${CI_PIPELINE_URL}
+        job:            ${CI_JOB_URL}
+        timeout:        ${CI_JOB_TIMEOUT}
+        pipeline start: ${CI_PIPELINE_CREATED_AT}
+        #
+        source:         ${CI_PIPELINE_SOURCE}
+        protected:      ${CI_COMMIT_REF_PROTECTED}
+        #
+        reference:      ${CI_COMMIT_REF_NAME}
+        sha:            ${CI_COMMIT_SHA}
+        tag name:       ${CI_COMMIT_TAG}
+        default branch: ${CI_DEFAULT_BRANCH}
+        #
+        server version: ${CI_SERVER_VERSION}
+        runner version: ${CI_RUNNER_VERSION}
+        runner id:      ${CI_RUNNER_ID}
+      _EOF
+      section_end "core_prolog"
+
+# ------------------------------------------------------------------------------
+# .core:defaults
+# ------------------------------------------------------------------------------
+# cf. https://docs.gitlab.com/ee/ci/yaml/#default
+.core:defaults:
+  image: alpine
+  needs: []
+  before_script:
+    - !reference [".core:functions", script]
+    - !reference [".core:prolog",    script]
+  rules:
+    - when: never
+
+# ------------------------------------------------------------------------------
+# .core:make
+# ------------------------------------------------------------------------------
+.core:make:
+  script:
+    - |
+      # !reference [".core:make", script]
+      color_command make ${MAKEFILE_TARGET}
+      make ${MAKEFILE_TARGET} ${MAKEFILE_FLAGS}
+
+# ------------------------------------------------------------------------------
+# .core:rules
+# ------------------------------------------------------------------------------
+.core:rules:if:
+  # !reference [".core:rules:if", is_tag]
+  is_tag:
+    - if: $CI_COMMIT_TAG != null
+      when: on_success
+
+  # !reference [".core:rules:if", is_merge_request]
+  is_merge_request:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: on_success
+
+  # !reference [".core:rules:if", if_not_merge_request]
+  if_not_merge_request:
+    - if: $CI_PIPELINE_SOURCE != "merge_request_event"
+      when: on_success
+
+  # !reference [".core:rules:if", is_default_branch]
+  is_default_branch:
+    # Reference (branch/tag) must be protected, and this must not be a merge request
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      when: on_success
+
+  # !reference [".core:rules:if", is_not_default_branch]
+  is_not_default_branch:
+    # Reference (branch/tag) must be protected, and this must not be a merge request
+    - if: $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
+      when: on_success
+
+  # !reference [".core:rules:if", if_protected]
+  if_protected:
+    - if: $CI_COMMIT_REF_PROTECTED == "true"
+      when: on_success
+
+  # !reference [".core:rules:if", if_protected]
+  if_not_protected:
+    - if: $CI_COMMIT_REF_PROTECTED != "true"
+      when: on_success
+
+.core:rules:not_if:
+  # !reference [".core:rules:not_if", pages_are_inactive]
+  pages_are_inactive:
+    - if: $CI_PAGES_URL == null
+      when: never
+
+  # !reference [".core:rules:not_if", is_tag]
+  is_tag:
+    - if: $CI_COMMIT_TAG != null
+      when: never
+
+  # !reference [".core:rules:not_if", is_not_tag]
+  is_not_tag:
+    - if: $CI_COMMIT_TAG == null
+      when: never
+
+  # !reference [".core:rules:not_if", is_merge_request]
+  is_merge_request:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: never
+
+  # !reference [".core:rules:not_if", is_not_merge_request]
+  is_not_merge_request:
+    - if: $CI_PIPELINE_SOURCE != "merge_request_event"
+      when: never
+
+  # !reference [".core:rules:if", is_protected]
+  is_protected:
+    - if: $CI_COMMIT_REF_PROTECTED == "true"
+      when: never
+
+  # !reference [".core:rules:not_if", not_if_protected]
+  not_if_protected:
+    - if: $CI_COMMIT_REF_PROTECTED != "true"
+      when: never
+
+  # !reference [".core:rules:not_if", is_default_branch]
+  is_default_branch:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      when: never
+
+  # !reference [".core:rules:not_if", is_not_default_branch]
+  is_not_default_branch:
+    - if: $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
+      when: never
+
+  # !reference [".core:rules:not_if", is_protected]
+  is_protected:
+    - if: $CI_COMMIT_REF_PROTECTED == "true"
+      when: never
+
+  # !reference [".core:rules:not_if", is_not_protected]
+  is_not_protected:
+    - if: $CI_COMMIT_REF_PROTECTED != "true"
+      when: never

cappysan_dotfiles-0.0.31/.gitlab/ci/pages.yml

@@ -0,0 +1,62 @@
+# SPDX-License-Identifier: MIT
+#
+---
+variables:
+  PUBLISH_PAGES:
+    value: ""
+    description: "Set to 'true' to force publish the generated pages. Can be set to 'false', or to a branch name"
+
+# ------------------------------------------------------------------------------
+# .pages:user
+# ------------------------------------------------------------------------------
+.pages:user:pre:
+  before_script:
+    - /bin/true
+
+.pages:user:post:
+  before_script:
+    - /bin/true
+
+.pages:defaults:
+  extends: .core:defaults
+  image: "$PYTHON_JOB_IMAGE"
+  stage: deploy
+  inherit:
+    default: false
+  artifacts:
+    paths:
+      - public/
+  before_script:
+    - !reference [".core:defaults", before_script]
+    - !reference [".pages:user:pre", before_script]
+    - (mkdir -p public && touch public/.placeholder) 2>/dev/null || true
+    - !reference [".pages:user:post", before_script]
+  script:
+    - mv -vf public/sphinx/html/*  public/
+    - mv -vf public/sphinx/html/.* public/ || true
+  rules:
+    - !reference [".core:rules:not_if", pages_are_inactive]
+    - !reference [".core:rules:not_if", is_merge_request]
+
+
+# ------------------------------------------------------------------------------
+# .pages
+# ------------------------------------------------------------------------------
+.pages:
+  extends: .pages:defaults
+  inherit:
+    default: false
+  rules:
+    # We need defaults, and for pages this could be the default branch, or on tags.
+    # For this reason, use same rules than for .python:package:upload, but add
+    # an overwrite switch
+    - !reference [".pages:defaults", rules]
+    - if: $PUBLISH_PAGES == "true"
+      when: on_success
+    - if: $PUBLISH_PAGES == "false"
+      when: never
+    - if: $PUBLISH_PAGES == $CI_COMMIT_BRANCH
+      when: on_success
+    - !reference [".core:rules:not_if", is_merge_request]
+    - !reference [".core:rules:not_if", is_not_protected]
+    - !reference [".core:rules:not_if", is_not_tag]

cappysan_dotfiles-0.0.31/.gitlab/ci/pre-commit.yml

@@ -0,0 +1,111 @@
+# SPDX-License-Identifier: MIT
+#
+---
+variables:
+  PRECOMMITSKIP:
+    value: ""
+    description: "pre-commit jobs to skip"
+  PRECOMMITFLAGS:
+    value: ""
+    description: "pre-commit additional flags"
+
+
+# ------------------------------------------------------------------------------
+# .pre-commit:user
+# ------------------------------------------------------------------------------
+.pre-commit:user:pre:
+  before_script:
+    - /bin/true
+
+.pre-commit:user:post:
+  before_script:
+    - /bin/true
+
+
+# ------------------------------------------------------------------------------
+# .pre-commit:prepare
+# ------------------------------------------------------------------------------
+.pre-commit:defaults:prepare:
+  before_script:
+    # Some precommit hooks, such as for ansible, will complain that it's in a world
+    # writable directory
+    - chmod 755 .
+    - |
+      # Install pipx if missing
+      if ! builtin type -P "pipx" &>/dev/null; then
+         apt-get update
+         apt-get install -yq --no-install-recommends pipx
+      fi
+    - PIPX_BIN_DIR=/usr/local/bin pipx install pre-commit
+
+
+# ------------------------------------------------------------------------------
+# .pre-commit:defaults
+# ------------------------------------------------------------------------------
+.pre-commit:defaults:
+  extends: .core:defaults
+  image: "$PYTHON_JOB_IMAGE"
+  stage: lint
+  inherit:
+    default: false
+  before_script:
+    - !reference [".core:defaults", before_script]
+    - !reference [".pre-commit:user:pre", before_script]
+    - !reference [".pre-commit:defaults:prepare", before_script]
+    - !reference [".pre-commit:user:post", before_script]
+
+
+# ------------------------------------------------------------------------------
+# .pre-commit
+# ------------------------------------------------------------------------------
+# Runs pre-commit configured tools.
+#
+# This job has value in a merge request, in order to prevent it from being
+# merged.
+.pre-commit:
+  extends: .pre-commit:defaults
+  variables:
+    PRE_COMMIT_HOME: "$CI_PROJECT_DIR/.cache/pre-commit"
+  cache:
+    - key: ${CI_COMMIT_BRANCH}-pre-commit
+      paths:
+        - .cache
+  script:
+    - SKIP="${PRECOMMITSKIP} ${SKIP}" pre-commit run -a ${PRECOMMITFLAGS}
+  rules:
+    # On a merge request, user is expected to fix the error before merging
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      allow_failure: false
+      when: on_success
+
+    # Allow failure when there's no action that can be taken to fix the pipeline.
+    - when: on_success
+      allow_failure: true
+
+
+# ------------------------------------------------------------------------------
+# .pre-commit:autoupdate
+# ------------------------------------------------------------------------------
+# Verify that pre-commit is up-to-date.
+#
+# This job has value in a merge request, in order to prevent it from being
+# merged.
+.pre-commit:autoupdate:
+  extends: .pre-commit:defaults
+  script:
+    - pre-commit autoupdate
+    - |
+      #
+      if test -n "$(git status --porcelain)"; then
+        color_error "error: .pre-commit-config.yaml is not up-to-date"
+        exit 13
+      fi
+  rules:
+    # On a merge request, user is expected to fix the error before merging
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      allow_failure: false
+      when: on_success
+
+    # Allow failure when there's no action that can be taken to fix the pipeline.
+    - when: on_success
+      allow_failure: true