https://github.com/drengskapur/crumbcutter

Template ONE gist file. Nothing else!
https://github.com/drengskapur/crumbcutter

automation boilerplate code-generation code-snippets cookiecutter dynamic-templates gist github python-cli setup

Last synced: 4 months ago
JSON representation

Template ONE gist file. Nothing else!

• Host: GitHub
• URL: https://github.com/drengskapur/crumbcutter
• Owner: drengskapur
• License: mit
• Created: 2023-09-20T21:34:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-27T11:29:01.000Z (over 1 year ago)
• Last Synced: 2025-02-14T06:38:27.346Z (4 months ago)
• Topics: automation, boilerplate, code-generation, code-snippets, cookiecutter, dynamic-templates, gist, github, python-cli, setup
• Language: Python
• Homepage: https://github.com/drengskapur/crumbcutter
• Size: 153 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# CrumbCutter

- Template ONE gist file.

- Nothing else!

```bash

pip install crumbcutter -U

```

```console

crumbcutter /

```

## Example Gist

![gist.png](https://imagedelivery.net/XJ_Mp6gVy44G9qfErYd3Hg/26ced78c-2754-4221-6bc6-e93871784700/public)

### crumbcutter.json

```json

{

  "project_name": "Crumbcutter Website Simple",

  "author": "Anonymous"

}

```

### index.html

```html

    

        

        {{ crumbcutter.project_name }}

    

    

        
{{ cookiecutter.project_name }}

        
by {{ crumbcutter.author }}

    


```

## Output

```sh

foo@bar:~$ crumbcutter octocat/crumbcutter-index

  [1/2] project_name (Index): My Project

  [2/2] author (Anonymous): Me

```

```bash

foo@bar:~$ cat index.html

    

        

        My Project

    

    

        
My Project

        
by Me

    


```

### TIP: Use `-x` For eXtremely Fast Rendering

```bash

foo@bar:~$ crumbcutter jonathanagustin/crumbcutter-template -x

foo@bar:~$ cat index.html

    

        

        Index

    

    

        
Index

        
by Anonymous

    


```

## Flags

```

-o, --output-dir : Directory where file will render to. Defaults to current directory.

-x, --no-input   : eXtremely fast rendering. No user input. Use default values.

-v, --verbose    : Verbose output for debugging.

```

Use [cookiecutter](https://github.com/cookiecutter/cookiecutter) to template more files or folders.