tfdo 0.1.0__tar.gz

tfdo-0.1.0/.gitignore

@@ -0,0 +1,40 @@
+# path-sync copy -n python-template
+
+# === DO_NOT_EDIT: path-sync gitignore ===
+# Python bytecode
+__pycache__/
+*.pyc
+*.pyo
+
+# Virtual environments
+.venv/
+venv/
+
+# Build artifacts
+dist/
+build/
+*.egg-info/
+
+# Coverage
+.coverage
+htmlcov/
+coverage.xml
+
+# Cache directories
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+
+# IDE
+.idea/
+*.iml
+.vscode/
+
+# pkg-ext dev mode files
+.groups-dev.yaml
+CHANGELOG-dev.md
+*.api-dev.yaml
+
+# MkDocs build output
+site/
+# === OK_EDIT: path-sync gitignore ===

tfdo-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Espen Albert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tfdo-0.1.0/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: tfdo
+Version: 0.1.0
+Summary: Terraform/OpenTofu lifecycle CLI with retry, workspaces, and CI scaffold
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: ask-shell
+Description-Content-Type: text/markdown
+
+# tfdo

tfdo-0.1.0/README.md

@@ -0,0 +1 @@
+# tfdo

tfdo-0.1.0/pyproject.toml

@@ -0,0 +1,107 @@
+# path-sync copy -n python-template
+
+# === OK_EDIT: path-sync header ===
+[project]
+name = "tfdo"
+version = "0.1.0"
+description = "Terraform/OpenTofu lifecycle CLI with retry, workspaces, and CI scaffold"
+requires-python = ">=3.13"
+license = "MIT"
+license-files = ["LICENSE"]
+readme = "README.md"
+dependencies = [
+  "ask-shell",
+]
+
+[project.scripts]
+tfdo = "tfdo.cli:typer_main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = ["*/**/*.py", "*/py.typed", "*/**/*.tmpl"]
+exclude = [
+  "*_examples.py",
+  "*_test.py",
+  "conftest.py",
+  "test_*.json",
+]
+
+# === DO_NOT_EDIT: path-sync pkg-ext ===
+[tool.pkg-ext]
+tag_prefix = "v"
+max_bump_type = "minor"
+# === OK_EDIT: path-sync pkg-ext ===
+
+# === DO_NOT_EDIT: path-sync ruff ===
+[tool.ruff]
+line-length = 120
+target-version = "py313"
+
+[tool.ruff.lint]
+# E501: line too long (handled by formatter)
+# UP006: use `type` instead of `Type` from typing module
+# UP007: use `X | Y` instead of `Union[X, Y]`
+# UP035: use `typing` instead of `typing_extensions`
+# UP040: use `type` keyword instead of `TypeAlias`
+# UP046: use type parameters on functions instead of TypeVar
+# UP047: use type parameters instead of `Generic[T]` subclass
+extend-ignore = ["E501", "UP006", "UP007", "UP035", "UP040", "UP046", "UP047"]
+extend-select = ["Q", "RUF100", "C90", "UP", "I", "T", "FURB"]
+# === OK_EDIT: path-sync ruff ===
+
+# === DO_NOT_EDIT: path-sync pytest ===
+[tool.pytest.ini_options]
+addopts = "-s -vv --log-cli-level=INFO -m 'not manual'"
+markers = ["manual: test requires manual env setup (not run in CI)"]
+python_files = ["*_test.py", "test_*.py"]
+asyncio_mode = "auto"
+# === OK_EDIT: path-sync pytest ===
+
+# === DO_NOT_EDIT: path-sync coverage ===
+[tool.coverage.report]
+omit = ["*_test.py"]
+exclude_lines = ["no cov", "if __name__ == .__main__.:"]
+# === OK_EDIT: path-sync coverage ===
+
+# === DO_NOT_EDIT: path-sync vulture ===
+[tool.vulture]
+min_confidence = 80
+ignore_names = ["mock_*", "Mock*", "*_mock"]
+exclude = [".venv/", "*test.py"]
+# === OK_EDIT: path-sync vulture ===
+
+# === DO_NOT_EDIT: path-sync dev-lint ===
+[dependency-groups]
+dev-lint = [
+  "pyright>=1.1",
+  "ruff>=0.14",
+  "vulture>=2.14",
+]
+# === OK_EDIT: path-sync dev-lint ===
+
+# === DO_NOT_EDIT: path-sync dev-test ===
+dev-test = [
+  "pytest>=9.0",
+  "pytest-asyncio>=0.24",
+  "pytest-cov>=7.0",
+  "pytest-examples>=0.0.18",
+  "pytest-regressions>=2.6",
+]
+# === OK_EDIT: path-sync dev-test ===
+
+# === DO_NOT_EDIT: path-sync dev ===
+dev = [{include-group = "dev-lint"}, {include-group = "dev-test"}]
+# === OK_EDIT: path-sync dev ===
+
+# === DO_NOT_EDIT: path-sync release ===
+release = ["pkg-ext"]
+# === OK_EDIT: path-sync release ===
+# 
+# === DO_NOT_EDIT: path-sync docs ===
+docs = [
+  "mkdocs-material>=9.5",
+]
+# === OK_EDIT: path-sync docs ===

