Skip to main content

Terraform developer tool to extract variables and create variables.tf files.

Project description

scratch relax tv

Terraform module development tool.

  1. Extract variables from main.tf and create variables.tf files
  2. Create a module use stub from a variables.tf file
  3. Delete extra scratchrelaxtv files

simply

pip install scratchrelaxtv

In a directory with a main.tf file, run scratchrelaxtv:

$ ls
main.tf
$ scratchrelaxtv
$ ls
main.tf			variables.tf

details

variables.tf

By default, it looks for main.tf and will keep variables in the resulting variables.tf in the order found in the main.tf. If variables are included more than once, they will only be listed once in the resulting variables.tf. If you do not --force overwriting, scratchrelaxtv will create new variables.tf files with each run: variables.1.tf, variables.2.tf and so on.

modstub.tf

scratchrelaxtv can also be used to generate a module usage stub. By default, it looks for variables.tf and will keep variables in the resulting modstub.tf in the order found in the variables.tf. If variables are included more than once, they will only be listed once in the resulting modstub.tf. If you do not --force overwriting, scratchrelaxtv will create new modstub.tf files with each run: modstub.1.tf, modstub.2.tf and so on.

remove files

scratchrelaxtv can also tidy up your directories by removing its own extra generated files. Presumably it will only remove files you no longer need but be careful. This chart shows examples of what would be deleted or not.

scratchrelaxtv removes files in the current directory and subdirectories.

Filename Deleted?
variables.tf no
modstub.tf yes
modstub.1.tf yes
variables.1.tf yes
xyz.abc no
variables.a.tf no
variables.43.tf yes
modstub no
modstub..tf no

help

scratchrelaxtv includes help:

$ scratchrelaxtv --help
usage: scratchrelaxtv [-h] [-i INPUT] [-o OUTPUT] [-f] [-m] [-n MODNAME] [-r]
                      [-a | -d]

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        file to extract vars from
  -o OUTPUT, --output OUTPUT
                        file to write extracted vars to
  -f, --force           overwrite existing out file
  -m, --modstub         create module usage stub
  -n MODNAME, --modname MODNAME
                        name to use in module stub
  -r, --remove          remove all modstub.tf and variables.x.tf files
  -a, --asc             sort output variables in ascending order
  -d, --desc            sort output variables in descending order

CHANGE LOG

0.2.1 - 2019.04.25

  • Fix inconsequential error thrown when removing files

0.2.0 - 2019.04.25

  • Add capability to delete extra working files

0.1.3 - 2019.04.17

  • Add module stub capability

0.1.2 - 2019.04.17

  • Add simple docs

0.1.1 - 2019.04.16

  • Initial working version

0.1.0 - 2019.04.15

  • Initial release!

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

scratchrelaxtv-0.2.1.tar.gz (23.6 kB view hashes)

Uploaded Source

Built Distribution

scratchrelaxtv-0.2.1-py2.py3-none-any.whl (18.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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