State version upload

CHANGELOG.md

@@ -1,6 +1,15 @@
 # Unreleased
 
+
 # Released
+# v1.0.0
+
+## Features
+
+### Explorer API
+* Added Explorer resource support with query, CSV export, saved view CRUD, saved view result query, and saved view CSV export endpoints.
+
+
 # v0.1.5
 
 * `pytfe.__version__` added in src/pytfe/init.py via importlib.metadata.version("pytfe"). This will resolve to the version from pyproject.toml.

examples/comment.py

@@ -0,0 +1,72 @@
+# Copyright IBM Corp. 2025, 2026
+# SPDX-License-Identifier: MPL-2.0
+
+from __future__ import annotations
+
+import argparse
+import os
+
+from pytfe import TFEClient, TFEConfig
+from pytfe.models import CommentCreateOptions
+
+
+def _print_header(title: str):
+    print("\n" + "=" * 80)
+    print(title)
+    print("=" * 80)
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Comments demo for python-tfe SDK")
+    parser.add_argument(
+        "--address", default=os.getenv("TFE_ADDRESS", "https://app.terraform.io")
+    )
+    parser.add_argument("--token", default=os.getenv("TFE_TOKEN", ""))
+    parser.add_argument("--run-id", required=True, help="Run ID (e.g. run-xxxxx)")
+    parser.add_argument("--create", action="store_true", help="Create a new comment")
+    parser.add_argument("--body", help="Comment body text (required with --create)")
+    parser.add_argument("--read", action="store_true", help="Read a specific comment")
+    parser.add_argument("--id", help="Comment ID (e.g. com-xxxxx), required for --read")
+    args = parser.parse_args()
+
+    cfg = TFEConfig(address=args.address, token=args.token)
+    client = TFEClient(cfg)
+
+    # 1) Always list existing comments for the run
+    _print_header(f"Listing comments for run: {args.run_id}")
+    comment_count = 0
+    for comment in client.comments.list(run_id=args.run_id):
+        comment_count += 1
+        print(f"- ID: {comment.id}")
+        print(f"  Body: {comment.body}")
+        print()
+
+    if comment_count == 0:
+        print("No comments found.")
+    else:
+        print(f"Total: {comment_count} comments")
+
+    # 2) Create a new comment
+    if args.create:
+        if not args.body:
+            print("--body is required for --create")
+        else:
+            _print_header(f"Creating a comment on run: {args.run_id}")
+            opts = CommentCreateOptions(body=args.body)
+            comment = client.comments.create(run_id=args.run_id, options=opts)
+            print(f"Created comment: {comment.id}")
+            print(f"  Body: {comment.body}")
+
+    # 3) Read a specific comment
+    if args.read:
+        if not args.id:
+            print("--id is required for --read")
+        else:
+            _print_header(f"Reading comment: {args.id}")
+            comment = client.comments.read(comment_id=args.id)
+            print(f"ID: {comment.id}")
+            print(f"Body: {comment.body}")
+
+
+if __name__ == "__main__":
+    main()

examples/organization_token.py

