Skip to main content

This contains a CLI for AWS terraform

Project description

Terraform CLI: KISS Style

Summary

This is the design and implementation of providing simple and reliable terraform (tf) commands for devs ops that build, commit and push .tf files. Terraform has hidden functionalities that devs may not be familar with. It shouldn't be the dev's responsibility to remember multiple commands every time they make a commit to terraform servers. That's why I decided to create a bash program orchestrated by python for devs to only remember a few commands.

Usage: tf [OPTIONS]

Options:
  -b, --build   Test and fmt .tf code.
  -c, --commit  Make commits to local repo.
  -p, --push    Push tf data to server.
  --clean       Clean unnecessary tf files.
  --help        Show this message and exit.

File Information

The main directory that requires attention is the src/tf directory:

  • api_methods.py - This files provides the users to see incoming messages by creating a global logger variable.

  • cli_utils.py - Creates essential utilities for cli.py that performs the system commands of the program.

  • cli.py - Bootstrap function for cli_utils.py. This file mainly interacts with the user by running the command tf and providing them [OPTIONS] -b -c -p in a pretty interface.

How do I run the Program?

NOTE : This code has only been tested on the latest Ubuntu operating system. Run on macOS at your own risk, but this program is not operational in Windows.

Running on Virtual Env (venv)

NOTE: You must have python3 installed to run these commands. Infomation about python can be found here.

Follow these instructions if you want to run the files using venv

./build.sh

# run venv 
source tf_env/bin/activate 

# use the program as intended
tf [OPTIONS]

Cleaning Virtual Env (venv) & Dependencies

./clean.sh

# exit the virtual environment 
deactivate 

Who do I talk to?

Name - Rooklyn Kline
Email - rkline2@umbc.edu

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

tf_cli-0.0.9.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file tf_cli-0.0.9.tar.gz.

File metadata

  • Download URL: tf_cli-0.0.9.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for tf_cli-0.0.9.tar.gz
Algorithm Hash digest
SHA256 48c244468efd69e7cfb95f1e3e37b893548043998ccd0352487e3c3c6a394ad9
MD5 953d5ecf5b67af0cf52abaef61ada1d5
BLAKE2b-256 34c366b8b770aa38c72d8dc771cf694ee633d0d0c37b071f95ccad31ae0d97a5

See more details on using hashes here.

Supported by

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