tfdo-0.1.0/scripts/fix_source_links.py

@@ -0,0 +1,56 @@
+# path-sync copy -n python-template
+"""Replace relative source links with GitHub URLs in docs."""
+
+import re
+import sys
+from pathlib import Path
+
+if len(sys.argv) < 2:
+    raise SystemExit("Usage: fix_source_links.py <REPO_URL>")
+
+REPO_URL = sys.argv[1]
+BRANCH = "main"
+DOCS_DIR = Path(__file__).parent.parent / "docs"
+
+# Pattern: [source](../../pkg_name/_internal/module.py#L81)
+RELATIVE_SOURCE_PATTERN = re.compile(r"\[source\]\((?P<rel_path>\.\./[^)]+)\)")
+
+
+def to_github_url(rel_path: str, doc_file: Path) -> str:
+    """Convert relative path to absolute GitHub URL."""
+    resolved = (doc_file.parent / rel_path).resolve()
+    repo_root = DOCS_DIR.parent
+    try:
+        repo_relative = resolved.relative_to(repo_root)
+    except ValueError:
+        return rel_path
+    return f"{REPO_URL}/blob/{BRANCH}/{repo_relative}"
+
+
+def fix_links_in_file(file_path: Path) -> bool:
+    """Fix source links in a single file. Returns True if modified."""
+    content = file_path.read_text()
+
+    def replace_source_link(match: re.Match[str]) -> str:
+        rel_path = match.group("rel_path")
+        github_url = to_github_url(rel_path, file_path)
+        return f"[source]({github_url})"
+
+    new_content = RELATIVE_SOURCE_PATTERN.sub(replace_source_link, content)
+    if new_content != content:
+        file_path.write_text(new_content)
+        return True
+    return False
+
+
+def main() -> None:
+    modified_count = 0
+    for md_file in DOCS_DIR.rglob("*.md"):
+        if fix_links_in_file(md_file):
+            print(f"Fixed: {md_file.relative_to(DOCS_DIR)}")  # noqa: T201
+            modified_count += 1
+    print(f"Modified {modified_count} file(s)")  # noqa: T201
+
+
+if __name__ == "__main__":
+    main()

tfdo-0.1.0/tfdo/__init__.py

@@ -0,0 +1,14 @@
+# Generated by pkg-ext
+# flake8: noqa
+from tfdo._internal.typer_app import get_settings
+from tfdo._internal.typer_app import main_callback
+from tfdo import core
+from tfdo._internal.settings import TfDoSettings
+
+VERSION = "0.1.0"
+__all__ = [
+    "get_settings",
+    "main_callback",
+    "core",
+    "TfDoSettings",
+]

tfdo-0.1.0/tfdo/__main__.py

@@ -0,0 +1,4 @@
+from tfdo.cli import typer_main
+
+if __name__ == "__main__":
+    typer_main()

tfdo-0.1.0/tfdo/_internal/__init__.py

@@ -0,0 +1 @@
+

tfdo-0.1.0/tfdo/_internal/cmd_options.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+import typer
+
+
+def var_file_option() -> Path | None:
+    return typer.Option(None, "--var-file", "-f", help="Path to a terraform .tfvars file")
+
+
+def auto_approve_option() -> bool:
+    return typer.Option(False, "--auto-approve", help="Skip interactive approval prompts")
+
+
+def init_first_option() -> bool:
+    return typer.Option(False, "--init", help="Run terraform init before the command")

tfdo-0.1.0/tfdo/_internal/core/__init__.py

@@ -0,0 +1 @@
+

tfdo-0.1.0/tfdo/_internal/core/cmd_apply.py

@@ -0,0 +1,25 @@
+import logging
+from pathlib import Path
+
+import typer
+
+from tfdo._internal import cmd_options
+from tfdo._internal.models import ApplyInput
+from tfdo._internal.typer_app import app, get_settings
+
+logger = logging.getLogger(__name__)
+
+
+@app.command("apply")
+@app.command("a")
+def apply_cmd(
+    ctx: typer.Context,
+    auto_approve: bool = cmd_options.auto_approve_option(),
+    var_file: Path | None = cmd_options.var_file_option(),
+    init_first: bool = cmd_options.init_first_option(),
+) -> None:
+    """Run terraform apply."""
+    settings = get_settings(ctx)
+    input_model = ApplyInput(settings=settings, auto_approve=auto_approve, var_file=var_file, init_first=init_first)
+    logger.info(f"tfdo apply [binary={input_model.settings.binary}] -- not implemented yet")
+    raise typer.Exit(0)