@@ -0,0 +1,212 @@
+#!/usr/bin/env python3
+"""
+Organization Token Operations Example
+
+Demonstrates usage of all 6 organization token operations:
+1. create() - Create a new organization token, replacing any existing token
+2. create_with_options() - Create with options like expiration date and token type
+3. read() - Read the organization token
+4. read_with_options() - Read with options like token type
+5. delete() - Delete the organization token
+6. delete_with_options() - Delete with options like token type
+
+Usage:
+- Modify organization names as needed for your environment
+- Ensure you have proper TFE credentials and organization access
+- Organization tokens are used for organization-level API access
+
+Prerequisites:
+- Set TFE_TOKEN and TFE_ADDRESS environment variables
+- You need an existing organization or admin permissions to create one
+- Appropriate permissions to manage organization tokens
+"""
+
+from datetime import datetime, timedelta
+
+# Add the src directory to the path
+##sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "src"))
+from pytfe import TFEClient, TFEConfig
+from pytfe.models import (
+    OrganizationTokenCreateOptions,
+    OrganizationTokenDeleteOptions,
+    OrganizationTokenReadOptions,
+    TokenType,
+)
+
+
+def redact_token(token_value: str | None) -> str:
+    """Redact token value for safe display."""
+    if not token_value:
+        return "None"
+    if len(token_value) <= 8:
+        return f"{'*' * len(token_value)}"
+    # Show first 3 and last 3 characters
+    return f"{token_value[:3]}...{token_value[-3:]}".replace(
+        token_value[3:-3], "*" * (len(token_value) - 6)
+    )
+
+
+def redact_id(id_value: str | None) -> str:
+    """Redact ID for safe display."""
+    if not id_value:
+        return "None"
+    if len(id_value) <= 6:
+        return f"{'*' * len(id_value)}"
+    # Show first 3 and last 3 characters
+    return f"{id_value[:3]}...{id_value[-3:]}"
+
+
+def main():
+    """Execute organization token operation examples."""
+
+    print("=" * 80)
+    print("ORGANIZATION TOKEN OPERATIONS")
+    print("=" * 80)
+
+    # Initialize the TFE client
+    client = TFEClient(TFEConfig.from_env())
+    organization_name = "prab-sandbox02"
+    # =====================================================
+    # 1. CREATE ORGANIZATION TOKEN (BASIC)
+    # =====================================================
+    print("\n1. create() - Create a new organization token:")
+    print("-" * 40)
+    try:
+        print(f"Creating token for organization: {organization_name}")
+        token = client.organization_tokens.create(organization_name)
+
+        print("Token created successfully!")
+        print(f"  Token ID: {redact_id(token.id)}")
+        print(f"  Created At: {token.created_at}")
+        print(f"  Description: {token.description}")
+        print(f"  Token Value: {redact_token(token.token)}")
+        if token.expired_at:
+            print(f"  Expires At: {token.expired_at}")
+        print()
+
+    except Exception as e:
+        print(f" Error: {e}")
+        print()
+
+    # =====================================================
+    # 2. CREATE WITH OPTIONS (WITH EXPIRATION)
+    # =====================================================
+    print("2. create_with_options() - Create token with expiration date:")
+    print("-" * 40)
+    try:
+        # Create a token that expires in 30 days
+        expiry_date = datetime.utcnow() + timedelta(days=30)
+        options = OrganizationTokenCreateOptions(expired_at=expiry_date)
+
+        print(f"Creating organization token with expiration date: {expiry_date}")
+        token = client.organization_tokens.create_with_options(
+            organization_name, options
+        )
+
+        print("Token created with options successfully!")
+        print(f"  Token ID: {redact_id(token.id)}")
+        print(f"  Created At: {token.created_at}")
+        if token.expired_at:
+            print(f"  Expires At: {token.expired_at}")
+        print()
+
+    except Exception as e:
+        print(f" Error: {e}")
+        print()
+
+    # =====================================================
+    print("3. create_with_options() - Create audit-trails token:")
+    print("-" * 40)
+    try:
+        options = OrganizationTokenCreateOptions(token_type=TokenType.AUDIT_TRAILS)
+
+        print(f"Creating audit-trails token for organization: {organization_name}")
+        token = client.organization_tokens.create_with_options(
+            organization_name, options
+        )
+
+        print(" Audit-trails token created successfully!")
+        print(f"  Token ID: {redact_id(token.id)}")
+        print(f"  Token Value: {redact_token(token.token)}")
+        print()
+
+    except Exception as e:
+        print(f"Error: {e}")
+        print()
+
+    # =====================================================
+    print("4. read() - Read the organization token:")
+    print("-" * 40)
+    try:
+        print(f"Reading organization token for organization: {organization_name}")
+        token = client.organization_tokens.read(organization_name)
+
+        print("Token read successfully!")
+        print(f"  Token ID: {redact_id(token.id)}")
+        print(f"  Created At: {token.created_at}")
+        print(f"  Description: {token.description}")
+        if token.last_used_at:
+            print(f"  Last Used At: {token.last_used_at}")
+        if token.expired_at:
+            print(f"  Expires At: {token.expired_at}")
+        print()
+
+    except Exception as e:
+        print(f" Error: {e}")
+        print()
+
+    # =====================================================
+    print("5. read_with_options() - Read audit-trails token:")
+    print("-" * 40)
+    try:
+        options = OrganizationTokenReadOptions(token_type=TokenType.AUDIT_TRAILS)
+
+        print(f"Reading audit-trails token for organization: {organization_name}")
+        token = client.organization_tokens.read_with_options(organization_name, options)
+
+        print(" Audit-trails token read successfully!")
+        print(f"  Token ID: {redact_id(token.id)}")
+        print(f"  Token Value: {redact_token(token.token)}")
+        print()
+
+    except Exception as e:
+        print(f" Error: {e}")
+        print()
+
+    # =====================================================
+    print("6. delete() - Delete the organization token:")
+    print("-" * 40)
+    try:
+        print(f"Deleting organization token for organization: {organization_name}")
+        client.organization_tokens.delete(organization_name)
+
+        print(" Token deleted successfully!")
+        print()
+
+    except Exception as e:
+        print(f" Error: {e}")
+        print()
+
+    # =====================================================
+    print("7. delete_with_options() - Delete audit-trails token:")
+    print("-" * 40)
+    try:
+        options = OrganizationTokenDeleteOptions(token_type=TokenType.AUDIT_TRAILS)
+
+        print(f"Deleting audit-trails token for organization: {organization_name}")
+        client.organization_tokens.delete_with_options(organization_name, options)
+
+        print(" Audit-trails token deleted successfully!")
+        print()
+
+    except Exception as e:
+        print(f"Error: {e}")
+        print()
+
+    print("=" * 80)
+    print("ORGANIZATION TOKEN OPERATIONS COMPLETED")
+    print("=" * 80)
+
+
+if __name__ == "__main__":
+    main()