https://github.com/aws-ia/copier-terraform-repo-template
https://github.com/aws-ia/copier-terraform-repo-template
copier-template
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/aws-ia/copier-terraform-repo-template
- Owner: aws-ia
- License: apache-2.0
- Created: 2022-06-22T16:17:00.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-07T20:24:31.000Z (almost 3 years ago)
- Last Synced: 2025-01-16T03:16:42.411Z (3 months ago)
- Topics: copier-template
- Language: Jinja
- Homepage:
- Size: 22.5 KB
- Stars: 13
- Watchers: 10
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - aws-ia/copier-terraform-repo-template - (Jinja)
README
# Copier Terraform Module
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](https://github.com/aws-ia/terraform-repo-template).
## Prerequisites
This project template uses the [`copier`](https://github.com/copier-org/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+](https://www.python.org/downloads/)
- [Download & Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Install `copier`](https://copier.readthedocs.io/en/stable/#installation) (`pip install copier`)
_Note: Please refer to the official Copier documentation if you encounter difficulty [here](https://copier.readthedocs.io/en/stable/#installation)._
## Usage
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):
### CLI
```bash
# 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
```
### Programmatically (Python)
```python
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](https://copier.readthedocs.io/en/stable/#quick-start)._