Use copier instead of cookiecutter #1

GenevieveBuckley · 2023-10-27T00:57:59Z

This PR swaps copier for cookiecutter.
It is a fully working implementation that people can try out (as suggested by @jni, see context below)

napari/napari#6122 by @jni

Consider using copier instead of cookiecutter #6122

Some folks from the scientific Python ecosystem seem to like it.

One thing I like is that it has built-in support for updating projects when the template is updated: https://copier.readthedocs.io/en/stable/updating

Apparently cruft does this for cookiecutter templates but that seems like a more complex tool chain since it's not built into cookiecutter.

I don't have a strong opinion here, just want to share something I came across that could be interesting to implement, since updating downstream projects is something we have needed a lot of.

PR to the original cookiecutter repository: napari/cookiecutter-napari-plugin#165

Closes #2
Closes #3

… initialize new plugin repository)

tlambert03 · 2023-10-27T01:06:14Z

in case there's anything in here that might be useful to this effort, I had a copier template for napari plugins that I was working on a while back here https://github.com/tlambert03/napari-plugin-template
might be some patterns in there that are worth using. (the testing patterns in there might be useful too)

tlambert03 · 2023-10-27T01:09:30Z

I see there's a discussion of pytest-copie ... that was more or less the goal of these lines:
https://github.com/tlambert03/napari-plugin-template/blob/main/tests/test_generate.py#L15-L61

see also, there was a dream at one point to use that template for an npe2 create command, see original PR here: napari/npe2#225

but, I closed that cause... ya know

…not parsed as python 3.1

…est-cookies uses

… use pytest-copie

jni · 2023-10-27T02:48:03Z

@GenevieveBuckley we need to get tests passing but repo permissions should be fixed.

…ecommit = True

Co-authored-by: Draga Doncila Pop <[email protected]>

This reverts commit 12fd445.

jni · 2024-05-22T14:24:23Z

Bah, I've made a mess of things, got too excited by Draga's "placeholder" comment. 😅 Which was spot on though. I think the last push should fix the tests. But for now it's bedtime. 🤞

jni · 2024-05-22T14:25:10Z

Only comment I haven't addressed is @DragaDoncila's setup.cfg comment. @DragaDoncila is there any non redundant information in the setup.cfg? ie can we just delete the file in the template, or is there still metadata to be ported across?

template/pyproject.toml.jinja

GenevieveBuckley · 2024-05-24T00:43:07Z

Is there any non redundant information in the setup.cfg? ie can we just delete the file in the template, or is there still metadata to be ported across?

I checked line by line before removing template/setup.cfg.jinja from the repository with git. I did not see any information that wasn't already in pyproject.toml (or that we didn't need at all, like test dependencies that are not required for plugins).

GenevieveBuckley · 2024-05-24T00:49:53Z

Love the placeholders (thanks Draga!)
Just one question remaining: #1 (comment)

template/pyproject.toml.jinja