tfdo-0.1.0/tfdo/_internal/core/cmd_check.py

@@ -0,0 +1,24 @@
+import logging
+
+import typer
+
+from tfdo._internal import cmd_options
+from tfdo._internal.models import CheckInput
+from tfdo._internal.typer_app import app, get_settings
+
+logger = logging.getLogger(__name__)
+
+
+@app.command("check")
+@app.command("c")
+def check_cmd(
+    ctx: typer.Context,
+    fix: bool = typer.Option(False, "--fix", help="Auto-format instead of checking"),
+    diff: bool = typer.Option(False, "--diff", help="Show what would change"),
+    init_first: bool = cmd_options.init_first_option(),
+) -> None:
+    """Run terraform fmt check + validate (ruff-style)."""
+    settings = get_settings(ctx)
+    input_model = CheckInput(settings=settings, fix=fix, diff=diff, init_first=init_first)
+    logger.info(f"tfdo check [binary={input_model.settings.binary}] -- not implemented yet")
+    raise typer.Exit(0)

tfdo-0.1.0/tfdo/_internal/core/cmd_destroy.py

@@ -0,0 +1,25 @@
+import logging
+from pathlib import Path
+
+import typer
+
+from tfdo._internal import cmd_options
+from tfdo._internal.models import DestroyInput
+from tfdo._internal.typer_app import app, get_settings
+
+logger = logging.getLogger(__name__)
+
+
+@app.command("destroy")
+@app.command("d")
+def destroy_cmd(
+    ctx: typer.Context,
+    auto_approve: bool = cmd_options.auto_approve_option(),
+    var_file: Path | None = cmd_options.var_file_option(),
+    init_first: bool = cmd_options.init_first_option(),
+) -> None:
+    """Run terraform destroy."""
+    settings = get_settings(ctx)
+    input_model = DestroyInput(settings=settings, auto_approve=auto_approve, var_file=var_file, init_first=init_first)
+    logger.info(f"tfdo destroy [binary={input_model.settings.binary}] -- not implemented yet")
+    raise typer.Exit(0)

tfdo-0.1.0/tfdo/_internal/core/cmd_init.py

@@ -0,0 +1,21 @@
+import logging
+
+import typer
+
+from tfdo._internal.models import InitInput
+from tfdo._internal.typer_app import app, get_settings
+
+logger = logging.getLogger(__name__)
+
+
+@app.command("init")
+@app.command("i")
+def init_cmd(
+    ctx: typer.Context,
+    extra_args: list[str] = typer.Argument(default=None, help="Extra arguments forwarded to terraform init"),
+) -> None:
+    """Run terraform init with retry on transient errors."""
+    settings = get_settings(ctx)
+    input_model = InitInput(settings=settings, extra_args=extra_args or [])
+    logger.info(f"tfdo init [binary={input_model.settings.binary}] -- not implemented yet")
+    raise typer.Exit(0)

tfdo-0.1.0/tfdo/_internal/core/cmd_plan.py

@@ -0,0 +1,28 @@
+import logging
+from pathlib import Path
+
+import typer
+
+from tfdo._internal import cmd_options
+from tfdo._internal.models import PlanInput
+from tfdo._internal.typer_app import app, get_settings
+
+logger = logging.getLogger(__name__)
+
+
+@app.command("plan")
+@app.command("p")
+def plan_cmd(
+    ctx: typer.Context,
+    out: Path | None = typer.Option(None, "-o", "--out", help="Write the plan to a file"),
+    json_output: bool = typer.Option(False, "--json", help="Output plan in JSON format"),
+    var_file: Path | None = cmd_options.var_file_option(),
+    init_first: bool = cmd_options.init_first_option(),
+) -> None:
+    """Run terraform plan."""
+    settings = get_settings(ctx)
+    input_model = PlanInput(
+        settings=settings, out=out, json_output=json_output, var_file=var_file, init_first=init_first
+    )
+    logger.info(f"tfdo plan [binary={input_model.settings.binary}] -- not implemented yet")
+    raise typer.Exit(0)

tfdo-0.1.0/tfdo/_internal/models.py

