Skip to content

fix: avoid broken copier #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henryiii merged 2 commits into from
Feb 25, 2025
Merged

fix: avoid broken copier #555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f0f9b0
tests: avoid broken copier
henryiii Feb 24, 2025
f350f6b
Update README.md
henryiii Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,15 @@ Currently, the best choice is probably hatch for pure Python projects, and
scikit-build (such as the scikit-build-core + pybind11 choice) for binary
projects.

#### To use (modern copier version)
#### To use (copier version)

Install `copier` and `copier-templates-extensions`. Using [uv][], that's:

```bash
uv tool install copier --with copier-templates-extensions
uv tool install copier!=9.5.0 --with copier-templates-extensions
```

(Copier 9.5.0 [has a bug](https://github.com/copier-org/copier/issues/1977))
Now, run copier to generate your project:

```bash
Expand All @@ -87,7 +88,7 @@ future.
> Note: Add `--vcs-ref=HEAD` to get the latest version instead of the last
> tagged version; HEAD always passes tests (and is what cookiecutter uses).

#### To use (classic cookiecutter version)
#### To use (cookiecutter version)

Install cookiecutter, ideally with `brew install cookiecutter` if you use brew,
otherwise with `uv tool install cookiecutter` (or prepend `uvx` to the command
Expand All @@ -100,14 +101,14 @@ cookiecutter gh:scientific-python/cookie
If you are using cookiecutter 2.2.3+, you will get nice descriptions for the
options like copier!

#### To use (classic cruft version)
#### To use (cruft version)

You can also use [cruft][], which adds the ability update to cookiecutter
projects. Install with `uv tool install cruft` (or prepend `uvx` to the command
below, and skip installation). Then run:

```bash
cruft create gh:scientific-python/cookie
cruft create https://github.com/scientific-python/cookie
```

#### Post generation
Expand Down
3 changes: 2 additions & 1 deletion noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,8 @@ def nox_session(session: nox.Session, backend: str, vcs: bool) -> None:

@nox.session()
def compare_copier(session):
session.install("cookiecutter", "copier", "copier-templates-extensions")
# Copier 9.5.0 broke `--data`
session.install("cookiecutter", "copier!=9.5.0", "copier-templates-extensions")

tmp_dir = session.create_tmp()
session.cd(tmp_dir)
Expand Down
Loading