@@ -48,8 +48,7 @@ During generation you can select from the following backends for your package:
4848 and twine. Supports [ PEP 621] [ ] .
49494 . [ poetry] [ ] : An all-in-one solution to pure Python projects. Replaces
5050 setuptools, venv/pipenv, pip, wheel, and twine. Higher learning curve, but is
51- all-in-one. Makes some bad default assumptions for libraries. The only one
52- with a non-standard pyproject.toml config.
51+ all-in-one. Makes some bad default assumptions for libraries.
53525 . [ setuptools] [ ] : The classic build system, but with the new standardized
5453 configuration.
55546 . [ pybind11] [ ] : This is setuptools but with an C++ extension written in
@@ -66,21 +65,20 @@ projects.
6665
6766#### To use (modern copier version)
6867
69- Install ` copier ` and ` copier-templates-extensions ` . Using [ pipx ] [ ] , that's:
68+ Install ` copier ` and ` copier-templates-extensions ` . Using [ uv ] [ ] , that's:
7069
7170``` bash
72- pipx install copier
73- pipx inject copier copier-templates-extensions
71+ uv tool install copier --with copier-templates-extensions
7472```
7573
7674Now, run copier to generate your project:
7775
7876``` bash
79- copier copy gh:scientific-python/cookie < pkg> --trust
77+ copier copy gh:scientific-python/cookie < pkg> --trust --vcs-ref=HEAD
8078```
8179
82- (` <pkg> ` is the path to put the new project. If copier is old, use ` --UNSAFE `
83- instead of ` --trust ` )
80+ (` <pkg> ` is the path to put the new project. ` --vcs-ref=HEAD ` gets the current
81+ version instead of the last tag, matching cookiecutter's behavior. )
8482
8583You will get a nicer CLI experience with answer validation. You will also get a
8684` .copier-answers.yml ` file, which will allow you to perform updates in the
@@ -92,7 +90,7 @@ future.
9290#### To use (classic cookiecutter version)
9391
9492Install cookiecutter, ideally with ` brew install cookiecutter ` if you use brew,
95- otherwise with ` pipx install cookiecutter` (or prepend ` pipx run ` to the command
93+ otherwise with ` uv tool install cookiecutter` (or prepend ` uvx ` to the command
9694below, and skip installation). Then run:
9795
9896``` bash
@@ -105,8 +103,8 @@ options like copier!
105103#### To use (classic cruft version)
106104
107105You can also use [ cruft] [ ] , which adds the ability update to cookiecutter
108- projects. Install with ` pipx install cruft` (or prepend ` pipx run ` to the
109- command below, and skip installation). Then run:
106+ projects. Install with ` uv tool install cruft` (or prepend ` uvx ` to the command
107+ below, and skip installation). Then run:
110108
111109``` bash
112110cruft create gh:scientific-python/cookie
@@ -157,8 +155,7 @@ nox -s "lint(scikit-build)"
157155nox -s "nox(hatch)" -- docs
158156```
159157
160- If you don't have ` nox ` locally, you can use [ pipx] [ ] , such as ` pipx run nox `
161- instead.
158+ If you don't have ` nox ` locally, you can use [ uv] [ ] , such as ` uvx nox ` instead.
162159
163160#### Other similar projects
164161
@@ -198,7 +195,6 @@ A lot of the guide, cookiecutter, and repo-review started out as part of
198195[ nsls-ii ] : https://nsls-ii.github.io/scientific-python-cookiecutter/
199196[ pdm ] : https://pdm.fming.dev
200197[ pep 621 ] : https://www.python.org/dev/peps/pep-0621
201- [ pipx ] : https://pypa.github.io/pipx/
202198[ poetry ] : https://python-poetry.org
203199[ pybind11 ] : https://pybind11.readthedocs.io
204200[ pypa ] : https://www.pypa.io
@@ -209,6 +205,7 @@ A lot of the guide, cookiecutter, and repo-review started out as part of
209205[ rtd-link ] : https://scientific-python-cookie.readthedocs.io/en/latest/?badge=latest
210206[ scikit-build ] : https://scikit-build.readthedocs.io
211207[ setuptools ] : https://setuptools.readthedocs.io
208+ [ uv ] : https://docs.astral.sh/uv
212209
213210<!-- prettier-ignore-end -->
214211
@@ -224,7 +221,7 @@ Guide][] at [scientific-python/cookie][] for [repo-review][].
224221This tool can check the style of a repository. Use like this:
225222
226223``` bash
227- pipx run ' sp-repo-review[cli] ' < path to repository>
224+ uv run --extra=cli sp-repo-review < path to repository>
228225```
229226
230227This will produce a list of results - green checkmarks mean this rule is
0 commit comments