tfsumpy: project reborn as a plan summarizer with plugin support

Author: rafaelherik

.github/FUNDING.yml

@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: rafaelherik
+patreon: rafaelherik
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/ci.yaml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+  
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install poetry twine
+        poetry install --with dev
+        
+    - name: Run tests
+      run: poetry run pytest
+        
+    - name: Build package
+      run: poetry build
+
+    

.github/workflows/release.yml

@@ -0,0 +1,77 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on version tags
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # Needed for creating releases
+      
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+        
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install poetry twine
+        poetry install --with dev
+        
+    - name: Run tests
+      run: poetry run pytest
+        
+    - name: Build package
+      run: poetry build
+        
+    - name: Get version from tag
+      id: get_version
+      run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+        
+    - name: Create Release
+      uses: softprops/action-gh-release@v1
+      with:
+        name: Release ${{ steps.get_version.outputs.VERSION }}
+        draft: false
+        prerelease: false
+        files: |
+          dist/*
+        body: |
+          Release of version ${{ steps.get_version.outputs.VERSION }}
+          
+          Please refer to [CHANGELOG.md](./CHANGELOG.md) for details.
+          
+    - name: Publish to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: twine upload dist/*
+
+  docs:
+    needs: release
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install MkDocs and Material theme
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material
+
+      - name: Deploy documentation to GitHub Pages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: mkdocs gh-deploy --force --clean --remote-branch gh-pages

.gitignore

@@ -78,3 +78,6 @@ Pipfile.lock
 
 # poetry
 poetry.lock
+
+# cursor rules
+.cursorrules

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"  # Note: 3.13 is very new, consider using 3.11 for better compatibility
+
+# Build documentation with Mkdocs
+mkdocs:
+   configuration: mkdocs.yml
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
+        

.task/checksum/install

@@ -0,0 +1 @@
+1b7ffb9a935aa0b08ea1c774c0758749

CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+## [0.1.0] - 2024-06-05
+
+### 🎉 Project Reborn: tfsumpy 0.1.0
+
+This release marks a **new beginning** for tfsumpy. The project has been refocused and rebuilt to be a best-in-class Terraform plan summarizer, with a modern, extensible architecture.
+
+### Major Changes
+
+- **Simplified Core:**
+  - tfsumpy now focuses exclusively on summarizing Terraform plan files. All previous risk assessment and policy compliance features have been removed.
+  - The CLI and API are streamlined for clarity and ease of use.
+
+- **Extensible by Design:**
+  - tfsumpy now supports plug-and-play extensions via a simple plugin system. You can add your own analyzers and reporters by dropping Python files in a `plugins/` directory (or specify `--plugin-dir`).
+  - This makes it easy to add custom compliance checks, cost estimation, notifications, or integrations with other tools—without modifying the core codebase.
+
+### Why This Change?
+
+- **Focus:**
+  - By concentrating on plan summarization, tfsumpy is easier to use, maintain, and extend.
+- **Flexibility:**
+  - Users and organizations can now build their own extensions for any workflow or integration.
+- **Community:**
+  - We encourage sharing and contributing plugins to grow the ecosystem.
+
+### Migration & Support Notes
+
+- **Older releases are no longer supported.**
+  - The previous risk and policy features are not maintained and will not receive updates.
+  - If you need those features, consider implementing them as plugins using the new extension system.
+- **This is a fresh start.**
+  - We recommend all users upgrade to 0.1.0+ and take advantage of the new architecture.
+
+### How to Extend
+
+- See the [Extending tfsumpy](docs/extending.md) documentation for examples and best practices.
+- Write your own analyzer or reporter, place it in the `plugins/` directory, and tfsumpy will auto-load it.
+
+---
+
+## [Older releases]
+
+Older versions of tfsumpy are deprecated and will not be supported going forward. Please upgrade to 0.1.0+ for the latest features.

LICENSE

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