qm-template 0.1.0__tar.gz

qm_template-0.1.0/.copier-answers.yml

@@ -0,0 +1,23 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v0.1.0-7-gb2e1a57
+_src_path: .
+author_email: git@ak1ra.xyz
+author_name: ak1ra
+copyright_date: '2026'
+copyright_holder: ak1ra
+copyright_license: MIT
+default_branch: master
+docs_hosting: github-pages
+docs_site_url: https://ak1ra-lab.github.io/qm-template/
+project_description: Proxmox VE template helper scripts
+project_kind: cli
+project_name: qm-template
+python_min_version: '3.11'
+python_package_command_line_name: qm-template
+python_package_distribution_name: qm-template
+python_package_import_name: qm_template
+repository_name: qm-template
+repository_namespace: ak1ra-lab
+repository_provider_kind: github
+requires_python: '>=3.11'
+with_ansible: false

qm_template-0.1.0/.dockerignore

@@ -0,0 +1,8 @@
+.git
+.venv
+.pytest_cache
+.ruff_cache
+__pycache__
+dist
+site
+htmlcov

qm_template-0.1.0/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[*.md]
+indent_size = 2
+trim_trailing_whitespace = false

qm_template-0.1.0/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7

qm_template-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,57 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+
+      - name: Install the project
+        run: uv sync --locked --group dev
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --all-files
+
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --locked --group dev
+
+      - name: Run tests
+        run: uv run pytest -v tests/

qm_template-0.1.0/.github/workflows/docs.yaml

@@ -0,0 +1,61 @@
+---
+name: docs
+
+on:
+  workflow_dispatch: ~
+  push:
+    branches:
+      - master
+    paths:
+      - "src/**"
+      - "docs/**"
+      - "README.md"
+      - "mkdocs.yaml"
+      - "pyproject.toml"
+      - "uv.lock"
+      - ".github/workflows/docs.yaml"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: docs
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+
+      - name: Install the project
+        run: uv sync --locked --group docs
+
+      - name: Build documentation
+        run: NO_MKDOCS_2_WARNING=1 uv run mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1

qm_template-0.1.0/.github/workflows/publish-to-pypi.yaml

@@ -0,0 +1,46 @@
+---
+name: publish-to-pypi
+
+on:
+  workflow_dispatch: ~
+  push:
+    tags:
+      - "v*"
+
+permissions: {}
+
+jobs:
+  build-n-push:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/qm-template/
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        with:
+          enable-cache: false
+
+      - name: Install the project
+        run: uv sync --locked --group dev
+
+      - name: Run tests
+        run: uv run pytest -v tests/
+
+      - name: Build a binary wheel and a source tarball
+        run: uv build -v
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

qm_template-0.1.0/.gitignore

