task2md 1.1.2__tar.gz → 1.2.0__tar.gz

{task2md-1.1.2 → task2md-1.2.0}/.gitignore

@@ -4,6 +4,7 @@ __pycache__/
 .coverage
 build/
 dist/
+public/
 reports/
 wheels/
 *.egg-info
@@ -13,6 +14,8 @@ wheels/
 
 .DS_Store
 /.*cache/
-/.devcontainer/
+/.claude/
+/docs/superpowers/
 /styles/
 /Taskfile.d/
+CLAUDE.md

task2md-1.2.0/.gitlab-ci.yml

@@ -0,0 +1,105 @@
+---
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule"
+    - if: $CI_PIPELINE_SOURCE == "web"
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - if: $CI_COMMIT_TAG
+    - if: $CI_COMMIT_BRANCH
+
+variables:
+  IMAGE_UV: ghcr.io/astral-sh/uv:python${PYTHON_VERSION}-trixie-slim
+  PYTHON_VERSION: "3.14"
+
+include:
+  - component: gitlab.com/op_so/components/core/lint@v2.0.1
+    inputs:
+      lint_vale: true
+      lint_markdown_glob: '"**/*.md" "#docs"'
+  - component: gitlab.com/op_so/components/python-uv/prepare-uv@v1.3.0
+    inputs:
+      prepare_uv_python_version: "3.14"
+  - component: gitlab.com/op_so/components/python-uv/lint-uv@v1.3.0
+    inputs:
+      lint_uv_python_version: "3.14"
+      lint_uv_isort: true
+      lint_uv_mypy: true
+      lint_uv_mypy_args: "--strict src/ tests/"
+      lint_uv_pyrefly: true
+  # Coverage is on by default and reads `[tool.coverage.run] source` from
+  # pyproject.toml, since the component passes `--cov` without an argument.
+  - component: gitlab.com/op_so/components/python-uv/test-uv@v1.3.0
+    inputs:
+      test_uv_python_version: "3.14"
+  - component: gitlab.com/op_so/components/core/semantic-release@v2.0.1
+  # Only runs on a scheduled pipeline setting RENOVATE=true, and needs a
+  # RENOVATE_TOKEN CI/CD variable.
+  - component: gitlab.com/op_so/components/core/renovate@v2.0.1
+  - component: gitlab.com/op_so/components/python-uv/publish-pypi-uv@v1.3.0
+    inputs:
+      publish_pypi_uv_python_version: "3.14"
+      publish_pypi_uv_stage: pypi-release
+
+stages:
+  - prepare-uv
+  - lint
+  - tests
+  - release
+  - pypi-release
+  - pages-release
+  - renovate
+
+.install-task: &install-task
+  - apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends curl ca-certificates
+  - sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
+
+# The cache block must stay identical to the one used by the python-uv
+# components: they share a single key and any divergence silently splits it.
+.abstract-uv:
+  image: $IMAGE_UV
+  needs: ["prepare-uv:sync"]
+  variables:
+    UV_CACHE_DIR: .uv-cache
+  cache:
+    key:
+      files:
+        - uv.lock
+      prefix: prepare-uv-${CI_DEFAULT_BRANCH}
+    paths:
+      - .uv-cache
+      - .venv
+    policy: pull
+  interruptible: true
+
+semantic-release:
+  before_script:
+    - npx semantic-release --dry-run --no-ci
+    - if [ -s .VERSION ]; then task 00:800-project-set-version VERSION=$(cat .VERSION); fi
+
+# The component runs `uv sync --frozen && uv build && uv publish` without
+# substituting the version: without this before_script it would publish 0.0.0.
+publish-pypi-uv:
+  before_script:
+    - *install-task
+    - task 00:800-project-set-version VERSION="${CI_COMMIT_TAG#v}"
+
+# Replaces the `pages` job formerly provided by the python.rye-publish template;
+# no python-uv component covers it.
+pages:
+  extends: .abstract-uv
+  stage: pages-release
+  before_script:
+    - *install-task
+    - uv sync --frozen
+    - task 00:800-project-set-version VERSION="${CI_COMMIT_TAG#v}"
+  script:
+    - uv run mkdocs build --site-dir public
+  artifacts:
+    paths:
+      - public
+  rules:
+    - if: $DISABLE_JOBS == "true"
+      when: never
+    - if: $CI_COMMIT_TAG

