pdm-default-scripts 0.1.5__tar.gz

pdm_default_scripts-0.1.5/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: pdm-default-scripts
+Version: 0.1.5
+Summary: PDM plugin that adds default scripts after `pdm init`
+Keywords: pdm,plugin,default scripts
+Author-Email: tepek2 <dev@tepek2.com>
+License: MIT
+Requires-Python: >=3.9
+Requires-Dist: pdm>=2.26.7
+Description-Content-Type: text/markdown
+
+![Github Actions](https://github.com/tepek2/pdm-default-scripts/actions/workflows/tests.yml/badge.svg)
+
+# pdm-default-scripts
+
+`pdm-default-scripts` is a PDM plugin that adds your predefined scripts to new projects right after `pdm init`.
+
+## Installation
+
+Install the plugin into your PDM environment:
+
+```bash
+pdm self add pdm-default-scripts
+```
+
+## Configure default scripts
+
+Create a `default-scripts.toml` file in your user PDM config directory.
+
+- Linux: `~/.config/pdm/default-scripts.toml`
+- macOS: `~/Library/Application Support/pdm/default-scripts.toml`
+- Windows: `%APPDATA%\\pdm\\default-scripts.toml`
+
+### Example
+
+```toml
+[scripts]
+test = "pytest"
+lint = "ruff check ."
+format = "ruff format ."
+
+[scripts.cov]
+cmd = "pytest --cov"
+env = { PYTHONPATH = "src" }
+```
+
+## Usage
+
+1. Configure `default-scripts.toml` once.
+2. Run `pdm init` in any new project.
+3. The plugin adds missing entries into `[tool.pdm.scripts]` in `pyproject.toml`.
+
+Existing scripts are not overwritten.
+
+## How it behaves
+
+- Runs on the `post_init` PDM signal.
+- Reads `[scripts]` from your `default-scripts.toml`.
+- Writes scripts into `[tool.pdm.scripts]` only when a script name is not already present.

pdm_default_scripts-0.1.5/README.md

@@ -0,0 +1,48 @@
+![Github Actions](https://github.com/tepek2/pdm-default-scripts/actions/workflows/tests.yml/badge.svg)
+
+# pdm-default-scripts
+
+`pdm-default-scripts` is a PDM plugin that adds your predefined scripts to new projects right after `pdm init`.
+
+## Installation
+
+Install the plugin into your PDM environment:
+
+```bash
+pdm self add pdm-default-scripts
+```
+
+## Configure default scripts
+
+Create a `default-scripts.toml` file in your user PDM config directory.
+
+- Linux: `~/.config/pdm/default-scripts.toml`
+- macOS: `~/Library/Application Support/pdm/default-scripts.toml`
+- Windows: `%APPDATA%\\pdm\\default-scripts.toml`
+
+### Example
+
+```toml
+[scripts]
+test = "pytest"
+lint = "ruff check ."
+format = "ruff format ."
+
+[scripts.cov]
+cmd = "pytest --cov"
+env = { PYTHONPATH = "src" }
+```
+
+## Usage
+
+1. Configure `default-scripts.toml` once.
+2. Run `pdm init` in any new project.
+3. The plugin adds missing entries into `[tool.pdm.scripts]` in `pyproject.toml`.
+
+Existing scripts are not overwritten.
+
+## How it behaves
+
+- Runs on the `post_init` PDM signal.
+- Reads `[scripts]` from your `default-scripts.toml`.
+- Writes scripts into `[tool.pdm.scripts]` only when a script name is not already present.

pdm_default_scripts-0.1.5/default_scripts.py

@@ -0,0 +1,71 @@
+from collections.abc import MutableMapping
+from typing import Any
+
+import platformdirs
+import tomlkit
+from pdm.core import Core
+from pdm.project import Project
+from pdm.signals import post_init
+from tomlkit import TOMLDocument
+from tomlkit.items import Table
+
+DEFAULT_SCRIPTS_FILE = "default-scripts.toml"
+
+
+def _get_scripts_for_creation() -> Table | None:
+    default_scripts = platformdirs.user_config_path("pdm") / DEFAULT_SCRIPTS_FILE
+
+    if not default_scripts.exists():
+        return None
+
+    with default_scripts.open("r", encoding="utf-8") as fp:
+        scripts = tomlkit.load(fp).get("scripts")
+
+    if scripts is None:
+        return None
+
+    assert isinstance(scripts, Table), "[scripts] must be a TOML table"
+
+    return scripts
+
+
+def _add_script_with_dotted_keys(scripts_table: Table, name: str, command: Any):
+    if isinstance(command, MutableMapping):
+        for key, value in command.items():
+            dotted_key = tomlkit.key([name, str(key)])
+            scripts_table.append(dotted_key, value)
+        return
+    scripts_table[name] = command
+
+
+def _get_or_create_table(node: TOMLDocument | Table, key: str) -> Table:
+
+    if node.get(key) is None:
+        node[key] = tomlkit.table()
+
+    table = node[key]
+    assert isinstance(table, Table), f"[{key}] must be TOML table"
+
+    return table
+
+
+def on_post_init(project: Project, **args):
+    scripts_to_add = _get_scripts_for_creation()
+
+    if scripts_to_add is None:
+        return
+
+    tool_table = _get_or_create_table(project.pyproject.open_for_write(), "tool")
+    pdm_table = _get_or_create_table(tool_table, "pdm")
+    scripts_table = _get_or_create_table(pdm_table, "scripts")
+
+    for name, command in scripts_to_add.items():
+        if name not in scripts_table:
+            _add_script_with_dotted_keys(scripts_table, str(name), command)
+            project.core.ui.info(f"Added default script: {name}")
+
+    project.pyproject.write(show_message=False)
+
+
+def plugin(core: Core) -> None:
+    post_init.connect(on_post_init)

pdm_default_scripts-0.1.5/pyproject.toml

@@ -0,0 +1,91 @@
+[project]
+name = "pdm-default-scripts"
+version = "0.1.5"
+description = "PDM plugin that adds default scripts after `pdm init`"
+authors = [
+    { name = "tepek2", email = "dev@tepek2.com" },
+]
+requires-python = ">=3.9"
+readme = "README.md"
+keywords = [
+    "pdm",
+    "plugin",
+    "default scripts",
+]
+dependencies = [
+    "pdm>=2.26.7",
+]
+
+[project.license]
+text = "MIT"
+
+[project.entry-points.pdm]
+default-scripts = "default_scripts:plugin"
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+    "pytest-mock>=3.15.1",
+    "pyright>=1.1.408",
+    "pytest-cov>=7.1.0",
+    "ruff>=0.15.8",
+]
+release = [
+    "commitizen>=4.13.9",
+]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = [
+    "E4",
+    "E7",
+    "E9",
+    "F",
+    "I",
+]
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+changelog_incremental = false
+tag_format = "v$version"
+version_scheme = "semver2"
+version_provider = "pep621"
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.scripts]
+lint = "ruff check"
+test = "pytest"
+type-check = "pyright ."
+coverage = "pytest --cov-fail-under=75"
+release-create = "cz bump --allow-no-commit --version-files-only --changelog --changelog-to-stdout --yes {args}"
+
+[tool.pdm.scripts.static-analys]
+composite = [
+    "lint",
+    "type-check",
+]
+
+[tool.pdm.scripts.tests]
+composite = [
+    "static-analys",
+    "test",
+]
+
+[tool.pdm.scripts.release-commit]
+shell = "git add pyproject.toml CHANGELOG.md && git commit -m \"release: v$(cz version --project)\" && git tag \"v$(cz version --project)\" && git push && git push --tags\n    "
+
+[tool.pdm.scripts.release]
+composite = [
+    "release-create {args}",
+    "release-commit",
+]

