Cookiecutter Version 2 Template Format Proposal
Contents:
Introduction
Format Proposal
Required Metadata Template Fields
name Field
cookiecutter_version Field
variables Field
The Minium Cookiecutter Template
Optional Metadata Template Fields
description Field (Optional)
version Field (Optional)
authors Field (Optional)
license Field (Optional)
keywords Field (Optional)
url Field (Optional)
Example Cookiecutter Template
Variables Array
Required Variable Fields
Optional Variable Fields
Extra Context Overwrite Considerations
Overwrite Considerations Regarding ‘default’ & ‘choices’ Fields
Use Case #1 - Update ‘default’ field - ‘choices’ gets updated
Use Case #2 - Update ‘choices’ field - ‘default’ field gets updated
Use Case #3 - Update both ‘choices’ & ‘default’ fields
Use Case #4 - Update ‘default’ field, but its not in the ‘choices’ list
Special Overwrite Syntax for Renaming a Variable
Special Overwrite Syntax for Removing a Field from a Variable
Document Repository
Appendix
Index
Cookiecutter Version 2 Template Format Proposal
Docs
»
Index
Edit on GitHub
Index
A
|
C
|
D
|
K
|
L
|
M
|
O
|
U
|
V
A
Authors Field (Optional Metadata)
C
Cookiecutter Template Examples
Minimum
Showing All Metadata Fields
D
Description Field (Optional Metadata)
K
Keywords Field (Optional Metadata)
L
License Field (Optional Metadata)
M
Mandatory Cookiecutter Metadata Fields
Metadata - Cookiecutter Version Field
Metadata - Name Field
O
Optional Cookiecutter Metadata Fields
overwrite
choices field
default field
removing field from variable
renaming variable name
U
URL Field (Optional Metadata)
V
Variables Array Entry
Choices Field (Optional)
Default Field (Required)
Description Field (Optional)
Do_if Field (Optional)
Hide_Input Field (Optional)
If_No_Skip_To Field (Optional)
If_Yes_Skip_To Field (Optional)
Name Field (Required)
Optional Fields
Prompt Field (Optional)
Prompt_User Field (Optional)
Required Fields
Skip_If Field (Optional)
Type Field (Optional)
Validation Field (Optional)
Validation_Flags Field (Optional)
Validation_Msg Field (Optional)
Variables Array Field
Variables Array Field Section
Version Field (Optional Metadata)
Read the Docs
v: latest
Versions
latest
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.