Skip to main content

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 generate-config
    
  • Add or write templates

    • Add sample template
      cookiecutter-x add-samples
      
  • See a list of available simple templates

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

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

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

Read more at the documentation site - https://cookiecutter-x.shaon.dev

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cookiecutter-x-0.1.2.tar.gz (13.6 kB view hashes)

Uploaded Source

Built Distribution

cookiecutter_x-0.1.2-py3-none-any.whl (15.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page