Skip to content

Cookiecutter eXtended is a code generator based on Jinja and Cookiecutter with some extra features.

License

Notifications You must be signed in to change notification settings

fahadshaon/cookiecutter-x

Repository files navigation

Cookiecutter-X

Cookiecutter eXtended is a code generator based on Jinja and Cookiecutter with some extra features. Such as single file generation, local template management, template documentation, provide template input using arguments instead of interactive prompts.

Installation

Like every other python package, you can install cookiecutter-x with

pip install cookiecutter-x

It will create the executable console script cookiecutter-x in the bin directory.

Templates

Cookiecutter-X supports two types of templates.

  • Simple template, optimized for generating standalone script(s), e.g. a bash script.
  • Cookiecutter template, optimized for starting a new project, e.g., a python project

Getting started quickly

  • Generate configurations (stored at $HOME/.cookiecutter-x/ccx-config.yml)

    cookiecutter-x quick-start config
  • Add or write templates

    • Create a simple example template for generating CPP header and class pair
      cookiecutter-x quick-start example-template
  • See the list of available simple templates

    cookiecutter-x simple list
  • See the documentation of a template

    cookiecutter-x simple doc cpp
  • Generate files based on a template

    cookiecutter-x simple process cpp --class_name 'FilesUtils'

Read more at the documentation site - https://fahadshaon.github.io/cookiecutter-x

About

Cookiecutter eXtended is a code generator based on Jinja and Cookiecutter with some extra features.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published