userdir-publish 0.0.1__tar.gz

userdir_publish-0.0.1/.cspell.json

@@ -0,0 +1,50 @@
+{
+  "enableFiletypes": [
+    "git-commit",
+    "github-actions-workflow",
+    "julia",
+    "jupyter"
+  ],
+  "flagWords": [
+    "analyse",
+    "colour",
+    "comparision",
+    "favour",
+    "flavour",
+    "hte",
+    "optimise",
+    "paramater",
+    "parmater",
+    "transision",
+    "transisions"
+  ],
+  "ignorePaths": [
+    "**/.cspell.json",
+    "*.svg",
+    ".editorconfig",
+    ".envrc",
+    ".github/dependabot.yml",
+    ".gitignore",
+    ".pre-commit-config.yaml",
+    ".prettierignore",
+    ".vscode/*",
+    "codecov.yml",
+    "docs/_templates/*",
+    "docs/conf.py",
+    "pyproject.toml"
+  ],
+  "ignoreWords": ["prereleased", "setgid", "toctree", "tombi", "typer", "ugoa"],
+  "language": "en-US",
+  "useGitignore": true,
+  "version": "0.2",
+  "words": [
+    "docstrings",
+    "jdoe",
+    "openrsync",
+    "PyPA",
+    "PyPI",
+    "pyproject",
+    "usefixtures",
+    "userdir"
+  ]
+}

userdir_publish-0.0.1/.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,toml}]
+indent_size = 4
+
+[LICENSE]
+indent_size = unset
+
+[uv.lock]
+indent_size = 4

userdir_publish-0.0.1/.envrc

@@ -0,0 +1,2 @@
+uv sync --all-extras --quiet
+source .venv/bin/activate

userdir_publish-0.0.1/.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+
+multi-ecosystem-groups:
+  lock:
+    assignees: [redeboer]
+    commit-message: { prefix: MAINT }
+    schedule: { interval: quarterly }
+
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    labels: [⬆️ Lock]
+    multi-ecosystem-group: lock
+    patterns: ["*"]
+  - package-ecosystem: pre-commit
+    directory: "/"
+    labels: [⬆️ Lock]
+    multi-ecosystem-group: lock
+    patterns: ["*"]

userdir_publish-0.0.1/.github/release-drafter.yml

