terraformgraph 1.0.1__tar.gz

terraformgraph-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 [Your Name]
+
+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.

terraformgraph-1.0.1/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: terraformgraph
+Version: 1.0.1
+Summary: Generate interactive architecture diagrams from Terraform configurations
+Author-email: Your Name <your.email@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/ferdinandobons/terraformgraph
+Project-URL: Documentation, https://github.com/ferdinandobons/terraformgraph#readme
+Project-URL: Repository, https://github.com/ferdinandobons/terraformgraph.git
+Project-URL: Issues, https://github.com/ferdinandobons/terraformgraph/issues
+Keywords: terraform,infrastructure,diagram,aws,visualization,architecture,terraformgraph
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-hcl2>=4.3.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0; extra == "dev"
+Dynamic: license-file
+
+# terraformgraph
+
+Generate interactive architecture diagrams from your Terraform configurations. Supports AWS resources with automatic service grouping, relationship detection, and beautiful SVG/HTML output.
+
+![Example Diagram](docs/diagram.png)
+
+## Features
+
+- **Automatic parsing** of Terraform HCL files
+- **Smart resource grouping** into logical services (ECS, RDS, S3, etc.)
+- **Relationship detection** based on resource references
+- **Interactive HTML output** with drag-and-drop positioning
+- **PNG/JPG export** directly from the browser
+- **Customizable** via YAML configuration files
+- **No cloud credentials required** - works entirely offline
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install terraformgraph
+```
+
+### From Source
+
+```bash
+git clone https://github.com/ferdinandobons/terraformgraph.git
+cd terraformgraph
+pip install -e .
+```
+
+## Quick Start
+
+### Basic Usage
+
+Generate a diagram from a Terraform directory:
+
+```bash
+terraformgraph -t ./infrastructure -o diagram.html
+```
+
+### With Environment Subdirectories
+
+If your Terraform is organized by environment:
+
+```bash
+terraformgraph -t ./infrastructure -e prod -o prod-diagram.html
+```
+
+### With AWS Icons
+
+For beautiful AWS service icons, download the [AWS Architecture Icons](https://aws.amazon.com/architecture/icons/) and extract them:
+
+```bash
+terraformgraph -t ./infrastructure -i ./AWS_Icons -o diagram.html
+```
+
+## Command Line Options
+
+| Option | Required | Description |
+|--------|----------|-------------|
+| `-t, --terraform` | Yes | Path to Terraform directory |
+| `-e, --environment` | No | Environment subdirectory (dev, staging, prod) |
+| `-i, --icons` | No | Path to AWS icons directory |
+| `-o, --output` | Yes | Output HTML file path |
+| `-v, --verbose` | No | Enable debug output |
+
+## Configuration
+
+### Custom Aggregation Rules
+
+Create `~/.terraformgraph/aggregation_rules.yaml` to customize how resources are grouped:
+
+```yaml
+compute:
+  my_custom_service:
+    primary: ["aws_my_resource"]
+    secondary: ["aws_my_helper"]
+    in_vpc: true
+```
+
+### Custom Connections
+
+Create `~/.terraformgraph/logical_connections.yaml` to define service relationships:
+
+```yaml
+connections:
+  - source: my_service
+    target: another_service
+    label: "Custom Connection"
+    type: data_flow
+```
+
+## Supported Resources
+
+The tool supports 100+ AWS resource types including:
+
+- **Compute**: ECS, EC2, Lambda, Auto Scaling
+- **Networking**: VPC, ALB/NLB, Route53, CloudFront
+- **Storage**: S3, EBS, EFS
+- **Database**: RDS, DynamoDB, ElastiCache
+- **Messaging**: SQS, SNS, EventBridge
+- **Security**: IAM, KMS, Secrets Manager, WAF
+- **And many more...**
+
+## Output
+
+The generated HTML file includes:
+
+- **Interactive diagram** with pan and zoom
+- **Drag-and-drop** to reposition services
+- **Click connections** to highlight data flows
+- **Export buttons** for PNG and JPG
+- **Save/Load layout** using browser storage
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

terraformgraph-1.0.1/README.md

@@ -0,0 +1,123 @@
+# terraformgraph
+
+Generate interactive architecture diagrams from your Terraform configurations. Supports AWS resources with automatic service grouping, relationship detection, and beautiful SVG/HTML output.
+
+![Example Diagram](docs/diagram.png)
+
+## Features
+
+- **Automatic parsing** of Terraform HCL files
+- **Smart resource grouping** into logical services (ECS, RDS, S3, etc.)
+- **Relationship detection** based on resource references
+- **Interactive HTML output** with drag-and-drop positioning
+- **PNG/JPG export** directly from the browser
+- **Customizable** via YAML configuration files
+- **No cloud credentials required** - works entirely offline
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install terraformgraph
+```
+
+### From Source
+
+```bash
+git clone https://github.com/ferdinandobons/terraformgraph.git
+cd terraformgraph
+pip install -e .
+```
+
+## Quick Start
+
+### Basic Usage
+
+Generate a diagram from a Terraform directory:
+
+```bash
+terraformgraph -t ./infrastructure -o diagram.html
+```
+
+### With Environment Subdirectories
+
+If your Terraform is organized by environment:
+
+```bash
+terraformgraph -t ./infrastructure -e prod -o prod-diagram.html
+```
+
+### With AWS Icons
+
+For beautiful AWS service icons, download the [AWS Architecture Icons](https://aws.amazon.com/architecture/icons/) and extract them:
+
+```bash
+terraformgraph -t ./infrastructure -i ./AWS_Icons -o diagram.html
+```
+
+## Command Line Options
+
+| Option | Required | Description |
+|--------|----------|-------------|
+| `-t, --terraform` | Yes | Path to Terraform directory |
+| `-e, --environment` | No | Environment subdirectory (dev, staging, prod) |
+| `-i, --icons` | No | Path to AWS icons directory |
+| `-o, --output` | Yes | Output HTML file path |
+| `-v, --verbose` | No | Enable debug output |
+
+## Configuration
+
+### Custom Aggregation Rules
+
+Create `~/.terraformgraph/aggregation_rules.yaml` to customize how resources are grouped:
+
+```yaml
+compute:
+  my_custom_service:
+    primary: ["aws_my_resource"]
+    secondary: ["aws_my_helper"]
+    in_vpc: true
+```
+
+### Custom Connections
+
+Create `~/.terraformgraph/logical_connections.yaml` to define service relationships:
+
+```yaml
+connections:
+  - source: my_service
+    target: another_service
+    label: "Custom Connection"
+    type: data_flow
+```
+
+## Supported Resources
+
+The tool supports 100+ AWS resource types including:
+
+- **Compute**: ECS, EC2, Lambda, Auto Scaling
+- **Networking**: VPC, ALB/NLB, Route53, CloudFront
+- **Storage**: S3, EBS, EFS
+- **Database**: RDS, DynamoDB, ElastiCache
+- **Messaging**: SQS, SNS, EventBridge
+- **Security**: IAM, KMS, Secrets Manager, WAF
+- **And many more...**
+
+## Output
+
+The generated HTML file includes:
+
+- **Interactive diagram** with pan and zoom
+- **Drag-and-drop** to reposition services
+- **Click connections** to highlight data flows
+- **Export buttons** for PNG and JPG
+- **Save/Load layout** using browser storage
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

terraformgraph-1.0.1/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "terraformgraph"
+version = "1.0.1"
+description = "Generate interactive architecture diagrams from Terraform configurations"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+authors = [
+    {name = "Your Name", email = "your.email@example.com"}
+]
+keywords = [
+    "terraform",
+    "infrastructure",
+    "diagram",
+    "aws",
+    "visualization",
+    "architecture",
+    "terraformgraph"
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: System :: Systems Administration",
+]
+dependencies = [
+    "python-hcl2>=4.3.0",
+    "PyYAML>=6.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "black>=23.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0",
+    "types-PyYAML>=6.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/ferdinandobons/terraformgraph"
+Documentation = "https://github.com/ferdinandobons/terraformgraph#readme"
+Repository = "https://github.com/ferdinandobons/terraformgraph.git"
+Issues = "https://github.com/ferdinandobons/terraformgraph/issues"
+
+[project.scripts]
+terraformgraph = "terraformgraph.main:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["terraformgraph*"]
+
+[tool.setuptools.package-data]
+terraformgraph = ["config/*.yaml"]
+
+[tool.black]
+line-length = 100
+target-version = ["py39", "py310", "py311", "py312"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W"]
+ignore = ["E501"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]

terraformgraph-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

terraformgraph-1.0.1/terraformgraph/__init__.py

@@ -0,0 +1,19 @@
+"""terraformgraph - Create architecture diagrams from Terraform configurations."""
+
+__version__ = "1.0.1"
+
+from .aggregator import ResourceAggregator
+from .config_loader import ConfigLoader
+from .layout import LayoutEngine
+from .parser import TerraformParser
+from .renderer import HTMLRenderer, SVGRenderer
+
+__all__ = [
+    "__version__",
+    "TerraformParser",
+    "ResourceAggregator",
+    "LayoutEngine",
+    "SVGRenderer",
+    "HTMLRenderer",
+    "ConfigLoader",
+]

terraformgraph-1.0.1/terraformgraph/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for running as a module: python -m terraform_diagram"""
+
+from .main import main
+
+if __name__ == '__main__':
+    main()