This project is a copier template for creating Terraform projects and modules.
The copier template provided here is used to stamp out the GitHub repository template: aws-ia/terraform-repo-template.
This project template uses the copier
framework to facilitate project generation.
Copier is a Python CLI and library for rendering project templates.
In order to use this template (and copier, generally), you must first install Python, git
, and the copier
module.
- Download & Install Python 3.7+
- Download & Install Git
- Install
copier
(pip install copier
)
Note: Please refer to the official Copier documentation if you encounter difficulty here.
This project generation template can be used by first installing the pre-requisites annotated above, followed by direct usage of this repository (depending on intended usecase):
# Directly against GitHub repository using HTTPS
copier "https://github.com/aws-ia/copier-terraform-repo-template.git" target/project/path
# or directly against GitHub using the gh shortcut
copier "gh:aws-ia/copier-terraform-repo-template" target/project/path
from copier import run_auto
# Create a project from this upstream GitHub repository
run_auto("https://github.com/aws-ia/copier-terraform-repo-template.git", "target/project/pathn")
# You can also use "gh:" as a shortcut of "https://github.com/"
run_auto("gh:aws-ia/copier-terraform-repo-template", "target/project/path")
Note: Please refer to the official Copier documentation for further information on using copier
either programmatically or via the CLI here.