env-module-manager 0.1.2__tar.gz → 0.2.0__tar.gz

{env_module_manager-0.1.2 → env_module_manager-0.2.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: env-module-manager
-Version: 0.1.2
-Summary: Deploy Python and Rust CLI tools behind GNU environment modulefiles
+Version: 0.2.0
+Summary: Deploy Python, Rust, and shell CLI tools behind GNU environment modulefiles
 Project-URL: Homepage, https://github.com/ejb90/module-manager
 Project-URL: Documentation, https://module-manager.readthedocs.io/
 Project-URL: Tests, https://app.codecov.io/gh/ejb90/module-manager
@@ -40,7 +40,7 @@ Description-Content-Type: text/markdown
 [![PyPI](https://img.shields.io/pypi/v/env-module-manager)](https://pypi.org/project/env-module-manager/)
 [![Python versions](https://img.shields.io/pypi/pyversions/env-module-manager)](https://pypi.org/project/env-module-manager/)
 
-`module-manager` deploys versioned Python and Rust CLI tools behind GNU
+`module-manager` deploys versioned Python, Rust, and shell CLI tools behind GNU
 environment modulefiles for Linux/HPC systems.
 
 It writes tools and modulefiles into predictable versioned locations:
@@ -71,14 +71,34 @@ module-manager deploy-rust ripgrep 14.1.1 \
   --module-root /prod/modulefiles
 ```
 
+Deploy a shell script:
+
+```sh
+module-manager deploy-script my-tool 1.0.0 \
+  --script ./scripts/my-tool \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles
+```
+
 Use the generated module:
 
 ```sh
 module use /prod/modulefiles
-module load ruff/0.8.0
+module load ruff
 ruff --version
 ```
 
+Deployments make the deployed version the module default. Add `--no-default`
+when you want to write the versioned modulefile without changing the default.
+
+Remove a deployed version:
+
+```sh
+module-manager uninstall ruff 0.8.0 \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles
+```
+
 ## Documentation
 
 Full documentation lives in `docs/` and can be served with MkDocs:
@@ -88,4 +108,4 @@ uv run mkdocs serve
 ```
 
 Start with `docs/index.md` for installation, configuration, Python tools, Rust
-tools, and local development notes.
+tools, shell scripts, uninstall, and local development notes.

{env_module_manager-0.1.2 → env_module_manager-0.2.0}/README.md

@@ -8,7 +8,7 @@
 [![PyPI](https://img.shields.io/pypi/v/env-module-manager)](https://pypi.org/project/env-module-manager/)
 [![Python versions](https://img.shields.io/pypi/pyversions/env-module-manager)](https://pypi.org/project/env-module-manager/)
 
-`module-manager` deploys versioned Python and Rust CLI tools behind GNU
+`module-manager` deploys versioned Python, Rust, and shell CLI tools behind GNU
 environment modulefiles for Linux/HPC systems.
 
 It writes tools and modulefiles into predictable versioned locations:
@@ -39,14 +39,34 @@ module-manager deploy-rust ripgrep 14.1.1 \
   --module-root /prod/modulefiles
 ```
 
+Deploy a shell script:
+
+```sh
+module-manager deploy-script my-tool 1.0.0 \
+  --script ./scripts/my-tool \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles
+```
+
 Use the generated module:
 
 ```sh
 module use /prod/modulefiles
-module load ruff/0.8.0
+module load ruff
 ruff --version
 ```
 
+Deployments make the deployed version the module default. Add `--no-default`
+when you want to write the versioned modulefile without changing the default.
+
+Remove a deployed version:
+
+```sh
+module-manager uninstall ruff 0.8.0 \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles
+```
+
 ## Documentation
 
 Full documentation lives in `docs/` and can be served with MkDocs:
@@ -56,4 +76,4 @@ uv run mkdocs serve
 ```
 
 Start with `docs/index.md` for installation, configuration, Python tools, Rust
-tools, and local development notes.
+tools, shell scripts, uninstall, and local development notes.

env_module_manager-0.2.0/docs/environment-modules.md

@@ -0,0 +1,57 @@
+# Environment Modules
+
+Generated modulefiles are Tcl modulefiles for Environment Modules.
+
+Use a generated module tree:
+
+```sh
+module use /prod/modulefiles
+module load ruff
+ruff --version
+```
+
+You can also load an explicit version:
+
+```sh
+module load ruff/0.8.0
+ruff --version
+```
+
+## Generated Modulefile Behavior
+
+Each modulefile:
+
+- prepends the tool's versioned `bin` directory to `PATH`
+- sets `<TOOL>_ROOT`
+- includes `module-whatis`
+- includes install guidance in `module help`
+
+For `ruff/0.8.0`, the root variable is:
+
+```sh
+RUFF_ROOT=/prod/tools/ruff/0.8.0
+```
+
+## Default Versions
+
+Deploy commands write a default-version selector by default:
+
+```text
+/prod/modulefiles/<name>/.version
+```
+
+For `ruff/0.8.0`, this makes `module load ruff` resolve to `ruff/0.8.0`.
+
+Use `--no-default` when a deployment should not update the default version:
+
+```sh
+module-manager deploy-python ruff 0.8.0 \
+  --package 'ruff==0.8.0' \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles \
+  --no-default
+```
+
+Uninstall removes the default selector only when it still points at the version
+being removed. If another deployment has already made a newer version the
+default, that selector is left alone.

{env_module_manager-0.1.2 → env_module_manager-0.2.0}/docs/index.md

@@ -1,6 +1,6 @@
 # module-manager
 
-`module-manager` deploys versioned Python and Rust CLI tools behind GNU
+`module-manager` deploys versioned Python, Rust, and shell CLI tools behind GNU
 environment modulefiles for Linux/HPC systems.
 
 It is designed for administrators who want reproducible command-line tool
@@ -47,3 +47,5 @@ ruff --version
 - Set shared defaults in [Configuration](configuration.md).
 - Deploy Python packages with [Python Tools](python-tools.md).
 - Deploy Rust binaries with [Rust Tools](rust-tools.md).
+- Deploy shell scripts with [Shell Scripts](shell-tools.md).
+- Remove deployed versions with [Uninstall](uninstall.md).

{env_module_manager-0.1.2 → env_module_manager-0.2.0}/docs/python-tools.md

@@ -21,6 +21,10 @@ Without `--execute-install`, the command creates the versioned directories and
 modulefile only. The module help includes the `uv tool install` command that an
 administrator can run later.
 
+Deployments also make the deployed version the module default, so `module load
+ruff` resolves to `ruff/0.8.0`. Add `--no-default` to leave the current default
+unchanged.
+
 ## Deploy from a Private Index
 
 ```sh

{env_module_manager-0.1.2 → env_module_manager-0.2.0}/docs/reference.md

@@ -18,6 +18,18 @@ Show Rust deployment options:
 module-manager deploy-rust --help
 ```
 
+Show shell script deployment options:
+
+```sh
+module-manager deploy-script --help
+```
+
+Show uninstall options:
+
+```sh
+module-manager uninstall --help
+```
+
 ## Python Command
 
 ```sh
@@ -28,6 +40,7 @@ module-manager deploy-python NAME VERSION \
   [--find-links PATH_OR_URL] \
   [--prefix PATH] \
   [--module-root PATH] \
+  [--no-default] \
   [--execute-install]
 ```
 
@@ -37,5 +50,26 @@ module-manager deploy-python NAME VERSION \
 module-manager deploy-rust NAME VERSION \
   [--binary PATH] \
   [--prefix PATH] \
-  [--module-root PATH]
+  [--module-root PATH] \
+  [--no-default]
+```
+
+## Shell Script Command
+
+```sh
+module-manager deploy-script NAME VERSION \
+  [--script PATH] \
+  [--prefix PATH] \
+  [--module-root PATH] \
+  [--no-default]
+```
+
+## Uninstall Command
+
+```sh
+module-manager uninstall NAME VERSION \
+  [--prefix PATH] \
+  [--module-root PATH] \
+  [--keep-default] \
+  [--dry-run]
 ```

{env_module_manager-0.1.2 → env_module_manager-0.2.0}/docs/rust-tools.md

@@ -22,3 +22,7 @@ and creates:
 ```
 
 The generated modulefile prepends the deployed `bin` directory to `PATH`.
+
+Deployments make the deployed version the module default, so `module load
+ripgrep` resolves to `ripgrep/14.1.1`. Add `--no-default` to leave the current
+default unchanged.

env_module_manager-0.2.0/docs/shell-tools.md

@@ -0,0 +1,29 @@
+# Shell Scripts
+
+Shell scripts can be copied directly into the versioned prefix.
+
+```sh
+module-manager deploy-script my-tool 1.0.0 \
+  --script ./scripts/my-tool \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles
+```
+
+This writes the script to:
+
+```text
+/prod/tools/my-tool/1.0.0/bin/my-tool
+```
+
+and creates:
+
+```text
+/prod/modulefiles/my-tool/1.0.0
+```
+
+The deployed script is marked executable, and the generated modulefile prepends
+the deployed `bin` directory to `PATH`.
+
+Deployments make the deployed version the module default, so `module load
+my-tool` resolves to `my-tool/1.0.0`. Add `--no-default` to leave the current
+default unchanged.

env_module_manager-0.2.0/docs/uninstall.md

@@ -0,0 +1,42 @@
+# Uninstall
+
+Remove one deployed tool version with the `uninstall` command:
+
+```sh
+module-manager uninstall ruff 0.8.0 \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles
+```
+
+This removes:
+
+```text
+/prod/tools/ruff/0.8.0
+/prod/modulefiles/ruff/0.8.0
+```
+
+If the default selector points at the same version, it is removed too:
+
+```text
+/prod/modulefiles/ruff/.version
+```
+
+If the default selector points at a different version, it is left in place.
+
+Preview an uninstall without deleting files:
+
+```sh
+module-manager uninstall ruff 0.8.0 \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles \
+  --dry-run
+```
+
+Leave the default selector untouched even when it points at the removed version:
+
+```sh
+module-manager uninstall ruff 0.8.0 \
+  --prefix /prod/tools \
+  --module-root /prod/modulefiles \
+  --keep-default
+```

{env_module_manager-0.1.2 → env_module_manager-0.2.0}/mkdocs.yml

@@ -1,5 +1,5 @@
 site_name: module-manager
-site_description: Deploy Python and Rust CLI tools behind GNU environment modulefiles.
+site_description: Deploy Python, Rust, and shell CLI tools behind GNU environment modulefiles.
 repo_url: https://github.com/ellis/module-manager
 
 theme:
@@ -45,6 +45,8 @@ nav:
   - Configuration: configuration.md
   - Python Tools: python-tools.md
   - Rust Tools: rust-tools.md
+  - Shell Scripts: shell-tools.md
+  - Uninstall: uninstall.md
   - Environment Modules: environment-modules.md
   - Local Development: development.md
   - CLI Reference: reference.md

{env_module_manager-0.1.2 → env_module_manager-0.2.0}/module_manager/cli.py

@@ -10,7 +10,7 @@ from click import Command
 
 from . import __version__
 from .config import AppConfig, load_config
-from .deploy import deploy_python_tool, deploy_rust_tool
+from .deploy import UninstallResult, deploy_python_tool, deploy_rust_tool, deploy_script_tool, uninstall_tool
 
 click.rich_click.TEXT_MARKUP = "rich"
 click.rich_click.STYLE_COMMAND = "bold cyan"
@@ -29,7 +29,14 @@ ClickCommand = TypeVar("ClickCommand", bound=Command)
 
 
 def common_options(command: ClickCommand) -> ClickCommand:
-    """Attach options shared by Python and Rust deployment commands."""
+    """Attach options shared by deployment commands."""
+    command = click.option(
+        "--default/--no-default",
+        "make_default",
+        default=True,
+        show_default=True,
+        help="Write the module default selector for this version.",
+    )(command)
     command = click.option(
         "--homepage",
         help="Optional upstream homepage shown in module help.",
@@ -53,6 +60,23 @@ def common_options(command: ClickCommand) -> ClickCommand:
     return command
 
 
+def location_options(command: ClickCommand) -> ClickCommand:
+    """Attach options for commands that need deployment roots."""
+    command = click.option(
+        "--prefix",
+        type=PATH,
+        help="Root installation prefix, for example /prod/tools.",
+    )(command)
+    command = click.option(
+        "--module-root",
+        type=PATH,
+        help="Root of the module tree, for example /prod/modulefiles.",
+    )(command)
+    command = click.argument("version")(command)
+    command = click.argument("name")(command)
+    return command
+
+
 @click.group(context_settings={"help_option_names": ["-h", "--help"]})
 @click.version_option(__version__)
 @click.option(
@@ -66,8 +90,8 @@ def main(ctx: click.Context, config: Path | None) -> None:
     """[bold]Deploy CLI tools behind GNU environment modulefiles.[/bold].
 
     Build versioned modulefiles for Python tools installed with
-    [cyan]uv tool install[/cyan] and Rust binaries copied into a production
-    prefix.
+    [cyan]uv tool install[/cyan], Rust binaries, and shell scripts copied into
+    a production prefix.
     """
     ctx.obj = load_config(config)
 
@@ -102,6 +126,7 @@ def deploy_python(
     prefix: Path | None,
     description: str | None,
     homepage: str | None,
+    make_default: bool,
     package: str,
     python: str | None,
     indexes: tuple[str, ...],
@@ -123,8 +148,11 @@ def deploy_python(
         indexes=indexes or config.indexes,
         find_links=find_links or config.find_links,
         execute_install=execute_install,
+        make_default=make_default,
+    )
+    print_result(
+        paths.modulefile, paths.install_root, paths.bin_dir, paths.default_version_file if make_default else None
     )
-    print_result(paths.modulefile, paths.install_root, paths.bin_dir)
 
 
 @main.command("deploy-rust")
@@ -143,6 +171,7 @@ def deploy_rust(
     prefix: Path | None,
     description: str | None,
     homepage: str | None,
+    make_default: bool,
     binary: Path | None,
 ) -> None:
     """Copy a Rust CLI binary and write a modulefile for it."""
@@ -156,8 +185,84 @@ def deploy_rust(
         binary=binary.expanduser() if binary else None,
         description=description,
         homepage=homepage,
+        make_default=make_default,
+    )
+    print_result(
+        paths.modulefile, paths.install_root, paths.bin_dir, paths.default_version_file if make_default else None
     )
-    print_result(paths.modulefile, paths.install_root, paths.bin_dir)
+
+
+@main.command("deploy-script")
+@common_options
+@click.option(
+    "--script",
+    type=PATH,
+    help="Shell script to copy into the versioned prefix.",
+)
+@click.pass_obj
+def deploy_script(
+    config: AppConfig,
+    name: str,
+    version: str,
+    module_root: Path | None,
+    prefix: Path | None,
+    description: str | None,
+    homepage: str | None,
+    make_default: bool,
+    script: Path | None,
+) -> None:
+    """Copy a shell script and write a modulefile for it."""
+    resolved_module_root = require_path(module_root or config.module_root, "module root", "--module-root")
+    resolved_prefix = require_path(prefix or config.prefix, "install prefix", "--prefix")
+    paths = deploy_script_tool(
+        name=name,
+        version=version,
+        module_root=resolved_module_root,
+        prefix=resolved_prefix,
+        script=script.expanduser() if script else None,
+        description=description,
+        homepage=homepage,
+        make_default=make_default,
+    )
+    print_result(
+        paths.modulefile, paths.install_root, paths.bin_dir, paths.default_version_file if make_default else None
+    )
+
+
+@main.command("uninstall")
+@location_options
+@click.option(
+    "--keep-default",
+    is_flag=True,
+    help="Leave the default selector in place, even if it points at this version.",
+)
+@click.option(
+    "--dry-run",
+    is_flag=True,
+    help="Print paths that would be removed without deleting them.",
+)
+@click.pass_obj
+def uninstall(
+    config: AppConfig,
+    name: str,
+    version: str,
+    module_root: Path | None,
+    prefix: Path | None,
+    keep_default: bool,
+    dry_run: bool,
+) -> None:
+    """Remove a deployed tool version and its modulefile."""
+    resolved_module_root = require_path(module_root or config.module_root, "module root", "--module-root")
+    resolved_prefix = require_path(prefix or config.prefix, "install prefix", "--prefix")
+    result = uninstall_tool(
+        name=name,
+        version=version,
+        module_root=resolved_module_root,
+        prefix=resolved_prefix,
+        remove_default=not keep_default,
+        dry_run=dry_run,
+    )
+    print_uninstall_result(result, dry_run)
 
 
 def require_path(value: Path | None, label: str, option: str) -> Path:
@@ -171,8 +276,25 @@ def require_path(value: Path | None, label: str, option: str) -> Path:
     return value.expanduser()
 
 
-def print_result(modulefile: Path, install_root: Path, bin_dir: Path) -> None:
+def print_result(
+    modulefile: Path,
+    install_root: Path,
+    bin_dir: Path,
+    default_version_file: Path | None = None,
+) -> None:
     """Print the paths produced by a deployment command."""
     click.echo(f"modulefile: {modulefile}")
     click.echo(f"install root: {install_root}")
     click.echo(f"bin dir: {bin_dir}")
+    if default_version_file:
+        click.echo(f"default version: {default_version_file}")
+
+
+def print_uninstall_result(result: UninstallResult, dry_run: bool = False) -> None:
+    """Print the paths removed by an uninstall command."""
+    action = "would remove" if dry_run else "removed"
+    if not result.removed:
+        click.echo("nothing to remove")
+        return
+    for path in result.removed:
+        click.echo(f"{action}: {path}")