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 »
  • Cookiecutter V2 Template Format Proposal
  • Edit on GitHub

Cookiecutter V2 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
Next

© Copyright 2017, E.R. Uber <eruber@gmail.com>. Revision 1ccb98cc.

Built with Sphinx using a theme provided by Read the Docs.
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.