@@ -0,0 +1,354 @@
+# https://github.com/github/gitignore/blob/main/Global/Archives.gitignore
+# It's better to unpack these files and commit the raw source because
+# git has its own built in compression methods.
+*.7z
+*.jar
+*.rar
+*.zip
+*.gz
+*.gzip
+*.tgz
+*.bzip
+*.bzip2
+*.bz2
+*.xz
+*.lzma
+*.cab
+*.xar
+*.zst
+*.tzst
+
+# Packing-only formats
+*.iso
+*.tar
+
+# Package management formats
+*.dmg
+*.xpi
+*.gem
+*.egg
+*.deb
+*.rpm
+*.msi
+*.msm
+*.msp
+*.txz
+
+# https://github.com/github/gitignore/blob/main/Global/Linux.gitignore
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# Metadata left by Dolphin file manager, which comes with KDE Plasma
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# Log files created by default by the nohup command
+nohup.out
+
+# https://github.com/github/gitignore/blob/main/Global/macOS.gitignore
+# General
+.DS_Store
+__MACOSX/
+.AppleDouble
+.LSOverride
+Icon\[
+]
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# https://github.com/github/gitignore/blob/main/Global/Windows.gitignore
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+*.exe
+
+# Windows shortcuts
+*.lnk
+
+# https://github.com/github/gitignore/blob/main/Python.gitignore
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Ansible
+.ansible/*
+inventory/*.yaml
+playbooks/host_vars/**/*.yaml
+playbooks/group_vars/**/*.yaml
+playbooks/host_vars/**/*.patch
+playbooks/group_vars/**/*.patch
+
+# Ansible runtime scripts and templates
+playbooks/scripts/*
+playbooks/templates/*
+
+# 示例 Ansible inventory
+!inventory/hosts.example.yaml
+
+# General configuration file and examples folder
+config/*
+credentials/
+credentials.yaml
+examples/*
+
+## LLM
+.agents/sessions/*
+
+# Local qm-template configuration (keep the example file)
+qm-template.*.toml
+!qm-template.example.toml

qm_template-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+---
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+#
+# Run `uv run pre-commit autoupdate` after init to bump hook revisions.
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.7
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.12.13
+    hooks:
+      - id: uv-lock
+
+  - repo: local
+    hooks:
+      - id: ty
+        name: ty
+        entry: uv run ty check
+        language: system
+        files: ^src/
+        types_or: [python, pyi]
+        require_serial: true

qm_template-0.1.0/AGENTS.md

@@ -0,0 +1,53 @@
+# AGENTS.md
+
+`qm-template` is a Python CLI that downloads distro cloud images and creates
+Proxmox VE VM templates. It targets a Proxmox VE host and is normally run as
+root. Application code lives under `src/qm_template`.
+
+`download` shells out to `axel`/`aria2c`/`wget`/`curl`; `create` shells out to
+Proxmox VE (`qm`, `pvesm`). Neither must be exercised in tests - tests mock or
+only cover pure logic.
+
+## Tooling
+
+`just <recipe>` is a thin wrapper around `uv run ...` (see `justfile`); calling
+`uv run ...` directly is equivalent.
+
+- Env/deps: **uv** (`just sync` = `uv sync --group dev`). Never
+  `pip`/`poetry`/`pipenv`.
+- Lint+format: **ruff** (`just lint` = `uv run ruff check --fix` then
+  `uv run ruff format`, over `src/ tests/`). Never `black`/`isort`/`flake8`.
+- Typecheck: **ty**, `src/` only (`just typecheck` = `uv run ty check src/`).
+  Never `mypy`.
+- Tests: **pytest** (`just test` = `uv run pytest -v tests/`). Extra args go
+  *before* `tests/`, e.g. `just test -k <pattern>`.
+- Docs: `just docs-build` and `just docs-serve` (mkdocs-material).
+- Build: `just build` = `uv build`.
+- Pre-commit: `uv run pre-commit run --all-files` is the final gate before
+  committing.
+
+Python changes MUST pass ruff, ty, and pytest, then pre-commit.
+
+## Versioning
+
+Version is dynamic via `hatch-vcs` (Git tags). DO NOT bump version strings
+manually; push a tag starting with `v` (e.g. `v0.1.0`) and CI publishes to
+PyPI.
+
+## Conventions
+
+- CLI: `argparse` with `download`, `create` and `distros` subcommands;
+  entrypoint `qm-template`. Runtime dependencies stay empty (standard library
+  only).
+- Defaults: config `/etc/qm-template/config.toml`, images
+  `/var/lib/qm-template`, mirroring the upstream layout
+  (`<distro>/<release>/[<tag>/]<filename>`). Dated builds are pinned where the
+  upstream provides them.
+- Tests live under `tests/` and track public behavior, especially the CLI.
+- `pyproject.toml` is the single source of truth for dependencies and metadata.
+
+## Docs (bilingual)
+
+`docs/` is served by mkdocs-static-i18n (`docs_structure: suffix`): every page
+has an English `*.md` and a Simplified-Chinese `*.zh.md` sibling. Update BOTH
+language files when changing user-facing behavior.