readtheplan 0.0.1__py3-none-any.whl

readtheplan-0.0.1.dist-info/METADATA

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: readtheplan
+Version: 0.0.1
+Summary: Terraform plan risk explainer — reads `terraform plan` and classifies each change as safe/review/dangerous/irreversible. Pre-MVP namespace placeholder.
+Author: texasich
+License: MIT
+Project-URL: Homepage, https://github.com/readtheplan/readtheplan
+Project-URL: Repository, https://github.com/readtheplan/readtheplan
+Project-URL: Issues, https://github.com/readtheplan/readtheplan/issues
+Keywords: terraform,iac,devops,devsecops,compliance,plan,review
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# readtheplan
+
+> Read the plan. Every time. For real.
+
+`readtheplan` is a Terraform plan risk explainer. It reads `terraform plan` output, classifies each change as **safe / review / dangerous / irreversible** based on the action × resource type × what compliance context it touches, and posts a markdown summary your release manager (or auditor, or AI agent) can read in 30 seconds.
+
+## status
+
+🚧 **Pre-MVP.** This namespace is locked but no functional release exists yet. Watch / star to follow.
+
+## why this exists
+
+Terraform's plan/apply separation exists so a human reviews changes before they hit prod. In practice:
+
+- the diff in code ≠ the diff in plan (renames show as destroy+create, provider bumps mutate untouched resources, `apply_immediately` flips have hidden timing implications)
+- AI agents now write Terraform PRs — most don't read the plan critically, they apply because "the test passed"
+- compliance reviewers (FinServ, healthcare, government) need a structured risk classification, not a 4,000-line text blob
+- existing tools either show prettier plans (Spacelift, env0) or scan code for policy violations (tflint, tfsec, checkov). Nobody opinionates the **plan diff** with blast-radius context.
+
+## philosophy
+
+Anchored in this field note: **[terraform-apply-is-roulette](https://github.com/texasich/sre-field-notes/blob/main/notes/terraform-apply-is-roulette.md)**. If you've ever shipped a panic on `terraform validate` or watched a forward-fix cascade into a longer outage, this tool is built for you.
+
+## planned MVP scope
+
+1. CLI: `readtheplan analyze plan.json` → markdown table of changes with risk levels
+2. plain-english explainer per resource type (top ~30 high-risk patterns covered out of the box: KMS, IAM, RDS replacements, S3 bucket destroys, EKS node-group replacements, route53 zone deletes, network ACL strips)
+3. AI-agent attestation header — flag whether an agent claims to have read the plan
+4. GitHub Action wrapper: install as `uses: readtheplan/action@v1`, posts a markdown PR comment
+5. YAML rule customization: define org-specific rules ("anything in account 1234 is `review`")
+
+## what's *not* in scope (and won't be)
+
+- multi-cloud beyond AWS (initial focus)
+- a SaaS dashboard (defer until revenue justifies)
+- a policy-as-code engine (OPA / Sentinel already exist)
+- competing with Spacelift / env0 / Snyk IaC on overlapping features
+
+## license
+
+MIT — see [LICENSE](./LICENSE).
+
+## contact
+
+OSS contributions welcome once the v0.1 lands. Until then, this is a namespace placeholder. Author: [@texasich](https://github.com/texasich).

readtheplan-0.0.1.dist-info/RECORD

@@ -0,0 +1,5 @@
+readtheplan-0.0.1.dist-info/licenses/LICENSE,sha256=PBe3aoK19NzjaeZhtFCYJftx9HZRZuxlWmeR5r2WENA,1081
+readtheplan-0.0.1.dist-info/METADATA,sha256=gbYrrKc7LiPW7MkbvsqEN5FfzXmJZ_wOHozeTlBocyc,3583
+readtheplan-0.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+readtheplan-0.0.1.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+readtheplan-0.0.1.dist-info/RECORD,,

readtheplan-0.0.1.dist-info/WHEEL

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

readtheplan-0.0.1.dist-info/licenses/LICENSE

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

readtheplan-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+