pdm_default_scripts-0.1.5/tests/test_defalult_scripts.py

@@ -0,0 +1,51 @@
+import tomlkit
+import tomlkit.items
+from pdm import signals
+from pdm.project.core import Project
+from pdm.pytest import RunResult
+from pytest import MonkeyPatch
+
+from default_scripts import on_post_init
+
+pytest_plugins = "pdm.pytest"
+
+
+def test_post_init_signal(
+    project_no_init: Project,
+    pdm,
+    monkeypatch: MonkeyPatch,
+):
+    def _table_data(str_data: str) -> tomlkit.items.Table:
+        scripts = tomlkit.parse(str_data).get("scripts")
+        assert isinstance(scripts, tomlkit.items.Table)
+        return scripts
+
+    mock_config_file_str = """
+    [scripts]
+    _.env = { PYTHONPATH = "${PDM_PROJECT_ROOT}" }
+    format = "ruff format ."
+    cov = { cmd = "pytest --cov", env = { PYTHONPATH = "src" } }
+
+
+    [scripts.cov2]
+    cmd = "pytest --cov"
+    env = { PYTHONPATH = "src" }
+    """
+
+    expected_data = {
+        "_": {"env": {"PYTHONPATH": "${PDM_PROJECT_ROOT}"}},
+        "format": "ruff format .",
+        "cov": {"cmd": "pytest --cov", "env": {"PYTHONPATH": "src"}},
+        "cov2": {"cmd": "pytest --cov", "env": {"PYTHONPATH": "src"}},
+    }
+
+    monkeypatch.setattr(
+        "default_scripts._get_scripts_for_creation",
+        lambda: _table_data(mock_config_file_str),
+    )
+
+    with signals.post_init.connected_to(on_post_init):
+        result: RunResult = pdm(["init", "-n"], obj=project_no_init)
+    print(project_no_init.scripts)
+    assert result.exit_code == 0
+    assert project_no_init.scripts == expected_data