@@ -0,0 +1,39 @@
+from pathlib import Path
+
+from pydantic import BaseModel
+
+from tfdo._internal.settings import TfDoSettings
+
+
+class TfDoBaseInput(BaseModel):
+    settings: TfDoSettings
+    dry_run: bool = False
+
+
+class InitInput(TfDoBaseInput):
+    extra_args: list[str] = []
+
+
+class PlanInput(TfDoBaseInput):
+    out: Path | None = None
+    json_output: bool = False
+    var_file: Path | None = None
+    init_first: bool = False
+
+
+class ApplyInput(TfDoBaseInput):
+    auto_approve: bool = False
+    var_file: Path | None = None
+    init_first: bool = False
+
+
+class DestroyInput(TfDoBaseInput):
+    auto_approve: bool = False
+    var_file: Path | None = None
+    init_first: bool = False
+
+
+class CheckInput(TfDoBaseInput):
+    fix: bool = False
+    diff: bool = False
+    init_first: bool = False

tfdo-0.1.0/tfdo/_internal/settings.py

@@ -0,0 +1,27 @@
+from typing import ClassVar
+
+from model_lib import StaticSettings
+from pydantic import ConfigDict, Field
+
+ENV_PREFIX = "TFDO_"
+
+
+class TfDoSettings(StaticSettings):
+    model_config = ConfigDict(populate_by_name=True)  # type: ignore
+
+    ENV_NAME_BINARY: ClassVar[str] = f"{ENV_PREFIX}BINARY"
+    binary: str = Field(
+        default="terraform",
+        alias=ENV_NAME_BINARY,
+        description="Terraform binary name or path (terraform, tofu, etc.)",
+    )
+
+    ENV_NAME_TF_VERSION: ClassVar[str] = f"{ENV_PREFIX}TF_VERSION"
+    tf_version: str | None = Field(
+        default=None,
+        alias=ENV_NAME_TF_VERSION,
+        description="When set, binary becomes 'mise x terraform@{version} -- {binary}'",
+    )
+
+    log_level: str = Field(default="INFO", description="Log level for tfdo")
+    passthrough: bool = Field(default=False, description="Disable parsed output, pass raw ANSI from terraform")

tfdo-0.1.0/tfdo/_internal/typer_app.py

@@ -0,0 +1,37 @@
+import typer
+
+from tfdo._internal.settings import TfDoSettings
+
+app = typer.Typer(
+    name="tfdo",
+    help="Terraform/OpenTofu lifecycle CLI with retry, workspaces, and CI scaffold",
+    pretty_exceptions_enable=False,
+    pretty_exceptions_show_locals=False,
+)
+
+
+@app.callback()
+def main_callback(
+    ctx: typer.Context,
+    binary: str = typer.Option(
+        "terraform", "-b", "--binary", envvar="TFDO_BINARY", help="Terraform binary name or path"
+    ),
+    tf_version: str | None = typer.Option(
+        None, "-V", "--tf-version", envvar="TFDO_TF_VERSION", help="Terraform version (uses mise for version selection)"
+    ),
+    log_level: str = typer.Option("INFO", "--log-level", help="Log level for tfdo"),
+    passthrough: bool = typer.Option(
+        False, "--passthrough", help="Disable parsed output, pass raw ANSI from terraform"
+    ),
+) -> None:
+    ctx.obj = TfDoSettings(
+        binary=binary,
+        tf_version=tf_version,
+        log_level=log_level,
+        passthrough=passthrough,
+    )
+
+
+def get_settings(ctx: typer.Context) -> TfDoSettings:
+    settings: TfDoSettings = ctx.obj
+    return settings

tfdo-0.1.0/tfdo/cli.py

@@ -0,0 +1,9 @@
+from ask_shell import console
+
+from tfdo._internal.core import cmd_apply, cmd_check, cmd_destroy, cmd_init, cmd_plan  # noqa: F401
+from tfdo._internal.typer_app import app
+
+
+def typer_main() -> None:
+    console.configure_logging(app)
+    app()

tfdo-0.1.0/tfdo/core.py

@@ -0,0 +1,12 @@
+# Generated by pkg-ext
+from tfdo._internal.core.cmd_apply import apply_cmd as _apply_cmd
+from tfdo._internal.core.cmd_check import check_cmd as _check_cmd
+from tfdo._internal.core.cmd_destroy import destroy_cmd as _destroy_cmd
+from tfdo._internal.core.cmd_init import init_cmd as _init_cmd
+from tfdo._internal.core.cmd_plan import plan_cmd as _plan_cmd
+
+apply_cmd = _apply_cmd
+check_cmd = _check_cmd
+destroy_cmd = _destroy_cmd
+init_cmd = _init_cmd
+plan_cmd = _plan_cmd

tfdo-0.1.0/tfdo/py.typed

@@ -0,0 +1 @@
+