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 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://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.4.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cookiecutter_x-0.1.4-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file cookiecutter-x-0.1.4.tar.gz.

File metadata

  • Download URL: cookiecutter-x-0.1.4.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for cookiecutter-x-0.1.4.tar.gz
Algorithm Hash digest
SHA256 6e4962ec322439b6f9b42c13027b42549e45e28605e70f570aa6f77de04d66a6
MD5 0eaa461768dec9be1c43b59964efa024
BLAKE2b-256 7ed1adcf9f6380b0b12d9099ba2a6ef985548301ab66d5b48aee225f01699d57

See more details on using hashes here.

File details

Details for the file cookiecutter_x-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: cookiecutter_x-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for cookiecutter_x-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d0abb9f1a9b39c67d0b51509999eceea2a81271c6c49c37ff5ad1d2e7a900197
MD5 6614809787e1bbb58b22bcaee15fc373
BLAKE2b-256 350328589ecde91bf106a183cbad01f5211685a5b7f0ead3bdf92fed06f239b9

See more details on using hashes here.

Supported by

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