Skip to main content

THipster is a tool dedicated to simplifying the difficulty associated with writing Terraform files. It allows users to write infrastructure as code in a simplified format, using either YAML (with JINJA) or the dedicated Thipster DSL.

Project description

THipster

THipster is a tool dedicated to simplifying the difficulty associated with writing Terraform files. It allows users to write infrastructure as code in a simplified format, using either YAML (with JINJA) or the dedicated Thipster DSL.

Written entirely in Python, it leverages the Python CDK for Terraform to create Terraform files and apply them to the chosen provider.

License Read the docs documentation Package version Supported Python versions Ruff

Technology Stack

Written in Python 3.11, thipster is designed as a python package, to be used either as a standalone tool, or as a module inside a running process like a CI/CD pipeline.

Project Status

THipster is currently in an active development state. If you want to know more, please check the CHANGELOG for more details.

Dependencies

In order to user THipster, you will need to have the following installed:

Installation

To use THipster, you can simply install the package with pip:

pip install thipster

If you want to install the google dependencies aswell use

pip install thipster[google]

The list of available versions can be found on PyPI.

Usage

You can use THipster in two ways:

Main feature:

  • Generate Terraform files from a YAML+JINJA or THIPS file:
from thipster import Engine as ThipsterEngine
from thipster.auth import Google
from thipster.parser import ParserFactory
from thipster.repository import GithubRepo
from thipster.terraform import Terraform

# create new THipster engine
engine = ThipsterEngine(ParserFactory(), GithubRepo('THipster/models'), Google, Terraform())

# generate Terraform files and plan from a YAML+JINJA file
terraform_plan = engine.run('path/to/file/or/directory')
print(terraform_plan)

How to test the software

To run the tests, you can use the following command:

pip install -e .[test]
pytest tests

Known issues

All known issues, bugs, and feature requests are tracked in the Issue tracker.

Getting help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue tracker.

Getting involved

To install the project for development, you can use the following command:

pip install -r requirements.txt && pip install -e .[dev,test,doc,google]
pre-commit install && pre-commit run --all-files

For more information on how to help out, please check the CONTRIBUTING file.

Open source licensing info

  1. LICENSE
  2. CFPB Source Code Policy

Credits and references

  1. Projects that inspired you
  2. Related projects

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

thipster-0.22.0.tar.gz (49.0 kB view details)

Uploaded Source

Built Distribution

thipster-0.22.0-py3-none-any.whl (62.8 kB view details)

Uploaded Python 3

File details

Details for the file thipster-0.22.0.tar.gz.

File metadata

  • Download URL: thipster-0.22.0.tar.gz
  • Upload date:
  • Size: 49.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/40.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.3 tqdm/4.65.0 importlib-metadata/6.7.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.12

File hashes

Hashes for thipster-0.22.0.tar.gz
Algorithm Hash digest
SHA256 dafd4be3c983c75f619480b3bb778bc2c007f5365099a4bb3ad252cccd3a6bfa
MD5 d8490941f92e2b2222233fe76902d518
BLAKE2b-256 b30c9478b45a86ad24b4c1c9e1b77d64d8276904a8a6f44fbc53c1bc3e31ff72

See more details on using hashes here.

File details

Details for the file thipster-0.22.0-py3-none-any.whl.

File metadata

  • Download URL: thipster-0.22.0-py3-none-any.whl
  • Upload date:
  • Size: 62.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/40.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.3 tqdm/4.65.0 importlib-metadata/6.7.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.12

File hashes

Hashes for thipster-0.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a77aa84045e96b9ec9a8530a1990a690e6466acc0cd22ca6425c399db989977
MD5 6867c6366489c8697daed819f8101f33
BLAKE2b-256 f718fa92ab5632e6a842fb52ebdb67e9f747af8d81bf82b280284e81e3ba1f51

See more details on using hashes here.

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