shellsafe 0.3.3__tar.gz → 0.3.4__tar.gz

{shellsafe-0.3.3 → shellsafe-0.3.4}/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project are documented here. Format follows
 Keep a Changelog; versioning follows SemVer.
 
+## [0.3.4] - 2026-09-03
+
+### Fixed
+
+- Export `plan()` from public surface (`__init__.py`); was defined in
+  `execute.py` but not listed in `__all__`, causing `ImportError` on
+  `from shellsafe import plan`
+
 ## [0.3.3] - 2026-09-01
 
 ### Added

{shellsafe-0.3.3 → shellsafe-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: shellsafe
-Version: 0.3.3
+Version: 0.3.4
 Summary: Run shell commands safely using Python 3.14 template strings. Values can never turn into commands.
 Project-URL: Homepage, https://github.com/rahulXs/shellsafe
 Project-URL: Repository, https://github.com/rahulXs/shellsafe
@@ -131,6 +131,19 @@ Filter by severity:
 shellsafe audit src/ --severity warning
 ```
 
+Suppress known-safe findings inline:
+
+```python
+# shellsafe: ignore AU001 reason: tested, value is constant
+os.system(f"echo {safe_value}")
+```
+
+Suppress from the command line:
+
+```bash
+shellsafe audit src/ --ignore AU004
+```
+
 ## Limits
 
 - Shell features (pipes, redirections) work on Linux and macOS only. Windows

{shellsafe-0.3.3 → shellsafe-0.3.4}/README.md

@@ -108,6 +108,19 @@ Filter by severity:
 shellsafe audit src/ --severity warning
 ```
 
+Suppress known-safe findings inline:
+
+```python
+# shellsafe: ignore AU001 reason: tested, value is constant
+os.system(f"echo {safe_value}")
+```
+
+Suppress from the command line:
+
+```bash
+shellsafe audit src/ --ignore AU004
+```
+
 ## Limits
 
 - Shell features (pipes, redirections) work on Linux and macOS only. Windows

{shellsafe-0.3.3 → shellsafe-0.3.4}/src/shellsafe/__init__.py

@@ -1,11 +1,11 @@
 """shellsafe: safe shell commands via Python 3.14 template strings.
 
 Public surface (stable names, additive only through 1.0):
-run, capture, shx, RAW, CaptureResult.
+run, capture, shx, plan, RAW, CaptureResult.
 """
 
 from ._version import __version__
-from .execute import CaptureResult, capture, run, shx
+from .execute import CaptureResult, capture, plan, run, shx
 from .raw import RAW
 
 __all__ = [
@@ -13,6 +13,7 @@ __all__ = [
     "CaptureResult",
     "__version__",
     "capture",
+    "plan",
     "run",
     "shx",
 ]

shellsafe-0.3.4/src/shellsafe/_version.py

@@ -0,0 +1 @@
+__version__ = "0.3.4"

{shellsafe-0.3.3 → shellsafe-0.3.4}/tests/unit/test_public_surface.py

@@ -4,7 +4,7 @@ import shellsafe
 
 
 def test_public_names_exist():
-    for name in ("run", "capture", "shx", "RAW", "CaptureResult", "__version__"):
+    for name in ("run", "capture", "shx", "plan", "RAW", "CaptureResult", "__version__"):
         assert hasattr(shellsafe, name), name
 
 
@@ -13,6 +13,7 @@ def test_all_is_exact():
         "run",
         "capture",
         "shx",
+        "plan",
         "RAW",
         "CaptureResult",
         "__version__",

shellsafe-0.3.3/src/shellsafe/_version.py

@@ -1 +0,0 @@
-__version__ = "0.3.3"