@@ -0,0 +1,39 @@
+name-template: userdir-publish $NEXT_PATCH_VERSION
+tag-template: $NEXT_PATCH_VERSION
+
+references:
+  - main
+  - epic/*
+
+categories:
+  - title: ✨ New features
+    label: ✨ Feature
+  - title: ⚠️ Enhancements and optimizations
+    label: ⚙️ Enhancement
+  - title: ⚠️ API changes
+    label: ⚠️ Interface
+  - title: ⚠️ Changes that may affect behavior
+    label: ❗ Behavior
+  - title: 🐛 Bug fixes
+    label: 🐛 Bug
+  - title: 📝 Documentation
+    label: 📝 Docs
+  - title: 🔨 Maintenance
+    labels:
+      - 🔨 Maintenance
+      - ⬆️ Lock
+  - title: 🖱️ Developer Experience
+    label: 🖱️ DX
+
+change-template: "- $TITLE (#$NUMBER)"
+
+replacers:
+  - search: /([A-Z]+!?:\s*)(.*)/g
+    replace: $2
+
+sort-direction: ascending
+
+template: |
+  $CHANGES
+
+  _The full changelog as commits can be found [here](https://github.com/RUB-EP1/userdir-publish/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._

userdir_publish-0.0.1/.github/workflows/cd.yml

@@ -0,0 +1,33 @@
+name: CD
+
+on:
+  release:
+    types:
+      - prereleased
+      - released
+
+jobs:
+  milestone:
+    if: startsWith(github.ref, 'refs/tags')
+    uses: ComPWA/actions/.github/workflows/close-milestone.yml@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8
+  package-name:
+    uses: ComPWA/actions/.github/workflows/get-pypi-name.yml@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8
+  pypi:
+    environment:
+      name: PyPI
+      url: https://pypi.org/p/${{ needs.package-name.outputs.name }}
+    if: startsWith(github.ref, 'refs/tags')
+    name: Publish to PyPI
+    needs:
+      - package-name
+    permissions:
+      id-token: write
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: ComPWA/actions/build-pypi-distribution@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+  push:
+    if: startsWith(github.ref, 'refs/tags') && !github.event.release.prerelease
+    permissions:
+      contents: write
+    uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8

userdir_publish-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: |-
+    ${{ github.ref != format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+on:
+  push:
+    branches:
+      - main
+      - epic/*
+      - "[0-9]+.[0-9]+.x"
+  pull_request:
+    branches:
+      - main
+      - epic/*
+      - "[0-9]+.[0-9]+.x"
+  workflow_dispatch:
+
+jobs:
+  doc:
+    uses: ComPWA/actions/.github/workflows/ci-docs.yml@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8
+    permissions:
+      pages: write
+      id-token: write
+    with:
+      gh-pages: true
+  style:
+    secrets:
+      token: ${{ secrets.PAT }}
+    uses: ComPWA/actions/.github/workflows/style.yml@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8
+  test:
+    uses: ComPWA/actions/.github/workflows/test.yml@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8
+    with:
+      coverage-python-version: "3.14"
+      macos-python-version: "3.11"
+      multithreaded: false

userdir_publish-0.0.1/.github/workflows/clean-caches.yml

@@ -0,0 +1,22 @@
+name: Clean caches
+
+on:
+  pull_request:
+    types:
+      - closed
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: Clean caches for this branch name or ref
+        required: false
+        type: string
+
+jobs:
+  cleanup:
+    name: Remove caches
+    runs-on: ubuntu-slim
+    steps:
+      - uses: ComPWA/actions/clean-caches@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8
+        with:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ inputs.ref }}

userdir_publish-0.0.1/.github/workflows/lock.yml

@@ -0,0 +1,21 @@
+name: Update
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: |-
+    ${{ github.ref != format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+on:
+  pull_request:
+    branches:
+      - main
+      - epic/*
+    paths:
+      - .pre-commit-config.yaml
+  workflow_dispatch:
+
+jobs:
+  lock:
+    uses: ComPWA/actions/.github/workflows/lock.yml@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8
+    secrets:
+      token: ${{ secrets.PAT }}

userdir_publish-0.0.1/.github/workflows/pr-linting.yml

@@ -0,0 +1,14 @@
+name: PR linting
+on:
+  pull_request:
+    types:
+      - edited
+      - labeled
+      - opened
+      - reopened
+      - synchronize
+      - unlabeled
+
+jobs:
+  lint-pr:
+    uses: ComPWA/actions/.github/workflows/pr-linting.yml@826112415aa683bb2d73df87e84444a047f8cad7 # v4.1.8

userdir_publish-0.0.1/.github/workflows/release-drafter.yml

@@ -0,0 +1,16 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+      - epic/*
+  workflow_dispatch:
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-slim
+    steps:
+      - uses: release-drafter/release-drafter@978bb0b30c5ee8cdd332ced253758157150d43f0 # v7.10.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

userdir_publish-0.0.1/.gitignore

@@ -0,0 +1,25 @@
+__pycache__/
+.agents/
+.claude/
+.codex/
+.coverage
+.coverage.*
+.eggs/
+.fuse_*
+.idea/
+.lycheecache
+.pytest_cache/
+*.egg-info/
+*.pyc
+**.code-workspace
+*build/
+*venv/
+AGENTS.md
+CLAUDE.md
+coverage.xml
+dist/
+htmlcov/
+prof/
+pyvenv*/
+uv.lock
+version.py

userdir_publish-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,98 @@
+ci:
+  autofix_commit_msg: "MAINT: implement pre-commit autofixes"
+  autoupdate_commit_msg: "MAINT: upgrade lock files"
+  autoupdate_schedule: quarterly
+  skip:
+    - schema
+    - tombi-format
+    - tombi-lint
+    - ty
+
+repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+
+  - repo: https://github.com/ComPWA/policy
+    rev: 0.10.3
+    hooks:
+      - id: check-dev-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.3
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: name-tests-test
+        name: Tests should start with test_
+        args: ["--django"]
+      - id: trailing-whitespace
+
+  - repo: https://github.com/tombi-toml/tombi-pre-commit
+    rev: v1.10.0
+    hooks:
+      - id: tombi-format
+      - id: tombi-lint
+        args: [--error-on-warnings]
+
+  - repo: https://github.com/ComPWA/prettier-pre-commit
+    rev: v3.9.10
+    hooks:
+      - id: prettier
+
+  - repo: https://github.com/streetsidesoftware/cspell-cli
+    rev: v10.4.0
+    hooks:
+      - id: cspell
+
+  - repo: https://github.com/LilSpazJoekp/docstrfmt
+    rev: v2.2.1
+    hooks:
+      - id: docstrfmt
+
+  - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
+    rev: 3.11.1
+    hooks:
+      - id: editorconfig-checker
+        name: editorconfig
+        alias: ec
+        exclude: >-
+          (?x)^(
+            .*\.py
+          )$
+
+  - repo: local
+    hooks:
+      - id: schema
+        name: Generate JSON schema for the configuration
+        entry: uv run --no-default-groups python .pre-commit-hooks/update_schema.py
+        language: unsupported
+        files: >-
+          (?x)^(
+            \.pre-commit-hooks/update_schema\.py|
+            src/userdir_publish/config\.py|
+            userdir-publish\.schema\.json
+          )$
+        pass_filenames: false
+
+  - repo: https://github.com/astral-sh/ty-pre-commit
+    rev: v0.0.97
+    hooks:
+      - id: ty
+        args: [--group=types, --no-default-groups]

