Skip to content

Commit 5078acf

Browse files
committed
Add python -m sentineldeck so it runs without Scripts on PATH
When pip does a user install, its Scripts directory is often not on PATH, so the bare sentineldeck command is not found even though the package imports fine. A __main__ module lets `python -m sentineldeck` run the CLI regardless of PATH, and the README documents it alongside pipx.
1 parent 2e1876a commit 5078acf

4 files changed

Lines changed: 28 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ All notable changes to this project are documented here. The format is loosely
44
based on [Keep a Changelog](https://keepachangelog.com/), and the project aims
55
to follow semantic versioning once it reaches 1.0.
66

7+
## [2.2.2] - 2026-06-29
8+
9+
### Added
10+
11+
- `python -m sentineldeck` now runs the CLI — a PATH-independent way to start it
12+
when pip does a user install and its Scripts directory is not on PATH (so the
13+
bare `sentineldeck` command is not found). The README documents the fallback.
14+
715
## [2.2.1] - 2026-06-29
816

917
### Fixed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,17 @@ Either way, this puts the `sentineldeck` command on your path. To verify:
213213
sentineldeck --version
214214
```
215215

216+
> **`sentineldeck: command not found` (or "not recognized" on Windows)?**
217+
> `pip` did a *user* install and its Scripts directory is not on your `PATH`. The
218+
> package is installed fine — run it as a module, which never depends on `PATH`:
219+
>
220+
> ```bash
221+
> python -m sentineldeck scan example.com
222+
> ```
223+
>
224+
> Or install with [pipx](https://pipx.pypa.io/), which puts the command on your
225+
> `PATH` for you: `pipx install sentineldeck`.
226+
216227
For development, install the dev extras (pytest and ruff):
217228
218229
```bash

src/sentineldeck/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"""SentinelDeck: passive attack-surface visibility for small businesses."""
22

3-
__version__ = "2.2.1"
3+
__version__ = "2.2.2"

src/sentineldeck/__main__.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
"""Allow ``python -m sentineldeck`` as an alternative to the ``sentineldeck``
2+
console script. Handy when pip did a user install and the Scripts directory is
3+
not on PATH, so the command is not found but the package still imports.
4+
"""
5+
from sentineldeck.cli import main
6+
7+
if __name__ == "__main__":
8+
raise SystemExit(main())

0 commit comments

Comments
 (0)