1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
|
%global _empty_manifest_terminate_build 0
Name: python-cruft
Version: 2.14.0
Release: 1
Summary: Allows you to maintain all the necessary cruft for packaging and building projects separate from the code you intentionally write. Built on-top of CookieCutter.
License: MIT
URL: https://pypi.org/project/cruft/
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/fb/ee/074d2116f87048955dbba663d769f9a16108c3c88a9cd667e87c3c4bb4ad/cruft-2.14.0.tar.gz
BuildArch: noarch
Requires: python3-cookiecutter
Requires: python3-gitpython
Requires: python3-toml
Requires: python3-typer
Requires: python3-click
Requires: python3-importlib-metadata
%description
[](https://cruft.github.io/cruft/)
_________________
[](http://badge.fury.io/py/cruft)
[](https://anaconda.org/conda-forge/cruft)
[](https://github.com/cruft/cruft/actions?query=workflow%3A%22Run+tests%22+branch%3Amaster)
[](https://codecov.io/gh/cruft/cruft)
[](https://github.com/psf/black)
[](https://timothycrosley.github.io/isort/)
[](https://gitter.im/cruft/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://pypi.python.org/pypi/cruft/)
[](https://pepy.tech/project/cruft)
#### Trending Contributors
[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/0)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/1)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/2)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/3)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/4)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/5)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/6)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/7)
_________________
[Read Latest Documentation](https://cruft.github.io/cruft/) - [Browse GitHub Code Repository](https://github.com/cruft/cruft/)
_________________
**cruft** allows you to maintain all the necessary boilerplate for packaging and building projects separate from the code you intentionally write.
Fully compatible with existing [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templates.
Creating new projects from templates using cruft is easy:
And, so is updating them as the template changes overtime:
Many project template utilities exist that automate the copying and pasting of code to create new projects. This *seems* great! However, once created, most leave you with that copy-and-pasted code to manage through the life of your project.
cruft is different. It automates the creation of new projects like the others, but then it also helps you to manage the boilerplate through the life of the project. cruft makes sure your code stays in-sync with the template it came from for you.
## Key Features:
* **Cookiecutter Compatible**: cruft utilizes [Cookiecutter](https://github.com/cookiecutter/cookiecutter) as its template expansion engine. Meaning it retains full compatibility with all existing [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templates.
* **Template Validation**: cruft can quickly validate whether or not a project is using the latest version of a template using `cruft check`. This check can easily be added to CI pipelines to ensure your projects stay in-sync.
* **Automatic Template Updates**: cruft automates the process of updating code to match the latest version of a template, making it easy to utilize template improvements across many projects.
## Installation:
To get started - install `cruft` using a Python package manager:
`pip3 install cruft`
OR
`poetry add cruft`
OR
`pipenv install cruft`
## Creating a New Project:
To create a new project using cruft run `cruft create PROJECT_URL` from the command line.
For example:
cruft create https://github.com/timothycrosley/cookiecutter-python/
cruft will then ask you any necessary questions to create your new project. It will use your answers to expand the provided template, and then return the directory it placed the expanded project.
Behind the scenes, cruft uses [Cookiecutter](https://github.com/cookiecutter/cookiecutter) to do the project expansion. The only difference in the resulting output is a `.cruft.json` file that
contains the git hash of the template used as well as the parameters specified.
## Updating a Project
To update an existing project, that was created using cruft, run `cruft update` in the root of the project.
If there are any updates, cruft will have you review them before applying. If you accept the changes cruft will apply them to your project
and update the `.cruft.json` file for you.
!!! tip
Sometimes certain files just aren't good fits for updating. Such as test cases or `__init__` files. You can tell cruft to always skip updating these files on a project by generating project with `--skip cruft/__init__.py --skip tests` arguments or manually adding them to a skip section within your `.cruft.json` file:
{
"template": "https://github.com/timothycrosley/cookiecutter-python",
"commit": "8a65a360d51250221193ed0ec5ed292e72b32b0b",
"skip": [
"cruft/__init__.py",
"tests"
],
...
}
Or, if you have toml installed, you can add skip files directly to a `tool.cruft` section of your `pyproject.toml` file:
[tool.cruft]
skip = ["cruft/__init__.py", "tests"]
Note that it is possible to use glob patterns for selecting the files to skip:
{
"skip": [
"**/__init__.py",
"tests/*"
],
...
}
## Checking a Project
Checking to see if a project is missing a template update is as easy as running `cruft check`. If the project is out-of-date an error and exit code 1 will be returned.
`cruft check` can be added to CI pipelines to ensure projects don't unintentionally drift.
## Linking an Existing Project
Have an existing project that you created from a template in the past using Cookiecutter directly? You can link it to the template that was used to create it using: `cruft link TEMPLATE_REPOSITORY`.
For example:
cruft link https://github.com/timothycrosley/cookiecutter-python/
You can then specify the last commit of the template the project has been updated to be consistent with, or accept the default of using the latest commit from the template.
## Compute the diff
With time, your boilerplate may end up being very different from the actual cookiecutter template. Cruft allows you to quickly see what changed in your local project compared to the template. It is as easy as running `cruft diff`. If any local file differs from the template, the diff will appear in your terminal in a similar fashion to `git diff`.
The `cruft diff` command optionally accepts an `--exit-code` flag that will make cruft exit with a non-0 code should any diff is found. You can combine this flag with the `skip` section of your `.cruft.json` to make stricter CI checks that ensures any improvement to the template is always submitted upstream.
## Automating updates with GitHub Actions
If you have many repositories to manage, you can automate the change detection process with GitHub Actions. This example runs every Monday at 2am UTC and creates a new pull request if there are changes detected which a maintainer can accept or reject. It creates two PRs - one to pull in the new files to the repository and one to update the `.cruft.json` file only, which has the effect of rejecting the change from the upstream repository.
> Since Jan 2022, registries/organisations must explicitly grant the authority to create a pull request. This can be enabled on a per-organisation level, or a per-registry level for personal projects. See [GitHub](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) for more details.
```yaml
# /.github/workflows/cruft-update.yml
name: Update repository with Cruft
permissions:
contents: write
pull-requests: write
on:
schedule:
- cron: "0 2 * * 1" # Every Monday at 2am
jobs:
update:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
include:
- add-paths: .
body: Use this to merge the changes to this repository.
branch: cruft/update
commit-message: "chore: accept new Cruft update"
title: New updates detected with Cruft
- add-paths: .cruft.json
body: Use this to reject the changes in this repository.
branch: cruft/reject
commit-message: "chore: reject new Cruft update"
title: Reject new updates detected with Cruft
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install Cruft
run: pip3 install cruft
- name: Check if update is available
continue-on-error: false
id: check
run: |
CHANGES=0
if [ -f .cruft.json ]; then
if ! cruft check; then
CHANGES=1
fi
else
echo "No .cruft.json file"
fi
echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT"
- name: Run update if available
if: steps.check.outputs.has_changes == '1'
run: |
git config --global user.email "you@example.com"
git config --global user.name "GitHub"
cruft update --skip-apply-ask --refresh-private-variables
git restore --staged .
- name: Create pull request
if: steps.check.outputs.has_changes == '1'
uses: peter-evans/create-pull-request@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
add-paths: ${{ matrix.add-paths }}
commit-message: ${{ matrix.commit-message }}
branch: ${{ matrix.branch }}
delete-branch: true
branch-suffix: timestamp
title: ${{ matrix.title }}
body: |
This is an autogenerated PR. ${{ matrix.body }}
[Cruft](https://cruft.github.io/cruft/) has detected updates from the Cookiecutter repository.
```
## Why Create cruft?
Since I first saw videos of [quickly](https://www.youtube.com/watch?v=9EctXzH2dss) being used to automate Ubuntu application creation, I've had a love/hate relationship with these kinds of tools.
I've used them for many projects and certainly seen them lead to productivity improvements. However, I've always felt like they were a double-edged sword. Sure, they would automate away the copying and pasting many would do to create projects. However, by doing so,
they encouraged more code to be copied and pasted! Then, over time, you could easily be left with hundreds of projects that contained copy-and-pasted code with no way to easy way to update them. I created cruft to be a tool that recognized that balance between project creation and maintenance and provided mechanisms to keep built projects up-to-date.
I hope you too find `cruft` useful!
~Timothy Crosley
%package -n python3-cruft
Summary: Allows you to maintain all the necessary cruft for packaging and building projects separate from the code you intentionally write. Built on-top of CookieCutter.
Provides: python-cruft
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-cruft
[](https://cruft.github.io/cruft/)
_________________
[](http://badge.fury.io/py/cruft)
[](https://anaconda.org/conda-forge/cruft)
[](https://github.com/cruft/cruft/actions?query=workflow%3A%22Run+tests%22+branch%3Amaster)
[](https://codecov.io/gh/cruft/cruft)
[](https://github.com/psf/black)
[](https://timothycrosley.github.io/isort/)
[](https://gitter.im/cruft/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://pypi.python.org/pypi/cruft/)
[](https://pepy.tech/project/cruft)
#### Trending Contributors
[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/0)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/1)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/2)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/3)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/4)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/5)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/6)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/7)
_________________
[Read Latest Documentation](https://cruft.github.io/cruft/) - [Browse GitHub Code Repository](https://github.com/cruft/cruft/)
_________________
**cruft** allows you to maintain all the necessary boilerplate for packaging and building projects separate from the code you intentionally write.
Fully compatible with existing [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templates.
Creating new projects from templates using cruft is easy:
And, so is updating them as the template changes overtime:
Many project template utilities exist that automate the copying and pasting of code to create new projects. This *seems* great! However, once created, most leave you with that copy-and-pasted code to manage through the life of your project.
cruft is different. It automates the creation of new projects like the others, but then it also helps you to manage the boilerplate through the life of the project. cruft makes sure your code stays in-sync with the template it came from for you.
## Key Features:
* **Cookiecutter Compatible**: cruft utilizes [Cookiecutter](https://github.com/cookiecutter/cookiecutter) as its template expansion engine. Meaning it retains full compatibility with all existing [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templates.
* **Template Validation**: cruft can quickly validate whether or not a project is using the latest version of a template using `cruft check`. This check can easily be added to CI pipelines to ensure your projects stay in-sync.
* **Automatic Template Updates**: cruft automates the process of updating code to match the latest version of a template, making it easy to utilize template improvements across many projects.
## Installation:
To get started - install `cruft` using a Python package manager:
`pip3 install cruft`
OR
`poetry add cruft`
OR
`pipenv install cruft`
## Creating a New Project:
To create a new project using cruft run `cruft create PROJECT_URL` from the command line.
For example:
cruft create https://github.com/timothycrosley/cookiecutter-python/
cruft will then ask you any necessary questions to create your new project. It will use your answers to expand the provided template, and then return the directory it placed the expanded project.
Behind the scenes, cruft uses [Cookiecutter](https://github.com/cookiecutter/cookiecutter) to do the project expansion. The only difference in the resulting output is a `.cruft.json` file that
contains the git hash of the template used as well as the parameters specified.
## Updating a Project
To update an existing project, that was created using cruft, run `cruft update` in the root of the project.
If there are any updates, cruft will have you review them before applying. If you accept the changes cruft will apply them to your project
and update the `.cruft.json` file for you.
!!! tip
Sometimes certain files just aren't good fits for updating. Such as test cases or `__init__` files. You can tell cruft to always skip updating these files on a project by generating project with `--skip cruft/__init__.py --skip tests` arguments or manually adding them to a skip section within your `.cruft.json` file:
{
"template": "https://github.com/timothycrosley/cookiecutter-python",
"commit": "8a65a360d51250221193ed0ec5ed292e72b32b0b",
"skip": [
"cruft/__init__.py",
"tests"
],
...
}
Or, if you have toml installed, you can add skip files directly to a `tool.cruft` section of your `pyproject.toml` file:
[tool.cruft]
skip = ["cruft/__init__.py", "tests"]
Note that it is possible to use glob patterns for selecting the files to skip:
{
"skip": [
"**/__init__.py",
"tests/*"
],
...
}
## Checking a Project
Checking to see if a project is missing a template update is as easy as running `cruft check`. If the project is out-of-date an error and exit code 1 will be returned.
`cruft check` can be added to CI pipelines to ensure projects don't unintentionally drift.
## Linking an Existing Project
Have an existing project that you created from a template in the past using Cookiecutter directly? You can link it to the template that was used to create it using: `cruft link TEMPLATE_REPOSITORY`.
For example:
cruft link https://github.com/timothycrosley/cookiecutter-python/
You can then specify the last commit of the template the project has been updated to be consistent with, or accept the default of using the latest commit from the template.
## Compute the diff
With time, your boilerplate may end up being very different from the actual cookiecutter template. Cruft allows you to quickly see what changed in your local project compared to the template. It is as easy as running `cruft diff`. If any local file differs from the template, the diff will appear in your terminal in a similar fashion to `git diff`.
The `cruft diff` command optionally accepts an `--exit-code` flag that will make cruft exit with a non-0 code should any diff is found. You can combine this flag with the `skip` section of your `.cruft.json` to make stricter CI checks that ensures any improvement to the template is always submitted upstream.
## Automating updates with GitHub Actions
If you have many repositories to manage, you can automate the change detection process with GitHub Actions. This example runs every Monday at 2am UTC and creates a new pull request if there are changes detected which a maintainer can accept or reject. It creates two PRs - one to pull in the new files to the repository and one to update the `.cruft.json` file only, which has the effect of rejecting the change from the upstream repository.
> Since Jan 2022, registries/organisations must explicitly grant the authority to create a pull request. This can be enabled on a per-organisation level, or a per-registry level for personal projects. See [GitHub](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) for more details.
```yaml
# /.github/workflows/cruft-update.yml
name: Update repository with Cruft
permissions:
contents: write
pull-requests: write
on:
schedule:
- cron: "0 2 * * 1" # Every Monday at 2am
jobs:
update:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
include:
- add-paths: .
body: Use this to merge the changes to this repository.
branch: cruft/update
commit-message: "chore: accept new Cruft update"
title: New updates detected with Cruft
- add-paths: .cruft.json
body: Use this to reject the changes in this repository.
branch: cruft/reject
commit-message: "chore: reject new Cruft update"
title: Reject new updates detected with Cruft
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install Cruft
run: pip3 install cruft
- name: Check if update is available
continue-on-error: false
id: check
run: |
CHANGES=0
if [ -f .cruft.json ]; then
if ! cruft check; then
CHANGES=1
fi
else
echo "No .cruft.json file"
fi
echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT"
- name: Run update if available
if: steps.check.outputs.has_changes == '1'
run: |
git config --global user.email "you@example.com"
git config --global user.name "GitHub"
cruft update --skip-apply-ask --refresh-private-variables
git restore --staged .
- name: Create pull request
if: steps.check.outputs.has_changes == '1'
uses: peter-evans/create-pull-request@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
add-paths: ${{ matrix.add-paths }}
commit-message: ${{ matrix.commit-message }}
branch: ${{ matrix.branch }}
delete-branch: true
branch-suffix: timestamp
title: ${{ matrix.title }}
body: |
This is an autogenerated PR. ${{ matrix.body }}
[Cruft](https://cruft.github.io/cruft/) has detected updates from the Cookiecutter repository.
```
## Why Create cruft?
Since I first saw videos of [quickly](https://www.youtube.com/watch?v=9EctXzH2dss) being used to automate Ubuntu application creation, I've had a love/hate relationship with these kinds of tools.
I've used them for many projects and certainly seen them lead to productivity improvements. However, I've always felt like they were a double-edged sword. Sure, they would automate away the copying and pasting many would do to create projects. However, by doing so,
they encouraged more code to be copied and pasted! Then, over time, you could easily be left with hundreds of projects that contained copy-and-pasted code with no way to easy way to update them. I created cruft to be a tool that recognized that balance between project creation and maintenance and provided mechanisms to keep built projects up-to-date.
I hope you too find `cruft` useful!
~Timothy Crosley
%package help
Summary: Development documents and examples for cruft
Provides: python3-cruft-doc
%description help
[](https://cruft.github.io/cruft/)
_________________
[](http://badge.fury.io/py/cruft)
[](https://anaconda.org/conda-forge/cruft)
[](https://github.com/cruft/cruft/actions?query=workflow%3A%22Run+tests%22+branch%3Amaster)
[](https://codecov.io/gh/cruft/cruft)
[](https://github.com/psf/black)
[](https://timothycrosley.github.io/isort/)
[](https://gitter.im/cruft/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://pypi.python.org/pypi/cruft/)
[](https://pepy.tech/project/cruft)
#### Trending Contributors
[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/0)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/1)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/2)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/3)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/4)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/5)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/6)[](https://sourcerer.io/fame/samj1912/cruft/cruft/links/7)
_________________
[Read Latest Documentation](https://cruft.github.io/cruft/) - [Browse GitHub Code Repository](https://github.com/cruft/cruft/)
_________________
**cruft** allows you to maintain all the necessary boilerplate for packaging and building projects separate from the code you intentionally write.
Fully compatible with existing [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templates.
Creating new projects from templates using cruft is easy:
And, so is updating them as the template changes overtime:
Many project template utilities exist that automate the copying and pasting of code to create new projects. This *seems* great! However, once created, most leave you with that copy-and-pasted code to manage through the life of your project.
cruft is different. It automates the creation of new projects like the others, but then it also helps you to manage the boilerplate through the life of the project. cruft makes sure your code stays in-sync with the template it came from for you.
## Key Features:
* **Cookiecutter Compatible**: cruft utilizes [Cookiecutter](https://github.com/cookiecutter/cookiecutter) as its template expansion engine. Meaning it retains full compatibility with all existing [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templates.
* **Template Validation**: cruft can quickly validate whether or not a project is using the latest version of a template using `cruft check`. This check can easily be added to CI pipelines to ensure your projects stay in-sync.
* **Automatic Template Updates**: cruft automates the process of updating code to match the latest version of a template, making it easy to utilize template improvements across many projects.
## Installation:
To get started - install `cruft` using a Python package manager:
`pip3 install cruft`
OR
`poetry add cruft`
OR
`pipenv install cruft`
## Creating a New Project:
To create a new project using cruft run `cruft create PROJECT_URL` from the command line.
For example:
cruft create https://github.com/timothycrosley/cookiecutter-python/
cruft will then ask you any necessary questions to create your new project. It will use your answers to expand the provided template, and then return the directory it placed the expanded project.
Behind the scenes, cruft uses [Cookiecutter](https://github.com/cookiecutter/cookiecutter) to do the project expansion. The only difference in the resulting output is a `.cruft.json` file that
contains the git hash of the template used as well as the parameters specified.
## Updating a Project
To update an existing project, that was created using cruft, run `cruft update` in the root of the project.
If there are any updates, cruft will have you review them before applying. If you accept the changes cruft will apply them to your project
and update the `.cruft.json` file for you.
!!! tip
Sometimes certain files just aren't good fits for updating. Such as test cases or `__init__` files. You can tell cruft to always skip updating these files on a project by generating project with `--skip cruft/__init__.py --skip tests` arguments or manually adding them to a skip section within your `.cruft.json` file:
{
"template": "https://github.com/timothycrosley/cookiecutter-python",
"commit": "8a65a360d51250221193ed0ec5ed292e72b32b0b",
"skip": [
"cruft/__init__.py",
"tests"
],
...
}
Or, if you have toml installed, you can add skip files directly to a `tool.cruft` section of your `pyproject.toml` file:
[tool.cruft]
skip = ["cruft/__init__.py", "tests"]
Note that it is possible to use glob patterns for selecting the files to skip:
{
"skip": [
"**/__init__.py",
"tests/*"
],
...
}
## Checking a Project
Checking to see if a project is missing a template update is as easy as running `cruft check`. If the project is out-of-date an error and exit code 1 will be returned.
`cruft check` can be added to CI pipelines to ensure projects don't unintentionally drift.
## Linking an Existing Project
Have an existing project that you created from a template in the past using Cookiecutter directly? You can link it to the template that was used to create it using: `cruft link TEMPLATE_REPOSITORY`.
For example:
cruft link https://github.com/timothycrosley/cookiecutter-python/
You can then specify the last commit of the template the project has been updated to be consistent with, or accept the default of using the latest commit from the template.
## Compute the diff
With time, your boilerplate may end up being very different from the actual cookiecutter template. Cruft allows you to quickly see what changed in your local project compared to the template. It is as easy as running `cruft diff`. If any local file differs from the template, the diff will appear in your terminal in a similar fashion to `git diff`.
The `cruft diff` command optionally accepts an `--exit-code` flag that will make cruft exit with a non-0 code should any diff is found. You can combine this flag with the `skip` section of your `.cruft.json` to make stricter CI checks that ensures any improvement to the template is always submitted upstream.
## Automating updates with GitHub Actions
If you have many repositories to manage, you can automate the change detection process with GitHub Actions. This example runs every Monday at 2am UTC and creates a new pull request if there are changes detected which a maintainer can accept or reject. It creates two PRs - one to pull in the new files to the repository and one to update the `.cruft.json` file only, which has the effect of rejecting the change from the upstream repository.
> Since Jan 2022, registries/organisations must explicitly grant the authority to create a pull request. This can be enabled on a per-organisation level, or a per-registry level for personal projects. See [GitHub](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) for more details.
```yaml
# /.github/workflows/cruft-update.yml
name: Update repository with Cruft
permissions:
contents: write
pull-requests: write
on:
schedule:
- cron: "0 2 * * 1" # Every Monday at 2am
jobs:
update:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
include:
- add-paths: .
body: Use this to merge the changes to this repository.
branch: cruft/update
commit-message: "chore: accept new Cruft update"
title: New updates detected with Cruft
- add-paths: .cruft.json
body: Use this to reject the changes in this repository.
branch: cruft/reject
commit-message: "chore: reject new Cruft update"
title: Reject new updates detected with Cruft
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install Cruft
run: pip3 install cruft
- name: Check if update is available
continue-on-error: false
id: check
run: |
CHANGES=0
if [ -f .cruft.json ]; then
if ! cruft check; then
CHANGES=1
fi
else
echo "No .cruft.json file"
fi
echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT"
- name: Run update if available
if: steps.check.outputs.has_changes == '1'
run: |
git config --global user.email "you@example.com"
git config --global user.name "GitHub"
cruft update --skip-apply-ask --refresh-private-variables
git restore --staged .
- name: Create pull request
if: steps.check.outputs.has_changes == '1'
uses: peter-evans/create-pull-request@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
add-paths: ${{ matrix.add-paths }}
commit-message: ${{ matrix.commit-message }}
branch: ${{ matrix.branch }}
delete-branch: true
branch-suffix: timestamp
title: ${{ matrix.title }}
body: |
This is an autogenerated PR. ${{ matrix.body }}
[Cruft](https://cruft.github.io/cruft/) has detected updates from the Cookiecutter repository.
```
## Why Create cruft?
Since I first saw videos of [quickly](https://www.youtube.com/watch?v=9EctXzH2dss) being used to automate Ubuntu application creation, I've had a love/hate relationship with these kinds of tools.
I've used them for many projects and certainly seen them lead to productivity improvements. However, I've always felt like they were a double-edged sword. Sure, they would automate away the copying and pasting many would do to create projects. However, by doing so,
they encouraged more code to be copied and pasted! Then, over time, you could easily be left with hundreds of projects that contained copy-and-pasted code with no way to easy way to update them. I created cruft to be a tool that recognized that balance between project creation and maintenance and provided mechanisms to keep built projects up-to-date.
I hope you too find `cruft` useful!
~Timothy Crosley
%prep
%autosetup -n cruft-2.14.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-cruft -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 2.14.0-1
- Package Spec generated
|
