terrasnek 0.0.5

A Python client for the Terraform Cloud API

terrasnek

A Python Client for the Terraform Cloud API.

---

Overview

The goal of this project is to support all endpoints available in the Terraform Cloud API. It's possible that some of these endpoints won't work if you're working against an older version of Terraform Enterprise. terrasnek has been tested against TFE v202002-2 (419) and is subject to this stability policy.

Note: Terraform Enterprise is the self-hosted distribution of Terraform Cloud. It offers enterprises a private instance of the Terraform Cloud application, with no resource limits and with additional enterprise-grade architectural features like audit logging and SAML single sign-on.

Requirements

To make full usage of all the tools and commands here, you should have installed:

• ag
• coverage
• make
• pylint
• python3

All Python requirements are outlined in pip-reqs.txt.

Using terrasnek

For more details on using each endpoint, check out the docs or the test directory. I also wrote a blog post showing how this library can be used.

from terrasnek.api import TFC
import os

TFC_TOKEN = os.getenv("TFC_TOKEN", None)
TFC_URL = os.getenv("TFC_URL", None)  # ex: https://app.terraform.io
SSL_VERIFY = os.getenv("SSL_VERIFY", None)  # set to True if you want to use HTTP or insecure HTTPS

if __name__ == "__main__":
    api = TFC(TFC_TOKEN, url=TFC_URL, ssl_verify=SSL_VERIFY)
    api.set_org("YOUR_ORGANIZATION")

terrasnek to Terraform Cloud API Spec Parity

To see the feature parity between the Terraform Cloud API spec and the available methods in terrasnek, view the auto-generated API_COMPARISON.md file.

terrasnek Common Use Case Examples

See the terrasnek documentation.

Contributing to terrasnek

If you'd like to contribute to terrasnek, review CONTRIBUTING.md.

---

Note: This repo is not officially maintained by HashiCorp.