Cookiecutter eXtended
Project description
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
- Create a simple example template for generating CPP header and class pair
-
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://cookiecutter-x.shaon.dev
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cookiecutter_x-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0abb9f1a9b39c67d0b51509999eceea2a81271c6c49c37ff5ad1d2e7a900197 |
|
MD5 | 6614809787e1bbb58b22bcaee15fc373 |
|
BLAKE2b-256 | 350328589ecde91bf106a183cbad01f5211685a5b7f0ead3bdf92fed06f239b9 |