From ec11ae28f08abf58a8c8ee7d5513b890bda18def Mon Sep 17 00:00:00 2001 From: Francesco Calcavecchia Date: Tue, 14 Jan 2025 15:07:04 +0100 Subject: [PATCH] docs: Mention `uv tool` as an alterative to `pipx` (#1924) Co-authored-by: Francesco Calcavecchia --- CONTRIBUTING.md | 6 ++++++ README.md | 3 ++- docs/configuring.md | 2 ++ 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a03f2eb..abb833b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -127,6 +127,12 @@ Ready to contribute? Here's how to set up the project for local development. pipx run pyclean . --debris --verbose ``` + or + + ```shell + uvx pyclean . --debris --verbose + ``` + 1. Commit your changes and push your branch to GitHub: ```shell diff --git a/README.md b/README.md index 9886b09..f46c1cf 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,8 @@ A library and CLI app for rendering project templates. 1. Install Python 3.9 or newer. 1. Install Git 2.27 or newer. -1. To use as a CLI app: `pipx install copier` +1. To use as a CLI app: [`pipx install copier`](https://github.com/pypa/pipx) or + [`uv tool install copier`](https://docs.astral.sh/uv/#tool-management) 1. To use as a library: `pip install copier` or `conda install -c conda-forge copier` ### Nix flake diff --git a/docs/configuring.md b/docs/configuring.md index 636f04e..2da6f47 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -1013,6 +1013,8 @@ on them, so they are always installed when Copier is installed. # if Copier was installed with pipx pipx inject copier jinja2-time + # if Copier was installed with uv + uv tool install --with jinja2-time copier ``` !!! example