userdir_publish-0.0.1/.pre-commit-hooks/update_schema.py

@@ -0,0 +1,147 @@
+"""Generate the JSON Schema for the ``[tool.userdir-publish]`` TOML table.
+
+Run this script to update the committed schema file. It only rewrites the file when its
+content changes, so that Prettier can own the formatting.
+"""
+
+import ast
+import inspect
+import itertools
+import json
+import textwrap
+from dataclasses import MISSING, fields
+from pathlib import Path
+from typing import Any, get_args, get_origin, get_type_hints
+
+from userdir_publish.config import TOOL_NAME, Settings
+
+SCHEMA_PATH = Path(f"{TOOL_NAME}.schema.json")
+
+
+def main() -> int:
+    """Write the schema if it is outdated and return 1, so that the hook fails."""
+    if schema_is_current():
+        return 0
+    SCHEMA_PATH.write_text(render_schema())
+    return 1
+
+
+def schema_is_current() -> bool:
+    """Check whether the committed schema is semantically up to date.
+
+    >>> schema_is_current()
+    True
+    """
+    try:
+        committed = json.loads(SCHEMA_PATH.read_text())
+    except (FileNotFoundError, json.JSONDecodeError):
+        return False
+    return committed == create_schema()
+
+
+def create_schema() -> dict[str, Any]:
+    r"""Project the `.Settings` dataclass onto ``[tool.userdir-publish]``.
+
+    The defaults and examples in the schema form a valid configuration:
+
+    >>> import tempfile
+    >>> from userdir_publish.config import load_settings
+    >>> lines = [f"[tool.{TOOL_NAME}]"]
+    >>> for key, field_schema in create_schema()["properties"].items():
+    ...     value = field_schema.get("default", field_schema.get("examples", [None])[0])
+    ...     if isinstance(value, str):
+    ...         lines.append(f'{key} = "{value}"')
+    >>> with tempfile.TemporaryDirectory() as tmp:
+    ...     root = Path(tmp)
+    ...     _ = (root / "pyproject.toml").write_text("\n".join(lines))
+    ...     settings = load_settings(project_root=root, user_config=root / "none")
+    >>> settings.host
+    'web.example.edu'
+    """
+    descriptions = _get_attribute_docstrings(Settings)
+    type_hints = get_type_hints(Settings)
+    properties: dict[str, Any] = {}
+    for settings_field in fields(Settings):
+        if settings_field.name.startswith("_"):
+            continue
+        field_schema = {
+            "description": descriptions[settings_field.name],
+            **_to_json_type(
+                annotation=type_hints[settings_field.name],
+                pattern=settings_field.metadata.get("pattern"),
+            ),
+        }
+        if settings_field.default not in {MISSING, None}:
+            default = settings_field.default
+            field_schema["default"] = (
+                list(default) if isinstance(default, tuple) else default
+            )
+        if "examples" in settings_field.metadata:
+            field_schema["examples"] = settings_field.metadata["examples"]
+        properties[settings_field.name.replace("_", "-")] = field_schema
+    return {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "title": f"{TOOL_NAME} configuration",
+        "description": f"Configuration for the tool.{TOOL_NAME} TOML table.",
+        "type": "object",
+        "x-tombi-table-keys-order": "ascending",
+        "properties": dict(sorted(properties.items())),
+        "additionalProperties": False,
+    }
+
+
+def render_schema() -> str:
+    """Render the generated schema in its committed representation."""
+    return json.dumps(create_schema(), indent=2) + "\n"
+
+
+def _to_json_type(annotation: Any, pattern: str | None = None) -> dict[str, Any]:
+    """Convert a type annotation of a `.Settings` field to a JSON Schema type.
+
+    A *pattern* constrains the plain strings that the annotation accepts.
+
+    >>> _to_json_type(str | None)
+    {'type': 'string'}
+    >>> _to_json_type(tuple[str, ...])
+    {'type': 'array', 'items': {'type': 'string'}}
+    >>> from typing import Literal
+    >>> _to_json_type(Literal["a", "b"] | str, pattern="^c+$")
+    {'anyOf': [{'enum': ['a', 'b']}, {'type': 'string', 'pattern': '^c+$'}]}
+    """
+    args = [arg for arg in get_args(annotation) if arg is not type(None)]
+    origin = get_origin(annotation)
+    if annotation is str:
+        if pattern is None:
+            return {"type": "string"}
+        return {"type": "string", "pattern": pattern}
+    if origin is tuple:
+        return {"type": "array", "items": _to_json_type(args[0])}
+    if repr(origin) == "typing.Literal":
+        return {"enum": list(args)}
+    if len(args) == 1:
+        return _to_json_type(args[0], pattern)
+    if len(args) > 1:
+        return {"anyOf": [_to_json_type(arg, pattern) for arg in args]}
+    msg = f"Cannot convert {annotation} to a JSON Schema type"
+    raise NotImplementedError(msg)
+
+
+def _get_attribute_docstrings(cls: type) -> dict[str, str]:
+    """Collect the docstrings that follow the attribute definitions of a class."""
+    module = ast.parse(textwrap.dedent(inspect.getsource(cls)))
+    body = module.body[0].body  # ty: ignore[unresolved-attribute]
+    docstrings: dict[str, str] = {}
+    for node, next_node in itertools.pairwise(body):
+        if (
+            isinstance(node, ast.AnnAssign)
+            and isinstance(node.target, ast.Name)
+            and isinstance(next_node, ast.Expr)
+            and isinstance(next_node.value, ast.Constant)
+            and isinstance(next_node.value.value, str)
+        ):
+            docstrings[node.target.id] = inspect.cleandoc(next_node.value.value)
+    return docstrings
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

