@@ -48,8 +48,7 @@ During generation you can select from the following backends for your package:
48
48
and twine. Supports [ PEP 621] [ ] .
49
49
4 . [ poetry] [ ] : An all-in-one solution to pure Python projects. Replaces
50
50
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.
53
52
5 . [ setuptools] [ ] : The classic build system, but with the new standardized
54
53
configuration.
55
54
6 . [ pybind11] [ ] : This is setuptools but with an C++ extension written in
@@ -66,21 +65,20 @@ projects.
66
65
67
66
#### To use (modern copier version)
68
67
69
- Install ` copier ` and ` copier-templates-extensions ` . Using [ pipx ] [ ] , that's:
68
+ Install ` copier ` and ` copier-templates-extensions ` . Using [ uv ] [ ] , that's:
70
69
71
70
``` bash
72
- pipx install copier
73
- pipx inject copier copier-templates-extensions
71
+ uv tool install copier --with copier-templates-extensions
74
72
```
75
73
76
74
Now, run copier to generate your project:
77
75
78
76
``` bash
79
- copier copy gh:scientific-python/cookie < pkg> --trust
77
+ copier copy gh:scientific-python/cookie < pkg> --trust --vcs-ref=HEAD
80
78
```
81
79
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. )
84
82
85
83
You will get a nicer CLI experience with answer validation. You will also get a
86
84
` .copier-answers.yml ` file, which will allow you to perform updates in the
@@ -92,7 +90,7 @@ future.
92
90
#### To use (classic cookiecutter version)
93
91
94
92
Install 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
96
94
below, and skip installation). Then run:
97
95
98
96
``` bash
@@ -105,8 +103,8 @@ options like copier!
105
103
#### To use (classic cruft version)
106
104
107
105
You 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:
110
108
111
109
``` bash
112
110
cruft create gh:scientific-python/cookie
@@ -157,8 +155,7 @@ nox -s "lint(scikit-build)"
157
155
nox -s "nox(hatch)" -- docs
158
156
```
159
157
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.
162
159
163
160
#### Other similar projects
164
161
@@ -198,7 +195,6 @@ A lot of the guide, cookiecutter, and repo-review started out as part of
198
195
[ nsls-ii ] : https://nsls-ii.github.io/scientific-python-cookiecutter/
199
196
[ pdm ] : https://pdm.fming.dev
200
197
[ pep 621 ] : https://www.python.org/dev/peps/pep-0621
201
- [ pipx ] : https://pypa.github.io/pipx/
202
198
[ poetry ] : https://python-poetry.org
203
199
[ pybind11 ] : https://pybind11.readthedocs.io
204
200
[ pypa ] : https://www.pypa.io
@@ -209,6 +205,7 @@ A lot of the guide, cookiecutter, and repo-review started out as part of
209
205
[ rtd-link ] : https://scientific-python-cookie.readthedocs.io/en/latest/?badge=latest
210
206
[ scikit-build ] : https://scikit-build.readthedocs.io
211
207
[ setuptools ] : https://setuptools.readthedocs.io
208
+ [ uv ] : https://docs.astral.sh/uv
212
209
213
210
<!-- prettier-ignore-end -->
214
211
@@ -224,7 +221,7 @@ Guide][] at [scientific-python/cookie][] for [repo-review][].
224
221
This tool can check the style of a repository. Use like this:
225
222
226
223
``` bash
227
- pipx run ' sp-repo-review[cli] ' < path to repository>
224
+ uv run --extra=cli sp-repo-review < path to repository>
228
225
```
229
226
230
227
This will produce a list of results - green checkmarks mean this rule is
0 commit comments