py-templater

About this Project

Python utility tool that generates code files from user-defined templates. Save files/directories and user-defined templates, and load them on the fly whenever you need access to your boilerplate templates.

Getting Started

Prerequisites

You will need typer and rich in order to use py-templater. These should install as dependencies by default.

pip install py-templater typer rich

⚠️ Warning
py-templater only works on Linux and macOS machines

Usage

templater --help
                                                                                                                   
  Usage: templater [OPTIONS] COMMAND [ARGS]...                                                                      
                                                                                                                   
Options
  --install-completion          Install completion for the current shell.                                        
  --show-completion             Show completion for the current shell, to copy it or customize the installation.
  --help                        Show this message and exit.

Commands
  add       Add a new template
  gen       Generates file(s) from templates
  list      List current current templates
  rm        Delete a template
  view      View template head

add

Allows user to define a file/directory as new template

templater add --help

  Usage: templater add [OPTIONS] NAME PATH

Arguments
  name      template name
  path      path to original file/directory

gen

Generates any user defined templates in the current working directory

templater gen --help

  Usage: templater gen [OPTIONS] NAME

Arguments
  name      template name

list

Lists all user-defined templates and corresponding metadata

templater list --help
  
  Usage: templater list [OPTIONS]

rm

Allows user to delete any user-defined templates

templater rm --help

  Usage: templater rm [OPTIONS]

view

Views head snippet of template

templater view --help

  Usage: templater view [OPTIONS] NAME [N]

Arguments
  name      template name
  n         (default: 5) numbers of lines to show