userdir_publish-0.0.1/.prettierignore

@@ -0,0 +1 @@
+LICENSE

userdir_publish-0.0.1/.prettierrc.yml

@@ -0,0 +1,4 @@
+overrides:
+  - files: ["*.schema.json"]
+    options:
+      objectWrap: collapse

userdir_publish-0.0.1/.python-version

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

userdir_publish-0.0.1/.vscode/extensions.json

@@ -0,0 +1,33 @@
+{
+  "recommendations": [
+    "astral-sh.ty",
+    "charliermarsh.ruff",
+    "eamodio.gitlens",
+    "esbenp.prettier-vscode",
+    "executablebookproject.myst-highlight",
+    "github.vscode-github-actions",
+    "github.vscode-pull-request-github",
+    "mhutchie.git-graph",
+    "ms-python.python",
+    "ms-vscode.live-server",
+    "redhat.vscode-yaml",
+    "soulcode.vscode-unwanted-extensions",
+    "stkb.rewrap",
+    "streetsidesoftware.code-spell-checker",
+    "tombi-toml.tombi"
+  ],
+  "unwantedRecommendations": [
+    "davidanson.vscode-markdownlint",
+    "garaioag.garaio-vscode-unwanted-recommendations",
+    "ms-python.black-formatter",
+    "ms-python.flake8",
+    "ms-python.isort",
+    "ms-python.mypy-type-checker",
+    "ms-python.pylint",
+    "ms-python.vscode-pylance",
+    "ryanluker.vscode-coverage-gutters",
+    "tamasfe.even-better-toml",
+    "travisillig.vscode-json-stable-stringify",
+    "tyriar.sort-lines"
+  ]
+}

userdir_publish-0.0.1/.vscode/settings.json

@@ -0,0 +1,45 @@
+{
+  "[css][html][json][jsonc][markdown][yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[git-commit]": {
+    "editor.rulers": [72],
+    "rewrap.wrappingColumn": 72
+  },
+  "[json]": {
+    "editor.wordWrap": "on"
+  },
+  "[python]": {
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": "explicit"
+    },
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  },
+  "[toml]": {
+    "editor.defaultFormatter": "tombi-toml.tombi"
+  },
+  "diffEditor.experimental.showMoves": true,
+  "editor.formatOnSave": true,
+  "github-actions.workflows.pinned.workflows": [".github/workflows/ci.yml"],
+  "gitlens.telemetry.enabled": false,
+  "livePreview.defaultPreviewPath": "docs/_build/html",
+  "notebook.codeActionsOnSave": {
+    "notebook.source.organizeImports": "explicit"
+  },
+  "notebook.formatOnSave.enabled": true,
+  "python.defaultInterpreterPath": ".venv/bin/python",
+  "python.terminal.activateEnvironment": false,
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": false,
+  "redhat.telemetry.enabled": false,
+  "rewrap.wrappingColumn": 88,
+  "ruff.enable": true,
+  "ruff.importStrategy": "fromEnvironment",
+  "ruff.organizeImports": true,
+  "telemetry.telemetryLevel": "off",
+  "testing.coverageToolbarEnabled": true,
+  "testing.showCoverageInExplorer": true,
+  "ty.completions.autoImport": false,
+  "ty.diagnosticMode": "workspace",
+  "ty.importStrategy": "fromEnvironment"
+}

userdir_publish-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 RUB-EP1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.