task2md-1.2.0/.gitleaks.toml

@@ -0,0 +1,4 @@
+title = "gitleaks config"
+
+[extend]
+useDefault = true

{task2md-1.1.2 → task2md-1.2.0}/.pre-commit-config.yaml

@@ -3,11 +3,7 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
-      - id: check-yaml
       - id: check-added-large-files
-      # Hooks added from sample-config
       - id: check-executables-have-shebangs
       - id: check-json
       - id: check-merge-conflict
@@ -15,9 +11,14 @@ repos:
       - id: check-symlinks
       - id: check-toml
       - id: check-xml
+      - id: check-yaml
       - id: detect-private-key
       - id: end-of-file-fixer
       - id: fix-byte-order-marker
       - id: mixed-line-ending
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.30.1
+    hooks:
+      - id: gitleaks

task2md-1.2.0/.python-version

@@ -0,0 +1 @@
+3.14

{task2md-1.1.2 → task2md-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: task2md
-Version: 1.1.2
+Version: 1.2.0
 Summary: A program to generate markdown documentation files from Task files
 Project-URL: Homepage, https://gitlab.com/op_so/task/task2md
 Project-URL: Documentation, https://op_so.gitlab.io/task/task2md/
@@ -10,18 +10,18 @@ License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.10
-Requires-Dist: click>=8.1.7
-Requires-Dist: pydantic>=2.6.3
-Requires-Dist: pyyaml>=6.0.1
-Requires-Dist: types-pyyaml>=6.0.12.12
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.14
+Requires-Dist: click>=8.4.2
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: pyyaml>=6.0.3
 Description-Content-Type: text/markdown
 
 # `task2md`
 
 [![Software License](https://img.shields.io/badge/license-MIT-informational.svg?style=for-the-badge)](LICENSE)
 [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release&style=for-the-badge)](https://github.com/semantic-release/semantic-release)
-[![Pipeline Status](https://gitlab.com/op_so/task/task2md/badges/main/pipeline.svg)](https://gitlab.com/op_so/task/task2md/pipelines)
+[![Pipeline Status](https://img.shields.io/gitlab/pipeline-status/op_so/task/task2md?style=for-the-badge)](https://gitlab.com/op_so/task/task2md/pipelines)
 
 [![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://op_so.gitlab.io/task/task2md/) Source code documentation
 
@@ -99,7 +99,7 @@ task2md file --input Taskfile.d/lint.yml -d doc_dir/
 
 To use:
 
-- Minimal Python version: 3.10
+- Minimal Python version: 3.14
 
 Installation with Python `pip`:
 

{task2md-1.1.2 → task2md-1.2.0}/README.md

@@ -2,7 +2,7 @@
 
 [![Software License](https://img.shields.io/badge/license-MIT-informational.svg?style=for-the-badge)](LICENSE)
 [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release&style=for-the-badge)](https://github.com/semantic-release/semantic-release)
-[![Pipeline Status](https://gitlab.com/op_so/task/task2md/badges/main/pipeline.svg)](https://gitlab.com/op_so/task/task2md/pipelines)
+[![Pipeline Status](https://img.shields.io/gitlab/pipeline-status/op_so/task/task2md?style=for-the-badge)](https://gitlab.com/op_so/task/task2md/pipelines)
 
 [![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://op_so.gitlab.io/task/task2md/) Source code documentation
 
@@ -80,7 +80,7 @@ task2md file --input Taskfile.d/lint.yml -d doc_dir/
 
 To use:
 
-- Minimal Python version: 3.10
+- Minimal Python version: 3.14
 
 Installation with Python `pip`:
 

task2md-1.2.0/Taskfile.project.yml

@@ -0,0 +1,108 @@
+---
+# https://taskfile.dev
+#
+# Taskfile.project.yml for your main project tasks. Must be commited.
+# If you always want the last version of the task templates, add the following line in your .gitignore file
+# /Taskfile.d/
+#
+version: '3'
+
+vars:
+  # TO MODIFY: Task templates to download separated by comma
+  # Example: TASK_TEMPLATES: go,lint,yarn
+  TASK_TEMPLATES: git,lint
+
+tasks:
+
+  00-get-list-templates:
+    # Get the list of templates to download
+    # Do not remove
+    cmds:
+      - echo "{{.TASK_TEMPLATES}}"
+    silent: true
+
+  050-upgrade-dependencies:
+    desc: "[PROJECT] Upgrade dependencies to the latest version."
+    cmds:
+      - uv sync --upgrade
+    silent: true
+
+  110-format:
+    desc: "[PROJECT] Python format with isort and Ruff."
+    cmds:
+      - uv run isort . --gitignore
+      - uv run ruff check --fix
+      - uv run ruff format
+    silent: true
+
+  120-lint:
+    desc: "[PROJECT] Python lint with Ruff."
+    cmds:
+      - uv run ruff check
+      - uv run ruff format --check
+    silent: true
+
+  130-type-check:
+    desc: "[PROJECT] Static typing for Python."
+    cmds:
+      - echo "mypy" && echo "===="
+      - uv run mypy --strict src/ tests/
+      - echo "" && echo "pyrefly" && echo "======="
+      - uv run pyrefly check --summarize-errors
+    silent: true
+
+  140-audit-deps:
+    desc: "[PROJECT] Audit Python dependencies for known CVEs (PyPA advisory DB)."
+    cmds:
+      - uv run --with pip-audit pip-audit --desc
+
+  220-run-tests:
+    desc: "[PROJECT] Run Pytest tests with coverage."
+    cmds:
+      - uv run pytest --cov --cov-report html:reports/cov --cov-report term
+    silent: true
+
+  300-doc-serve:
+    desc: "[PROJECT] Serve the mkdocs documentation site locally on port 8000."
+    cmds:
+      - uv run mkdocs serve
+    silent: true
+
+  800-project-set-version:
+    desc: "[PROJECT] Set version in different files. Arguments: VERSION|V=x.y.z"
+    vars:
+      PY_FILE_VERSION: src/task2md/task2md.py
+      MD_FILE_VERSION: docs/index.md
+      VERSION: '{{default .V .VERSION}}'
+    cmds:
+      - echo "Version {{.VERSION}}"
+      - sed -i.bu "s/0\.0\.0/{{.VERSION}}/g" pyproject.toml
+      - defer: rm -f pyproject.toml.bu
+      - sed -i.bu "s/0\.0\.0/{{.VERSION}}/g" {{.PY_FILE_VERSION}}
+      - defer: rm -f {{.PY_FILE_VERSION}}.bu
+      - sed -i.bu "s/0\.0\.0/{{.VERSION}}/g" {{.MD_FILE_VERSION}}
+      - defer: rm -f {{.MD_FILE_VERSION}}.bu
+    preconditions:
+      - sh: test -n "{{.VERSION}}"
+        msg: "VERSION|V argument is required"
+    silent: true
+
+  999-pre-commit:
+    desc: "[PROJECT] Pre-commit checks."
+    cmds:
+      - date > {{.FILE_TASK_START}}
+      - defer: rm -f {{.FILE_TASK_START}}
+      - task lint:pre-commit
+      - echo "" && echo "Markdown:" && echo "========="
+      - task lint:markdown GLOB='"**/*.md" "#.cache" "#.superpowers" "#.venv" "#docs" "#Taskfile.d" "#styles"'
+      - echo "" && echo "YAML:" && echo "====="
+      - task lint:yaml
+      - echo "" && echo "Lychee:" && echo "======="
+      - task lint:lychee
+      - echo "" && echo "Python:" && echo "======="
+      - task 00:120-lint
+      - task 00:130-type-check
+      - echo "" && echo "Tokei:" && echo "====="
+      - task lint:tokei
+      - echo "" && echo "Checks Start $(cat {{.FILE_TASK_START}}) - End $(date)"
+    silent: true

{task2md-1.1.2 → task2md-1.2.0}/Taskfile.yml

@@ -5,6 +5,8 @@
 #
 version: '3'
 
+dotenv: ['.env']
+
 vars:
   DIR_TASKFILES: Taskfile.d
   FILE_TASK_START: "task-start-{{.TASK}}.txt"
@@ -39,13 +41,13 @@ tasks:
       Requirements:
         - wget or curl
     vars:
-      PROXY: '{{default .P .PROXY}}'
-      D_PROXY: '{{default .TASK_PROXY .PROXY}}'
-      PROXY_CREDENTIALS: '{{default .PC .PROXY_CREDENTIALS}}'
+      PROXY: '{{.PROXY | default .P}}'
+      D_PROXY: '{{.PROXY | default .TASK_PROXY}}'
+      PROXY_CREDENTIALS: '{{.PROXY_CREDENTIALS | default .PC}}'
       TASK_TEMPLATES:
         sh: task 00:00-get-list-templates
-      FILE: '{{default .F .FILE}}'
-      D_FILE: '{{default "Taskfile.yml" .FILE}}'
+      FILE: '{{.FILE | default .F}}'
+      D_FILE: '{{.FILE | default "Taskfile.yml"}}'
       BEGIN: "    # BEGIN-INCLUDES-TEMPLATES"
       PATTERN_BEGIN: "^{{.BEGIN}}"
       END: "# END-INCLUDES-TEMPLATES"
@@ -92,18 +94,18 @@ tasks:
     silent: true
 
   usage:
-    desc: "[CORE] Show the usage of a task. Arguments: TSK|T=task-name [FILE|F=Taskfile.dist.yml] (*)"
+    desc: "[CORE] Show the usage of a task. Arguments: TSK|T=task-name [FILE|F=Taskfile.yml] (*)"
     summary: |
       [CORE] Show the usage of a task.
-      Usage: task [-t Taskfile.dist.yml] usage TSK|T=<task-name> [FILE|F=Taskfile.dist.yml]
+      Usage: task [-t Taskfile.yml] usage TSK|T=<task-name> [FILE|F=Taskfile.yml]
 
       Arguments:
        TSK | T  Name of the task (required)
        FILE | F Taskfile path (optional, by default Taskfile.yml)
     vars:
-      TSK: '{{default .T .TSK}}'
-      FILE: '{{default .F .FILE}}'
-      D_FILE: '{{default "Taskfile.yml" .FILE}}'
+      TSK: '{{.TSK | default .T}}'
+      FILE: '{{.FILE | default .F}}'
+      D_FILE: '{{.FILE | default "Taskfile.yml"}}'
     cmds:
       - |
         if [ ! -f "{{.D_FILE}}" ]; then
@@ -125,8 +127,8 @@ tasks:
       Arguments:
        FILE | F Taskfile project path (optional, by default Taskfile.project.yml)
     vars:
-      FILE: '{{default .F .FILE}}'
-      D_FILE: '{{default "Taskfile.project.yml" .FILE}}'
+      FILE: '{{.FILE | default .F}}'
+      D_FILE: '{{.FILE | default "Taskfile.project.yml"}}'
     cmds:
       - |
         if [ -d "{{.DIR_TASKFILES}}" ]; then

{task2md-1.1.2 → task2md-1.2.0}/docs/cli.md

@@ -4,7 +4,7 @@ This page provides documentation for the command line `task2md` application.
 
 ::: mkdocs-click
     :module: task2md.task2md
-    :command: dir
+    :command: dir_command
 
 ::: mkdocs-click
     :module: task2md.task2md

{task2md-1.1.2 → task2md-1.2.0}/docs/index.md

@@ -1,6 +1,6 @@
 # Overview
 
-Version: 1.1.2
+Version: 1.2.0
 
 A CLI tool to generate from [Task](https://taskfile.dev/) files, some markdown
 documentation files for [`mkdocs`](https://squidfunk.github.io/mkdocs-material/) static site.

{task2md-1.1.2 → task2md-1.2.0}/mkdocs.yml

@@ -8,6 +8,10 @@ plugins:
   - search
   - mkdocstrings
 
+# Design specs and implementation plans live under docs/ but must not be published.
+exclude_docs: |
+  superpowers/
+
 markdown_extensions:
   - mkdocs-click
 

task2md-1.2.0/pyproject.toml

@@ -0,0 +1,97 @@
+[project]
+name = "task2md"
+version = "1.2.0"
+description = "A program to generate markdown documentation files from Task files"
+authors = [
+    { name = "FX Soubirou", email = "soubirou@yahoo.fr" }
+]
+license = { text = "MIT" }
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.14",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "click>=8.4.2",
+    "pydantic>=2.13.4",
+    "PyYAML>=6.0.3",
+]
+requires-python = ">=3.14"
+
+[project.urls]
+Homepage = "https://gitlab.com/op_so/task/task2md"
+Documentation = "https://op_so.gitlab.io/task/task2md/"
+
+[project.scripts]
+task2md = "task2md.task2md:cli"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "isort>=8.0.1",
+    "mkdocs-click>=0.9.0",
+    "mkdocs-material>=9.7.7",
+    "mkdocstrings[python]>=1.0.6",
+    "mypy>=2.3.0",
+    "pyrefly>=1.1.1",
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+    "ruff>=0.16.0",
+    "types-PyYAML>=6.0.12.20260724",
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/task2md"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.coverage.run]
+source = ["src"]
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+mypy_path = "src"
+strict = true
+
+[tool.pyrefly]
+project-includes = ["src", "tests"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py314"
+line-length = 88
+
+[tool.ruff.lint]
+# E501 replaces the former flake8 `max-line-length = 88`: ruff does not enable
+# it by default, and `ruff format` alone does not wrap comments or long strings.
+extend-select = [
+    "A",    # flake8-builtins: shadowing a builtin
+    "ARG",  # flake8-unused-arguments
+    "B",    # flake8-bugbear
+    "C4",   # flake8-comprehensions
+    "E501", # line-too-long
+    "N",    # pep8-naming
+    "PL",   # pylint
+    "PTH",  # flake8-use-pathlib
+    "RET",  # flake8-return
+    "SIM",  # flake8-simplify
+    "W",    # pycodestyle warnings
+]
+
+[tool.ruff.lint.per-file-ignores]
+# Comparing against literals (exit_code == 2, len(...) == 4) is what an
+# assertion is; naming those values would obscure the tests, not clarify them.
+"tests/**" = ["PLR2004"]

task2md-1.2.0/renovate.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:recommended"],
+  "timezone": "Europe/Paris",
+  "labels": ["renovate"],
+  "semanticCommits": "enabled",
+  "dependencyDashboardOSVVulnerabilitySummary": "unresolved",
+  "pre-commit": {
+    "enabled": true
+  },
+  "packageRules": [
+    {
+      "description": "Auto-merge everything but majors",
+      "matchUpdateTypes": ["minor", "patch", "digest", "pin", "pinDigest"],
+      "automerge": true
+    },
+    {
+      "description": "Majors are reviewed by hand",
+      "matchUpdateTypes": ["major"],
+      "automerge": false
+    },
+    {
+      "description": "op_so components are released in lockstep: one MR for all",
+      "matchManagers": ["gitlabci"],
+      "groupName": "op_so components"
+    },
+    {
+      "description": "Dev tooling moves fast and never ships to users: one MR",
+      "matchDepTypes": ["dev"],
+      "groupName": "dev dependencies",
+      "semanticCommitType": "chore"
+    },
+    {
+      "description": "Runtime dependency bumps also raise the pyproject.toml lower bound, so they trigger a fix release instead of a silent lockfile-only chore",
+      "matchManagers": ["pep621"],
+      "matchDepTypes": ["project.dependencies"],
+      "rangeStrategy": "bump"
+    }
+  ],
+  "lockFileMaintenance": {
+    "enabled": true
+  }
+}