secretshield 0.4.1__tar.gz → 0.4.2__tar.gz

{secretshield-0.4.1/secretshield.egg-info → secretshield-0.4.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: secretshield
-Version: 0.4.1
-Summary: Detect, redact, and prevent secret exposure in Python apps, source code, and Git commits — runtime protection, multi-language scanning, auto-fix, and CI integration in one tool.
+Version: 0.4.2
+Summary: Stop secrets before they leak -- runtime redaction, multi-language scanning, auto-fix, Git hooks, and CI, all in one CLI.
 Author: Samarth Chugh (Sam3360)
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/Sam3360/secretshield
@@ -106,6 +106,10 @@ Set a whole project up in one step (config file + Git hook + CI):
 secretshield init
 ```
 
+> Typing `secretshield` a lot? Every command also works with the short
+> alias `ss` — `ss scan .`, `ss init`, `ss --fix`, all identical to
+> their `secretshield` equivalents.
+
 ## What SecretShield does
 
 SecretShield isn't just one trick — it's five layers that cover the
@@ -179,6 +183,8 @@ redact("aws_key=AKIAABCDEFGHIJKLMNOP")
 
 ## CLI reference
 
+*(Every command below also works via the shorter `ss` alias — `ss scan .` is identical to `secretshield scan .`.)*
+
 ### `secretshield init` — set a project up in one step
 
 ```bash

{secretshield-0.4.1 → secretshield-0.4.2}/README.md

@@ -80,6 +80,10 @@ Set a whole project up in one step (config file + Git hook + CI):
 secretshield init
 ```
 
+> Typing `secretshield` a lot? Every command also works with the short
+> alias `ss` — `ss scan .`, `ss init`, `ss --fix`, all identical to
+> their `secretshield` equivalents.
+
 ## What SecretShield does
 
 SecretShield isn't just one trick — it's five layers that cover the
@@ -153,6 +157,8 @@ redact("aws_key=AKIAABCDEFGHIJKLMNOP")
 
 ## CLI reference
 
+*(Every command below also works via the shorter `ss` alias — `ss scan .` is identical to `secretshield scan .`.)*
+
 ### `secretshield init` — set a project up in one step
 
 ```bash
@@ -324,4 +330,4 @@ If you find this project useful, consider [supporting its development through Gi
 
 ## License
 
-MIT — see [LICENSE](LICENSE).
+MIT — see [LICENSE](LICENSE).

{secretshield-0.4.1 → secretshield-0.4.2}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "secretshield"
-version = "0.4.1"
-description = "Detect, redact, and prevent secret exposure in Python apps, source code, and Git commits — runtime protection, multi-language scanning, auto-fix, and CI integration in one tool."
+version = "0.4.2"
+description = "Stop secrets before they leak -- runtime redaction, multi-language scanning, auto-fix, Git hooks, and CI, all in one CLI."
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.10"
@@ -39,6 +39,7 @@ Issues = "https://github.com/Sam3360/secretshield/issues"
 
 [project.scripts]
 secretshield = "secretshield.cli:main"
+ss = "secretshield.cli:main"
 
 [tool.setuptools.packages.find]
 include = ["secretshield*"]

{secretshield-0.4.1 → secretshield-0.4.2}/secretshield/__init__.py

@@ -23,7 +23,7 @@ from .detector import Match, detect
 from .guardian import disable, enable, is_enabled
 from .redactor import redact
 
-__version__ = "0.4.0"
+__version__ = "0.4.2"
 
 __all__ = [
     "__version__",

{secretshield-0.4.1 → secretshield-0.4.2}/secretshield/cli.py

@@ -726,6 +726,22 @@ def _cmd_init(args: argparse.Namespace) -> int:
 # --- argparse wiring -----------------------------------------------------
 
 
+CREATOR_MESSAGE = "SecretShield\nCreated by Samarth Chugh (Sam3360)\ngithub.com/Sam3360"
+
+
+class _CreatorAction(argparse.Action):
+    """Prints creator info and exits -- mirrors argparse's built-in
+    `action="version"` behavior so `--creator` works the same way
+    `--version` does, with no subcommand required."""
+
+    def __init__(self, option_strings, dest, nargs=0, **kwargs):
+        super().__init__(option_strings, dest, nargs=nargs, **kwargs)
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        print(CREATOR_MESSAGE)
+        parser.exit()
+
+
 def build_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         prog="secretshield",
@@ -737,6 +753,9 @@ def build_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "--version", action="version", version=f"secretshield {__version__}"
     )
+    parser.add_argument(
+        "--creator", action=_CreatorAction, help="Show who made this and exit."
+    )
 
     subparsers = parser.add_subparsers(dest="command")
 

{secretshield-0.4.1 → secretshield-0.4.2/secretshield.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: secretshield
-Version: 0.4.1
-Summary: Detect, redact, and prevent secret exposure in Python apps, source code, and Git commits — runtime protection, multi-language scanning, auto-fix, and CI integration in one tool.
+Version: 0.4.2
+Summary: Stop secrets before they leak -- runtime redaction, multi-language scanning, auto-fix, Git hooks, and CI, all in one CLI.
 Author: Samarth Chugh (Sam3360)
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/Sam3360/secretshield
@@ -106,6 +106,10 @@ Set a whole project up in one step (config file + Git hook + CI):
 secretshield init
 ```
 
+> Typing `secretshield` a lot? Every command also works with the short
+> alias `ss` — `ss scan .`, `ss init`, `ss --fix`, all identical to
+> their `secretshield` equivalents.
+
 ## What SecretShield does
 
 SecretShield isn't just one trick — it's five layers that cover the
@@ -179,6 +183,8 @@ redact("aws_key=AKIAABCDEFGHIJKLMNOP")
 
 ## CLI reference
 
+*(Every command below also works via the shorter `ss` alias — `ss scan .` is identical to `secretshield scan .`.)*
+
 ### `secretshield init` — set a project up in one step
 
 ```bash

{secretshield-0.4.1 → secretshield-0.4.2}/secretshield.egg-info/SOURCES.txt

@@ -35,6 +35,7 @@ tests/test_logging.py
 tests/test_project_config.py
 tests/test_redactor.py
 tests/test_scan.py
+tests/test_ss_alias_and_creator.py
 tests/test_stdout.py
 tests/test_v030_cli_integration.py
 tests/test_v040_cli_integration.py

{secretshield-0.4.1 → secretshield-0.4.2}/secretshield.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 secretshield = secretshield.cli:main
+ss = secretshield.cli:main

secretshield-0.4.2/tests/test_ss_alias_and_creator.py

@@ -0,0 +1,147 @@
+"""
+Tests for v0.4.2: the `ss` short CLI alias and the `--creator` easter
+egg. Both `ss` and `secretshield` are registered as separate console
+scripts pointing to the exact same `secretshield.cli:main` function, so
+most equivalence is tested by exercising `main()` directly; a couple of
+tests also verify the actual installed executables behave identically.
+"""
+
+from __future__ import annotations
+
+import shutil
+import subprocess
+import sys
+
+import pytest
+
+from secretshield.cli import CREATOR_MESSAGE, build_parser, main
+
+FAKE_SECRET = "ssAliasFakeSecretForTests123456789"
+
+
+# --- --creator, via main() (fast, no subprocess) -----------------------------
+
+
+def test_creator_flag_exits_zero():
+    with pytest.raises(SystemExit) as exc_info:
+        main(["--creator"])
+    assert exc_info.value.code in (0, None)
+
+
+def test_creator_flag_prints_expected_content(capsys):
+    with pytest.raises(SystemExit):
+        main(["--creator"])
+    out = capsys.readouterr().out
+    assert "Samarth Chugh (Sam3360)" in out
+    assert "github.com/Sam3360" in out
+
+
+def test_creator_message_constant_matches_requirements():
+    assert "Samarth Chugh (Sam3360)" in CREATOR_MESSAGE
+    assert "github.com/Sam3360" in CREATOR_MESSAGE
+
+
+def test_creator_flag_is_not_overly_verbose():
+    # Polished, not a wall of text.
+    assert CREATOR_MESSAGE.count("\n") <= 3
+
+
+def test_creator_works_regardless_of_subcommand_position():
+    # --creator, like --version, should short-circuit before any
+    # subcommand dispatch is required.
+    parser = build_parser()
+    with pytest.raises(SystemExit):
+        parser.parse_args(["--creator"])
+
+
+# --- console scripts: both entry points exist and are wired identically ----
+
+
+def test_pyproject_declares_both_console_scripts():
+    try:
+        import tomllib  # Python 3.11+
+    except ModuleNotFoundError:
+        import tomli as tomllib  # Python 3.10 fallback
+
+    with open("pyproject.toml", "rb") as f:
+        data = tomllib.load(f)
+    scripts = data["project"]["scripts"]
+    assert scripts.get("secretshield") == "secretshield.cli:main"
+    assert scripts.get("ss") == "secretshield.cli:main"
+
+
+def _find_executable(name: str) -> str | None:
+    return shutil.which(name)
+
+
+@pytest.mark.skipif(
+    _find_executable("ss") is None or _find_executable("secretshield") is None,
+    reason="ss/secretshield not installed as real executables in this environment",
+)
+def test_installed_ss_and_secretshield_creator_output_match():
+    result_full = subprocess.run(
+        ["secretshield", "--creator"], capture_output=True, text=True
+    )
+    result_short = subprocess.run(["ss", "--creator"], capture_output=True, text=True)
+    assert result_full.returncode == 0
+    assert result_short.returncode == 0
+    assert result_full.stdout == result_short.stdout
+
+
+@pytest.mark.skipif(
+    _find_executable("ss") is None or _find_executable("secretshield") is None,
+    reason="ss/secretshield not installed as real executables in this environment",
+)
+def test_installed_ss_and_secretshield_version_match():
+    result_full = subprocess.run(
+        ["secretshield", "--version"], capture_output=True, text=True
+    )
+    result_short = subprocess.run(["ss", "--version"], capture_output=True, text=True)
+    assert result_full.stdout == result_short.stdout
+
+
+@pytest.mark.skipif(
+    _find_executable("ss") is None or _find_executable("secretshield") is None,
+    reason="ss/secretshield not installed as real executables in this environment",
+)
+def test_installed_ss_and_secretshield_help_match():
+    result_full = subprocess.run(
+        ["secretshield", "--help"], capture_output=True, text=True
+    )
+    result_short = subprocess.run(["ss", "--help"], capture_output=True, text=True)
+    assert result_full.stdout == result_short.stdout
+
+
+@pytest.mark.skipif(
+    _find_executable("ss") is None or _find_executable("secretshield") is None,
+    reason="ss/secretshield not installed as real executables in this environment",
+)
+def test_installed_ss_scan_behaves_like_secretshield_scan(tmp_path):
+    (tmp_path / "app.py").write_text(f'API_KEY = "{FAKE_SECRET}"\n')
+
+    result_full = subprocess.run(
+        ["secretshield", "scan", str(tmp_path)], capture_output=True, text=True
+    )
+    result_short = subprocess.run(
+        ["ss", "scan", str(tmp_path)], capture_output=True, text=True
+    )
+    assert result_full.returncode == result_short.returncode == 1
+    assert result_full.stdout == result_short.stdout
+    assert FAKE_SECRET not in result_full.stdout
+    assert FAKE_SECRET not in result_short.stdout
+
+
+# --- existing commands unaffected -------------------------------------------
+
+
+def test_existing_scan_command_still_works_after_creator_addition(tmp_path):
+    app = tmp_path / "app.py"
+    app.write_text(f'API_KEY = "{FAKE_SECRET}"\n')
+    exit_code = main(["scan", str(app)])
+    assert exit_code == 1
+
+
+def test_version_flag_still_works():
+    with pytest.raises(SystemExit) as exc_info:
+        main(["--version"])
+    assert exc_info.value.code in (0, None)