…rs (#186) Closes napari/cookiecutter-napari-plugin#185

* Dependabot config for plugin template and new child plugins * Add docs about how to enable Dependabot in your github settings * Set dependabot interval to longest possible, i.e. monthly * Add dependabot question to cookiecutter, remove files if option is not requested * Add documentation about the dependabot config option * Fix typo

Co-authored-by: Juan Nunez-Iglesias <[email protected]>

….12 (#189)

…k; do not provide github URL as default

GenevieveBuckley · 2024-07-11T07:04:56Z

Closed in favour of #7

GenevieveBuckley added 14 commits August 16, 2023 15:44

cookiecutter -> copier transition

22db8c7

Remove old cookiecutter.json file

14cda53

Folder rename for copier / cookiecutter transition

ea10864

copier template

2cc65ae

Exclude unnecessary license files

c500b73

Conditionally generate files, depending on user input

4d538be

Combine cookiecutter hooks into tasks for copier to run (validate and…

53a57be

… initialize new plugin repository)

Be more careful about how we install pre-commit with pip

e5bd087

README swap cookiecutter/copier references, plus add extra links

a67ea69

Describe requirements better

3f7385c

Must use --trust for copier tasks & jinja extensions

328257e

Merge main branch

ca0f505

Add copier dependencies to requirements.txt

895f7b5

Update tests to use True/False, not 'y'/'n' in pytest parameters.

a3c196d

Merge main into copier PR

501bbe6

This was referenced Oct 27, 2023

Use copier instead of cookiecutter napari/cookiecutter-napari-plugin#165

Closed

Consider using copier instead of cookiecutter napari/napari#6122

Closed

GenevieveBuckley added 5 commits October 27, 2023 12:52

Swap pytest-cookies to pytest-copie instead for testing

3f227aa

Changeover from pytest-cookies to pytest-copie in tests

c86e011

Wrap python versions as strings in github actions, so python 3.10 is …

4df0efd

…not parsed as python 3.1

pytest-copie requires kwarg extra_answers, not extra_context like pyt…

56a19be

…est-cookies uses

Replace result.project_path with result.project_dir to adapt tests to…

d32ee29

… use pytest-copie

GenevieveBuckley added 5 commits October 30, 2023 13:49

Bug: pytest-copie does not recognise .yml extensions, only .yaml

b4075f0

Replace 'cookiecutter' refrerences with 'copier'

f06642e

Fix imports

fb50199

Update requirements

d4768bc

Only include precommit config file where user has selected install_pr…

3011259

…ecommit = True

jni and others added 5 commits May 22, 2024 23:24

typo: add missing verb

7e58a12

Co-authored-by: Draga Doncila Pop <[email protected]>

Replace default with placeholder for freeform string input

6221737

Add empty defaults

12fd445

Revert "Add empty defaults"

7111dca

This reverts commit 12fd445.

Use non-empty names in tests now that defaults are null

f42d90e

GenevieveBuckley commented May 24, 2024

View reviewed changes

template/pyproject.toml.jinja Outdated Show resolved Hide resolved

GenevieveBuckley added 3 commits May 24, 2024 10:38

Remove duplicate jinja2-time dependency from requirements.txt list

f7d9bb0

Bump ruff target python version

e54e76b

Remove unnecessary setup.cfg file, all info is in pyrpoject.toml

642f8ac

Czaki reviewed May 24, 2024

View reviewed changes

template/pyproject.toml.jinja Outdated Show resolved Hide resolved

Czaki and others added 5 commits June 6, 2024 14:53

Use dynamic version only without setuptools_scm to avoid install erro…

46fa82b

…rs (#186) Closes napari/cookiecutter-napari-plugin#185

Update aganders/headless-gui to silence nodejs warning (#188)

4502070

Do not create special case for plugins named napari-foobar (#187)

c6eed38

Co-authored-by: Juan Nunez-Iglesias <[email protected]>

Bump python versions used for CI tests (drop python 3.8, add python 3…

50317cc

….12 (#189)

GenevieveBuckley changed the base branch from main-copy to main June 7, 2024 04:54

GenevieveBuckley added 4 commits June 7, 2024 15:04

Merge main, synch with latest cookiecutter PRs

cfc5509

Ruff formatting updates for type checking

cc4838a

Ruff target python 3.9

a459ea4

Copier args plugin_name, module_name, and display_name cannot be blan…

be9de6e

…k; do not provide github URL as default

GenevieveBuckley changed the base branch from main-cookiecutter to main June 10, 2024 07:17

GenevieveBuckley added 2 commits June 10, 2024 17:32

Update ruff code formatting

0905780

fix typo

8b172df

GenevieveBuckley mentioned this pull request Jun 13, 2024

Use copier instead of cookiecutter napari/cookiecutter-napari-plugin#190

Closed

3 tasks

GenevieveBuckley closed this Jul 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use copier instead of cookiecutter #1

Use copier instead of cookiecutter #1

GenevieveBuckley commented Oct 27, 2023 •

edited

Loading

tlambert03 commented Oct 27, 2023

tlambert03 commented Oct 27, 2023 •

edited

Loading

jni commented Oct 27, 2023

jni commented May 22, 2024

jni commented May 22, 2024

GenevieveBuckley commented May 24, 2024

GenevieveBuckley commented May 24, 2024

GenevieveBuckley commented Jul 11, 2024

Use copier instead of cookiecutter #1

Use copier instead of cookiecutter #1

Conversation

GenevieveBuckley commented Oct 27, 2023 • edited Loading

Consider using copier instead of cookiecutter #6122

tlambert03 commented Oct 27, 2023

tlambert03 commented Oct 27, 2023 • edited Loading

jni commented Oct 27, 2023

jni commented May 22, 2024

jni commented May 22, 2024

GenevieveBuckley commented May 24, 2024

GenevieveBuckley commented May 24, 2024

GenevieveBuckley commented Jul 11, 2024

GenevieveBuckley commented Oct 27, 2023 •

edited

Loading

tlambert03 commented Oct 27, 2023 •

edited

Loading