terrasnek 0.0.3

A Python client for the Terraform Cloud API

terrasnek

A Python Client for the Terraform Cloud API.

Using terrasnek

For more details on using each endpoint, checkout the test directory.

from terrasnek.api import TFC
import os

TFC_TOKEN = os.getenv("TFC_TOKEN", None)

if __name__ == "__main__":
    api = TFC(TFC_TOKEN)
    api.set_organization("YOUR_ORGANIZATION")

Contributing to terrasnek

Currently the following endpoints are supported:

Standard Endpoints

• Account
• Applies
• Configuration Versions
• Cost Estimates
• Notification Configurations
• OAuth Clients
• OAuth Tokens
• Organizations
• Organization Memberships
• Organization Tokens
• Plan Exports
• Plans
• Policies
• Policy Checks
• Policy Sets
• Policy Set Parameters
• Registry Modules
• Runs
• Run Triggers
• SSH Keys
• State Versions
• State Version Outputs
• Team Access
• Team Memberships
• Team Tokens
• Teams
• User Tokens
• Users
• Variables
• Workspaces

Admin Endpoints

• Admin Organizations
• Admin Runs
• Admin Settings
• Admin Terraform Versions
• Admin Users
• Admin Workspaces

Contributing to terrasnek

Linting the Code

make lint

Building Test Data

cd test/testdata/terraform/
tar -zcvf terrasnek_unittest_config_version.tar.gz src/*

Running Specific Tests

The test suite takes a long time to execute fully, since there is a lot of async work, and waiting for plans, applies, etc. In the scenario you want to just test a new implementation or change, use the below.

source test/secrets/secrets.sh
python3 -m unittest test/applies_test.py

Running All Tests

source test/secrets/secrets.sh
make coverage

Running the Tests with Coverage Info

source test/secrets/secrets.sh
make coverage

Publishing to PyPi

make pip-package
make pip-publish

---

Note: This repo is not officially maintained by HashiCorp.