pdm-default-scripts 0.1.5__py3-none-any.whl

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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,5 @@
+default_scripts.py,sha256=9PE_OXizwjcMrLhwHaRK8O3OwnAgEjpITQa4eAHQMFQ,2015
+pdm_default_scripts-0.1.5.dist-info/METADATA,sha256=kju3VyZj5spJw7ktBZojGVXFA_7xkQ6S-FW7WTubx7M,1499
+pdm_default_scripts-0.1.5.dist-info/WHEEL,sha256=Z36eTX6lG3PITRleSd5hAZHCcz52yg3c0JQVxKBbLW0,90
+pdm_default_scripts-0.1.5.dist-info/entry_points.txt,sha256=wY-LO-se0n15txdbXIOLF52ojLxidokIrAZFnVi_nvM,82
+pdm_default_scripts-0.1.5.dist-info/RECORD,,

pdm_default_scripts-0.1.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.4.8)
+Root-Is-Purelib: true
+Tag: py3-none-any

pdm_default_scripts-0.1.5.dist-info/entry_points.txt

@@ -0,0 +1,7 @@
+[console_scripts]
+
+[gui_scripts]
+
+[pdm]
+default-scripts = default_scripts:plugin
+