rtftree 1.0.0__py3-none-any.whl

rtftree-1.0.0.dist-info/METADATA

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: rtftree
+Version: 1.0.0
+Summary: Terraform Project Tree Generator CLI Tool
+Author: Ritesh Sharma
+License: MIT
+Project-URL: Homepage, https://github.com/riteshatri/tftree
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13.0.0
+Dynamic: license-file
+
+# 🚀 TFTree --- Terraform Project Tree Generator CLI
+
+> A professional-grade CLI tool to generate clean, structured, and
+> shareable Terraform project trees --- with smart exclude support,
+> colored output, and Markdown export.
+
+------------------------------------------------------------------------
+
+![Python](https://img.shields.io/badge/python-3.8+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![CLI](https://img.shields.io/badge/type-CLI-orange.svg)
+![Terraform](https://img.shields.io/badge/terraform-supported-purple.svg)
+
+------------------------------------------------------------------------
+
+## 📌 Why TFTree?
+
+Terraform projects often include:
+
+-   `.terraform/`
+-   `terraform.tfstate`
+-   `.terraform.lock.hcl`
+-   `.git/`
+-   Provider binaries
+-   Deeply nested modules
+
+Sharing structure manually becomes messy and unreadable.
+
+🔥 **TFTree solves this problem** by generating a clean, structured tree
+view of your infrastructure project --- ready for documentation,
+sharing, and audits.
+
+------------------------------------------------------------------------
+
+# ✨ Features
+
+✅ Beautiful tree-style output\
+✅ 🎨 Colored CLI output\
+✅ Optional file content preview\
+✅ Smart exclude support (like `.gitignore`)\
+✅ Wildcard pattern support (`*.exe`, `.terraform*`)\
+✅ Exclude via file (`--exclude-file`)\
+✅ Markdown export mode (`--markdown`)\
+✅ Output to file (`-o`)\
+✅ Lightweight & Fast\
+✅ Installable as a CLI tool
+
+------------------------------------------------------------------------
+
+# 📦 Installation
+
+## 🔹 Local Install (Development Mode)
+
+``` bash
+python -m pip install -e .
+```
+
+## 🔹 Standard Install
+
+``` bash
+python -m pip install .
+```
+
+## 🔹 After PyPI Publish (Global Install)
+
+``` bash
+pip install tftree
+```
+
+------------------------------------------------------------------------
+
+# 🚀 Usage
+
+## Basic Usage
+
+``` bash
+tftree <project-folder>
+```
+
+Example:
+
+``` bash
+tftree .
+```
+
+------------------------------------------------------------------------
+
+## 📁 Structure Only (No File Content)
+
+``` bash
+tftree . --no-content
+```
+
+------------------------------------------------------------------------
+
+## 🚫 Exclude Files & Folders
+
+### Direct Patterns
+
+``` bash
+tftree . --exclude .terraform .git terraform.tfstate *.exe
+```
+
+### Using Exclude File
+
+``` bash
+tftree . --exclude-file exclude.txt
+```
+
+Example `exclude.txt`:
+
+    .terraform
+    .git
+    terraform.tfstate
+    *.exe
+    .terraform.lock.hcl
+
+Supported:
+
+-   Exact file names
+-   Folder names
+-   Wildcards
+
+------------------------------------------------------------------------
+
+## 💾 Save Output to File
+
+``` bash
+tftree . -o infra_tree.txt
+```
+
+------------------------------------------------------------------------
+
+## 📝 Markdown Export Mode
+
+Generate Markdown-ready structure:
+
+``` bash
+tftree . --markdown -o structure.md
+```
+
+Perfect for:
+
+-   GitHub documentation
+-   Wiki pages
+-   Confluence
+-   Client documentation
+
+------------------------------------------------------------------------
+
+# 🖥 Example Output
+
+    📁 Terraform Project: infra
+
+    ├── 📁 modules
+    │   ├── 📄 main.tf
+    │   │   resource "azurerm_resource_group" "rg" {
+    │   │       name     = "example"
+    │   │       location = "East US"
+    │   │   }
+    │   └── 📄 variables.tf
+    │       variable "location" {
+    │           type = string
+    │       }
+    └── 📄 provider.tf
+
+------------------------------------------------------------------------
+
+# ⚙️ CLI Options
+
+  Option             Description
+  ------------------ ------------------------------------
+  `--no-content`     Show only folder/file structure
+  `--exclude`        Space-separated patterns to ignore
+  `--exclude-file`   Load exclude patterns from file
+  `--markdown`       Export output in Markdown format
+  `-o`, `--output`   Write output to file
+
+------------------------------------------------------------------------
+
+# 🏗 Project Structure
+
+    tftree/
+    │
+    ├── tftree/
+    │   ├── __init__.py
+    │   └── cli.py
+    │
+    ├── pyproject.toml
+    └── README.md
+
+------------------------------------------------------------------------
+
+# 🔥 DevOps Use Cases
+
+-   Share Terraform structure in tickets
+-   Infrastructure documentation
+-   CI/CD pipeline documentation
+-   Client infrastructure overview
+-   Audit reporting
+-   Pre-deployment reviews
+
+------------------------------------------------------------------------
+
+# 🌍 PyPI Publishing
+
+Once published to PyPI, anyone can install globally:
+
+``` bash
+pip install tftree
+```
+
+This makes TFTree a globally accessible DevOps utility tool.
+
+------------------------------------------------------------------------
+
+# 🧠 Roadmap
+
+-   `.treeignore` auto-detection
+-   `--max-depth` option
+-   Terraform-only mode (`*.tf`)
+-   JSON export
+-   GitHub Action integration
+-   Auto documentation mode
+
+------------------------------------------------------------------------
+
+# 👨‍💻 Author
+
+**Ritesh Sharma**\
+DevOps \| Azure \| Terraform \| Kubernetes
+
+------------------------------------------------------------------------
+
+# 📄 License
+
+MIT License
+
+------------------------------------------------------------------------
+
+# ⭐ Support
+
+If you find this tool useful:
+
+⭐ Star the repository\
+🚀 Share with DevOps community\
+🛠 Contribute improvements
+
+------------------------------------------------------------------------
+
+> Built with ❤️ for DevOps Engineers

rtftree-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+rtftree-1.0.0.dist-info/licenses/LICENSE,sha256=gvNa--QRlkoYNwmgW3w6qUipDSAcRviLjzpNcT1m2-8,1088
+tftree/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tftree/cli.py,sha256=d5vgYqDPUrRGb44XIUwkXdFiC1fWV27XEscK5OlgI3g,6315
+rtftree-1.0.0.dist-info/METADATA,sha256=9vRh6TD_ZyE5ExL-K0iZ2H6f7I6Yhz_P2GF47FnJVgw,6201
+rtftree-1.0.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+rtftree-1.0.0.dist-info/entry_points.txt,sha256=X6yqzcZFuyPTVZWslEoF4Z8iJodRfMuooU4eznT2iCw,43
+rtftree-1.0.0.dist-info/top_level.txt,sha256=TdI56UgqazfjvwXhr86LbN-cg9672r-1kT41wJJrxTI,7
+rtftree-1.0.0.dist-info/RECORD,,

rtftree-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

rtftree-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+tftree = tftree.cli:main

rtftree-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Riteshatri
+
+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.

rtftree-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+tftree

tftree/cli.py

@@ -0,0 +1,212 @@
+import os
+import argparse
+import fnmatch
+from rich.console import Console
+from rich.tree import Tree
+from rich.markdown import Markdown
+
+
+# ---------------------------------------
+# Utility Functions
+# ---------------------------------------
+
+def load_exclude_patterns(exclude_list, exclude_file):
+    patterns = exclude_list.copy()
+
+    if exclude_file and os.path.exists(exclude_file):
+        with open(exclude_file, "r", encoding="utf-8") as f:
+            for line in f:
+                line = line.strip()
+                if line and not line.startswith("#"):
+                    patterns.append(line)
+
+    return patterns
+
+
+def should_exclude(name, patterns):
+    for pattern in patterns:
+        if fnmatch.fnmatch(name, pattern):
+            return True
+    return False
+
+
+# ---------------------------------------
+# Tree Builder
+# ---------------------------------------
+
+def build_tree(directory, parent_tree, show_content=True, patterns=None):
+    patterns = patterns or []
+
+    try:
+        items = sorted(os.listdir(directory))
+    except PermissionError:
+        parent_tree.add("[red]Permission Denied")
+        return
+
+    for item in items:
+        if should_exclude(item, patterns):
+            continue
+
+        path = os.path.join(directory, item)
+
+        if os.path.isdir(path):
+            branch = parent_tree.add(f"[bold blue]📁 {item}")
+            build_tree(path, branch, show_content, patterns)
+        else:
+            file_branch = parent_tree.add(f"[green]📄 {item}")
+
+            if show_content:
+                try:
+                    with open(path, "r", encoding="utf-8") as f:
+                        lines = f.readlines()
+                        if not lines:
+                            file_branch.add("[dim][empty file]")
+                        else:
+                            for line in lines[:20]:
+                                file_branch.add(f"[dim]{line.rstrip()}")
+                except Exception:
+                    file_branch.add("[red][Error reading file]")
+
+
+# ---------------------------------------
+# Markdown Builder
+# ---------------------------------------
+
+def build_markdown(directory, show_content=True, patterns=None, prefix=""):
+    patterns = patterns or []
+    output = ""
+
+    try:
+        items = sorted(os.listdir(directory))
+    except PermissionError:
+        return ""
+
+    for item in items:
+        if should_exclude(item, patterns):
+            continue
+
+        path = os.path.join(directory, item)
+
+        if os.path.isdir(path):
+            output += f"{prefix}- 📁 **{item}**\n"
+            output += build_markdown(path, show_content, patterns, prefix + "  ")
+        else:
+            output += f"{prefix}- 📄 `{item}`\n"
+
+            if show_content:
+                try:
+                    with open(path, "r", encoding="utf-8") as f:
+                        lines = f.readlines()
+                        if lines:
+                            output += f"{prefix}  ```\n"
+                            for line in lines[:20]:
+                                output += f"{prefix}  {line}"
+                            output += f"{prefix}  ```\n"
+                        else:
+                            output += f"{prefix}  `[empty file]`\n"
+                except:
+                    output += f"{prefix}  `[Error reading file]`\n"
+
+    return output
+
+
+# ---------------------------------------
+# Main CLI
+# ---------------------------------------
+
+def main():
+
+    parser = argparse.ArgumentParser(
+        description="Terraform Tree CLI Tool",
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+
+    parser.add_argument(
+        "folder",
+        help="Project folder path"
+    )
+
+    parser.add_argument(
+        "-o", "--output",
+        help="Output file path"
+    )
+
+    parser.add_argument(
+        "--exclude",
+        nargs="*",
+        default=[],
+        metavar="PATTERN",
+        help=(
+            "Exclude files/folders using names or wildcards.\n\n"
+            "Examples:\n"
+            "  --exclude .terraform .git terraform.tfstate\n"
+            "  --exclude *.exe *.lock.hcl\n\n"
+            "Supported:\n"
+            "  • Exact file names (terraform.tfstate)\n"
+            "  • Folder names (.terraform)\n"
+            "  • Wildcards (*.exe, .terraform*)\n"
+        ),
+    )
+
+    parser.add_argument(
+        "--exclude-file",
+        help=(
+            "Path to file containing exclude patterns.\n"
+            "One pattern per line.\n"
+            "Lines starting with # are ignored."
+        )
+    )
+
+    parser.add_argument(
+        "--no-content",
+        action="store_true",
+        help="Show only folder/file structure (no file content preview)"
+    )
+
+    parser.add_argument(
+        "--markdown",
+        action="store_true",
+        help="Export output in Markdown format"
+    )
+
+    args = parser.parse_args()
+
+    patterns = load_exclude_patterns(args.exclude, args.exclude_file)
+    folder_name = os.path.basename(os.path.abspath(args.folder))
+
+    # MARKDOWN MODE
+    if args.markdown:
+        md_content = f"# 📁 Terraform Project: {folder_name}\n\n"
+        md_content += build_markdown(
+            args.folder,
+            show_content=not args.no_content,
+            patterns=patterns,
+        )
+
+        if args.output:
+            with open(args.output, "w", encoding="utf-8") as f:
+                f.write(md_content)
+            print(f"\n✅ Markdown file written to: {args.output}")
+        else:
+            console = Console()
+            console.print(Markdown(md_content))
+        return
+
+    # TREE MODE
+    tree = Tree(f"[bold cyan]📁 Terraform Project: {folder_name}")
+
+    build_tree(
+        args.folder,
+        tree,
+        show_content=not args.no_content,
+        patterns=patterns,
+    )
+
+    if args.output:
+        with open(args.output, "w", encoding="utf-8") as f:
+            file_console = Console(file=f, force_terminal=False, color_system=None)
+            file_console.print(tree)
+        print(f"\n✅ File written to: {args.output}")
+    else:
+        console = Console()
+        console.print(tree)