ipmg 4.0.0b1__tar.gz → 4.2.0__tar.gz

ipmg-4.2.0/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: ipmg
+Version: 4.2.0
+Summary: Network discovery and change detection: ping sweeps, scan history, and reports for what changed on your network
+Author: Sameer Alam
+Maintainer-email: Sameer Alam <sameeralam3127@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://sameeralam3127.github.io/ipmg/
+Project-URL: Documentation, https://github.com/sameeralam3127/ipmg#readme
+Project-URL: Repository, https://github.com/sameeralam3127/ipmg
+Project-URL: Issues, https://github.com/sameeralam3127/ipmg/issues
+Project-URL: Changelog, https://github.com/sameeralam3127/ipmg/releases
+Keywords: ip,network,ping,monitoring,cli,port-scan,network-scanner,ping-sweep,subnet-scanner,homelab,sysadmin
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Monitoring
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: rich>=13.0
+Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+Provides-Extra: web
+Requires-Dist: fastapi>=0.110; extra == "web"
+Requires-Dist: pydantic>=2.7; extra == "web"
+Requires-Dist: uvicorn>=0.27; extra == "web"
+Requires-Dist: websockets>=12; extra == "web"
+Requires-Dist: python-multipart>=0.0.9; extra == "web"
+Provides-Extra: snmp
+Requires-Dist: cryptography>=42; extra == "snmp"
+Provides-Extra: all
+Requires-Dist: ipmg[snmp,web]; extra == "all"
+Provides-Extra: dev
+Requires-Dist: ipmg[snmp,web]; extra == "dev"
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: pre-commit>=3.5.0; extra == "dev"
+Requires-Dist: python-semantic-release>=10.5.3; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Requires-Dist: httpx2>=2.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sameeralam3127/ipmg/main/docs/assets/ipmg-logo.svg" alt="" width="88">
+</p>
+
+<h1 align="center">IPMG</h1>
+
+<p align="center">
+  <b>IP Management &amp; Ping Monitoring Tool</b><br>
+  Know what changed on your network since the last scan.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/ipmg/"><img src="https://img.shields.io/github/v/release/sameeralam3127/ipmg?label=pypi" alt="PyPI"></a>
+  <a href="https://pypi.org/project/ipmg/"><img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python Version"></a>
+  <a href="https://github.com/sameeralam3127/ipmg/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
+  <a href="https://github.com/sameeralam3127/ipmg/actions/workflows/publish.yml"><img src="https://github.com/sameeralam3127/ipmg/actions/workflows/publish.yml/badge.svg" alt="Publish"></a>
+</p>
+
+<p align="center">
+  <a href="https://sameeralam3127.github.io/ipmg/"><b>Website</b></a>
+  &nbsp;·&nbsp;
+  <a href="https://sameeralam3127.github.io/ipmg/demo/"><b>Live demo</b></a>
+  &nbsp;·&nbsp;
+  <a href="https://sameeralam3127.github.io/ipmg/#builder"><b>Command builder</b></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/sameeralam3127/ipmg#documentation"><b>Docs</b></a>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sameeralam3127/ipmg/main/docs/assets/ipmg-compare.gif" alt="ipmg scans 13 hosts with --stream, printing each one as it answers; a new address is added to the target file; a second scan with --compare reports it as a new host (warning) against the first" width="820">
+</p>
+
+IPMG sweeps IPs, CIDR blocks, and ranges in parallel, remembers every scan, and
+tells you what changed since the last one: hosts that went down or appeared, a
+new MAC address or hostname behind an address, slower replies, a web service
+that started failing. Only the changes that matter reach Slack, Teams, a
+webhook, or email, or fail your cron job or CI step.
+
+## Features
+
+- **Fast, without root.** IPv4 and IPv6, CIDR blocks, ranges, and target
+  files (text, CSV, Excel, JSON), many hosts at a time, using your system's own
+  `ping`.
+- **Finds hosts that block ping** with TCP probes (`--probe icmp,tcp`), and
+  checks web services (`--http-check`: status, response time, TLS, certificate
+  expiry).
+- **Names every device** by reverse DNS and, on your LAN, by MAC address
+  and vendor (`--mac`). Wakes them with Wake-on-LAN (`ipmg wake`).
+- **Tells you what changed** since the last scan, with a severity for each
+  change, and alerts Slack, Teams, webhooks, or email.
+- **Made for automation:** exit codes for cron and CI, a GitHub Action,
+  `--json` for scripts, systemd and launchd templates, Prometheus metrics.
+- **IPMG Web**, a local dashboard: live scans, history, changes, inventory,
+  and scheduled scans.
+- **Reports** in Excel, CSV, JSON, JSON Lines, and Markdown, written as the
+  scan runs, so an interrupted scan keeps its results.
+
+[How IPMG compares](https://github.com/sameeralam3127/ipmg/blob/main/docs/COMPARISON.md)
+with nmap, fping, and Uptime Kuma.
+
+## Install
+
+```bash
+# Linux and macOS, no Python needed
+curl -sSL https://raw.githubusercontent.com/sameeralam3127/ipmg/main/install.sh | bash
+```
+
+```powershell
+# Windows, no administrator rights
+irm https://raw.githubusercontent.com/sameeralam3127/ipmg/main/install.ps1 | iex
+```
+
+Or from PyPI, with Python 3.10 or newer:
+
+```bash
+# With pip, in a virtual environment
+pip install ipmg            # the command line
+pip install "ipmg[web]"     # the command line and IPMG Web, the browser dashboard
+```
+
+```bash
+# With pipx
+pipx install "ipmg[web]"
+```
+
+```bash
+# With uv, which fetches Python 3.10+ if you need it
+uv tool install --python ">=3.10" "ipmg[web]"
+```
+
+Also on:
+
+- **Homebrew:** `brew install sameeralam3127/tap/ipmg`
+- **Docker:** `docker run --rm sameeralam3127/ipmg --input 10.0.0.0/24`, or from GHCR: `ghcr.io/sameeralam3127/ipmg`
+
+> **Tip:** `[web]` adds IPMG Web; `pip install ipmg` alone is the command line.
+> Where the system Python is older than 3.10 (RHEL 9, Ubuntu 20.04, SLES 15),
+> pip and pipx quietly install an older IPMG: use the installer or uv there. The
+> [install guide](https://github.com/sameeralam3127/ipmg/blob/main/docs/INSTALL.md)
+> covers version pinning, upgrading from 3.x, and tab completion.
+
+## Quick start
+
+```bash
+ipmg --discover             # scan the network you are on, right now
+ipmg --discover --compare   # later: scan again and see what changed
+ipmg web --lan              # open the dashboard from any machine on your network
+```
+
+Every scan is saved to a local history (`~/.ipmg/dashboard.db`), so
+`--compare` always has the previous scan to compare with.
+
+<details>
+<summary>What a scan prints</summary>
+
+```text
+  ipmg X.Y.Z  ·  scan
+  ICMP probes only — scan only networks you are authorized to scan.
+
+  Source   192.168.1.0/24
+  Targets  254 hosts
+  Config   50 threads · 2s timeout · 1 ping
+
+  Results
+  ● Active    12  ━───────────────────────   4.7%
+  ● Timeout  242  ━━━━━━━━━━━━━━━━━━━━━━━━  95.3%
+
+  254 hosts · 4.7% active · 3.1 ms avg · 5.21s · 2026-10-18 09:15:02
+
+  Saved    results_20261018_091502.xlsx
+```
+
+</details>
+
+> **Note:** only scan networks you are authorized to scan. Unauthorized scanning
+> may violate your organization's policies or the law.
+
+## Common tasks
+
+| I want to… | Command |
+| --- | --- |
+| Scan the network I am on | `ipmg --discover` |
+| Scan hosts listed in a file, plus a few more | `ipmg --input targets.txt 10.0.0.5` |
+| See what changed since last time | `ipmg --input targets.txt --compare` |
+| Get alerted when something changes | `ipmg --input targets.txt --interval 15 --notify-slack` |
+| Find hosts that block ping | `ipmg --input 10.0.0.0/24 --probe icmp,tcp` |
+| Know which device each address is | `ipmg --discover --resolve --mac` |
+| Check that a web service works | `ipmg --http-check https://intranet.example.com/` |
+| Watch switches and routers: reboots, interfaces going down | `ipmg --input switches.txt --snmp --compare` |
+| See which services are listening | `ipmg --input targets.txt --scan-ports` |
+| Get a report I can send to someone | `ipmg --input targets.txt --formats md csv` |
+| Pipe the results into a script | `ipmg --input targets.txt --json \| jq .` |
+| Fail a cron job or CI step when hosts are down | `ipmg --input servers.txt --fail-on-down` |
+| Wake a machine | `ipmg wake AA:BB:CC:DD:EE:FF` |
+| Use the dashboard from another machine | `ipmg web --lan` |
+| Keep it running after logout and reboots | [systemd and launchd templates](https://github.com/sameeralam3127/ipmg/blob/main/docs/SERVICES.md) |
+| See every option | `ipmg --help`, or the [command reference](https://github.com/sameeralam3127/ipmg/blob/main/docs/COMMANDS.md) |
+
+## IPMG Web
+
+```bash
+ipmg web          # this machine: opens http://127.0.0.1:8080 in your browser
+ipmg web --lan    # any machine on your network: prints the link to open
+```
+
+With `--lan`, IPMG Web prints the link with this machine's address and access
+token, checks the firewall, and tells you the exact command that opens the
+port if it is blocked (`sudo ipmg web --open-firewall` opens it only while
+IPMG Web runs). Every request needs the token in that link.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sameeralam3127/ipmg/main/docs/assets/ipmg-web.png" alt="IPMG Web dashboard: scan totals, a status donut of 16 active, 1 timeout and 1 inactive host, a latency trend chart, and a list of recent scans" width="820">
+</p>
+
+Dashboard, live monitor, history, changes, inventory with Wake-on-LAN, and
+scheduled scans; see the
+[IPMG Web guide](https://github.com/sameeralam3127/ipmg/blob/main/docs/WEB.md),
+or try it first in the [live demo](https://sameeralam3127.github.io/ipmg/demo/).
+
+## Documentation
+
+| Guide | What is in it |
+| --- | --- |
+| [Install](https://github.com/sameeralam3127/ipmg/blob/main/docs/INSTALL.md) | Installers, Docker, pip, Python versions, upgrading from 3.x, tab completion, verified systems |
+| [Command reference](https://github.com/sameeralam3127/ipmg/blob/main/docs/COMMANDS.md) | Every command and flag with examples: targets, probes, HTTP checks, reports, history, change detection, notifications, `ipmg.toml`, exit codes |
+| [IPMG Web](https://github.com/sameeralam3127/ipmg/blob/main/docs/WEB.md) | The dashboard, opening it from other machines, the firewall, scheduled scans, Prometheus metrics |
+| [Web API](https://github.com/sameeralam3127/ipmg/blob/main/docs/API.md) | Scripting IPMG Web over HTTP and WebSocket |
+| [Running as a service](https://github.com/sameeralam3127/ipmg/blob/main/docs/SERVICES.md) | systemd and launchd templates for scheduled scans and IPMG Web |
+| [GitHub Action](https://github.com/sameeralam3127/ipmg/blob/main/docs/GITHUB-ACTION.md) | Reachability checks in CI, before a deploy or on a schedule |
+| [SNMP polling](https://github.com/sameeralam3127/ipmg/blob/main/docs/SNMP.md) | Switches and routers over SNMP v2c and v3: credentials, interfaces, reboots, reports |
+| [How it compares](https://github.com/sameeralam3127/ipmg/blob/main/docs/COMPARISON.md) | IPMG next to nmap, fping, and Uptime Kuma |
+| [Troubleshooting](https://github.com/sameeralam3127/ipmg/blob/main/docs/TROUBLESHOOTING.md) and [FAQ](https://github.com/sameeralam3127/ipmg/blob/main/docs/FAQ.md) | Install errors, timeouts, slow scans, empty MAC addresses, common questions |
+| [Architecture](https://github.com/sameeralam3127/ipmg/blob/main/docs/ARCHITECTURE.md) | How the code fits together, for contributors |
+
+## Security
+
+IPMG runs `ping` as a direct process call with no shell, validates every
+target first, and needs no root. IPMG Web listens on `127.0.0.1` unless you
+pass `--lan`, serves everything locally, and requires its access token on
+every request, behind a strict Content-Security-Policy. The only outbound
+requests IPMG makes are the notifications and HTTP checks you ask for. Found a
+vulnerability? See
+[SECURITY.md](https://github.com/sameeralam3127/ipmg/blob/main/.github/SECURITY.md).
+
+## Contributing
+
+Contributions are welcome.
+[CONTRIBUTING.md](https://github.com/sameeralam3127/ipmg/blob/main/.github/CONTRIBUTING.md)
+covers the development setup, the tests, and the commit format that drives
+releases, and
+[ARCHITECTURE.md](https://github.com/sameeralam3127/ipmg/blob/main/docs/ARCHITECTURE.md)
+explains the code. Everyone taking part is expected to follow the
+[Code of Conduct](https://github.com/sameeralam3127/ipmg/blob/main/.github/CODE_OF_CONDUCT.md).
+
+If IPMG saves you time, a star on
+[GitHub](https://github.com/sameeralam3127/ipmg) helps other people find it.
+
+## License
+
+MIT — free for commercial and personal use.

ipmg-4.2.0/README.md

@@ -0,0 +1,220 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sameeralam3127/ipmg/main/docs/assets/ipmg-logo.svg" alt="" width="88">
+</p>
+
+<h1 align="center">IPMG</h1>
+
+<p align="center">
+  <b>IP Management &amp; Ping Monitoring Tool</b><br>
+  Know what changed on your network since the last scan.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/ipmg/"><img src="https://img.shields.io/github/v/release/sameeralam3127/ipmg?label=pypi" alt="PyPI"></a>
+  <a href="https://pypi.org/project/ipmg/"><img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python Version"></a>
+  <a href="https://github.com/sameeralam3127/ipmg/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
+  <a href="https://github.com/sameeralam3127/ipmg/actions/workflows/publish.yml"><img src="https://github.com/sameeralam3127/ipmg/actions/workflows/publish.yml/badge.svg" alt="Publish"></a>
+</p>
+
+<p align="center">
+  <a href="https://sameeralam3127.github.io/ipmg/"><b>Website</b></a>
+  &nbsp;·&nbsp;
+  <a href="https://sameeralam3127.github.io/ipmg/demo/"><b>Live demo</b></a>
+  &nbsp;·&nbsp;
+  <a href="https://sameeralam3127.github.io/ipmg/#builder"><b>Command builder</b></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/sameeralam3127/ipmg#documentation"><b>Docs</b></a>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sameeralam3127/ipmg/main/docs/assets/ipmg-compare.gif" alt="ipmg scans 13 hosts with --stream, printing each one as it answers; a new address is added to the target file; a second scan with --compare reports it as a new host (warning) against the first" width="820">
+</p>
+
+IPMG sweeps IPs, CIDR blocks, and ranges in parallel, remembers every scan, and
+tells you what changed since the last one: hosts that went down or appeared, a
+new MAC address or hostname behind an address, slower replies, a web service
+that started failing. Only the changes that matter reach Slack, Teams, a
+webhook, or email, or fail your cron job or CI step.
+
+## Features
+
+- **Fast, without root.** IPv4 and IPv6, CIDR blocks, ranges, and target
+  files (text, CSV, Excel, JSON), many hosts at a time, using your system's own
+  `ping`.
+- **Finds hosts that block ping** with TCP probes (`--probe icmp,tcp`), and
+  checks web services (`--http-check`: status, response time, TLS, certificate
+  expiry).
+- **Names every device** by reverse DNS and, on your LAN, by MAC address
+  and vendor (`--mac`). Wakes them with Wake-on-LAN (`ipmg wake`).
+- **Tells you what changed** since the last scan, with a severity for each
+  change, and alerts Slack, Teams, webhooks, or email.
+- **Made for automation:** exit codes for cron and CI, a GitHub Action,
+  `--json` for scripts, systemd and launchd templates, Prometheus metrics.
+- **IPMG Web**, a local dashboard: live scans, history, changes, inventory,
+  and scheduled scans.
+- **Reports** in Excel, CSV, JSON, JSON Lines, and Markdown, written as the
+  scan runs, so an interrupted scan keeps its results.
+
+[How IPMG compares](https://github.com/sameeralam3127/ipmg/blob/main/docs/COMPARISON.md)
+with nmap, fping, and Uptime Kuma.
+
+## Install
+
+```bash
+# Linux and macOS, no Python needed
+curl -sSL https://raw.githubusercontent.com/sameeralam3127/ipmg/main/install.sh | bash
+```
+
+```powershell
+# Windows, no administrator rights
+irm https://raw.githubusercontent.com/sameeralam3127/ipmg/main/install.ps1 | iex
+```
+
+Or from PyPI, with Python 3.10 or newer:
+
+```bash
+# With pip, in a virtual environment
+pip install ipmg            # the command line
+pip install "ipmg[web]"     # the command line and IPMG Web, the browser dashboard
+```
+
+```bash
+# With pipx
+pipx install "ipmg[web]"
+```
+
+```bash
+# With uv, which fetches Python 3.10+ if you need it
+uv tool install --python ">=3.10" "ipmg[web]"
+```
+
+Also on:
+
+- **Homebrew:** `brew install sameeralam3127/tap/ipmg`
+- **Docker:** `docker run --rm sameeralam3127/ipmg --input 10.0.0.0/24`, or from GHCR: `ghcr.io/sameeralam3127/ipmg`
+
+> **Tip:** `[web]` adds IPMG Web; `pip install ipmg` alone is the command line.
+> Where the system Python is older than 3.10 (RHEL 9, Ubuntu 20.04, SLES 15),
+> pip and pipx quietly install an older IPMG: use the installer or uv there. The
+> [install guide](https://github.com/sameeralam3127/ipmg/blob/main/docs/INSTALL.md)
+> covers version pinning, upgrading from 3.x, and tab completion.
+
+## Quick start
+
+```bash
+ipmg --discover             # scan the network you are on, right now
+ipmg --discover --compare   # later: scan again and see what changed
+ipmg web --lan              # open the dashboard from any machine on your network
+```
+
+Every scan is saved to a local history (`~/.ipmg/dashboard.db`), so
+`--compare` always has the previous scan to compare with.
+
+<details>
+<summary>What a scan prints</summary>
+
+```text
+  ipmg X.Y.Z  ·  scan
+  ICMP probes only — scan only networks you are authorized to scan.
+
+  Source   192.168.1.0/24
+  Targets  254 hosts
+  Config   50 threads · 2s timeout · 1 ping
+
+  Results
+  ● Active    12  ━───────────────────────   4.7%
+  ● Timeout  242  ━━━━━━━━━━━━━━━━━━━━━━━━  95.3%
+
+  254 hosts · 4.7% active · 3.1 ms avg · 5.21s · 2026-10-18 09:15:02
+
+  Saved    results_20261018_091502.xlsx
+```
+
+</details>
+
+> **Note:** only scan networks you are authorized to scan. Unauthorized scanning
+> may violate your organization's policies or the law.
+
+## Common tasks
+
+| I want to… | Command |
+| --- | --- |
+| Scan the network I am on | `ipmg --discover` |
+| Scan hosts listed in a file, plus a few more | `ipmg --input targets.txt 10.0.0.5` |
+| See what changed since last time | `ipmg --input targets.txt --compare` |
+| Get alerted when something changes | `ipmg --input targets.txt --interval 15 --notify-slack` |
+| Find hosts that block ping | `ipmg --input 10.0.0.0/24 --probe icmp,tcp` |
+| Know which device each address is | `ipmg --discover --resolve --mac` |
+| Check that a web service works | `ipmg --http-check https://intranet.example.com/` |
+| Watch switches and routers: reboots, interfaces going down | `ipmg --input switches.txt --snmp --compare` |
+| See which services are listening | `ipmg --input targets.txt --scan-ports` |
+| Get a report I can send to someone | `ipmg --input targets.txt --formats md csv` |
+| Pipe the results into a script | `ipmg --input targets.txt --json \| jq .` |
+| Fail a cron job or CI step when hosts are down | `ipmg --input servers.txt --fail-on-down` |
+| Wake a machine | `ipmg wake AA:BB:CC:DD:EE:FF` |
+| Use the dashboard from another machine | `ipmg web --lan` |
+| Keep it running after logout and reboots | [systemd and launchd templates](https://github.com/sameeralam3127/ipmg/blob/main/docs/SERVICES.md) |
+| See every option | `ipmg --help`, or the [command reference](https://github.com/sameeralam3127/ipmg/blob/main/docs/COMMANDS.md) |
+
+## IPMG Web
+
+```bash
+ipmg web          # this machine: opens http://127.0.0.1:8080 in your browser
+ipmg web --lan    # any machine on your network: prints the link to open
+```
+
+With `--lan`, IPMG Web prints the link with this machine's address and access
+token, checks the firewall, and tells you the exact command that opens the
+port if it is blocked (`sudo ipmg web --open-firewall` opens it only while
+IPMG Web runs). Every request needs the token in that link.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sameeralam3127/ipmg/main/docs/assets/ipmg-web.png" alt="IPMG Web dashboard: scan totals, a status donut of 16 active, 1 timeout and 1 inactive host, a latency trend chart, and a list of recent scans" width="820">
+</p>
+
+Dashboard, live monitor, history, changes, inventory with Wake-on-LAN, and
+scheduled scans; see the
+[IPMG Web guide](https://github.com/sameeralam3127/ipmg/blob/main/docs/WEB.md),
+or try it first in the [live demo](https://sameeralam3127.github.io/ipmg/demo/).
+
+## Documentation
+
+| Guide | What is in it |
+| --- | --- |
+| [Install](https://github.com/sameeralam3127/ipmg/blob/main/docs/INSTALL.md) | Installers, Docker, pip, Python versions, upgrading from 3.x, tab completion, verified systems |
+| [Command reference](https://github.com/sameeralam3127/ipmg/blob/main/docs/COMMANDS.md) | Every command and flag with examples: targets, probes, HTTP checks, reports, history, change detection, notifications, `ipmg.toml`, exit codes |
+| [IPMG Web](https://github.com/sameeralam3127/ipmg/blob/main/docs/WEB.md) | The dashboard, opening it from other machines, the firewall, scheduled scans, Prometheus metrics |
+| [Web API](https://github.com/sameeralam3127/ipmg/blob/main/docs/API.md) | Scripting IPMG Web over HTTP and WebSocket |
+| [Running as a service](https://github.com/sameeralam3127/ipmg/blob/main/docs/SERVICES.md) | systemd and launchd templates for scheduled scans and IPMG Web |
+| [GitHub Action](https://github.com/sameeralam3127/ipmg/blob/main/docs/GITHUB-ACTION.md) | Reachability checks in CI, before a deploy or on a schedule |
+| [SNMP polling](https://github.com/sameeralam3127/ipmg/blob/main/docs/SNMP.md) | Switches and routers over SNMP v2c and v3: credentials, interfaces, reboots, reports |
+| [How it compares](https://github.com/sameeralam3127/ipmg/blob/main/docs/COMPARISON.md) | IPMG next to nmap, fping, and Uptime Kuma |
+| [Troubleshooting](https://github.com/sameeralam3127/ipmg/blob/main/docs/TROUBLESHOOTING.md) and [FAQ](https://github.com/sameeralam3127/ipmg/blob/main/docs/FAQ.md) | Install errors, timeouts, slow scans, empty MAC addresses, common questions |
+| [Architecture](https://github.com/sameeralam3127/ipmg/blob/main/docs/ARCHITECTURE.md) | How the code fits together, for contributors |
+
+## Security
+
+IPMG runs `ping` as a direct process call with no shell, validates every
+target first, and needs no root. IPMG Web listens on `127.0.0.1` unless you
+pass `--lan`, serves everything locally, and requires its access token on
+every request, behind a strict Content-Security-Policy. The only outbound
+requests IPMG makes are the notifications and HTTP checks you ask for. Found a
+vulnerability? See
+[SECURITY.md](https://github.com/sameeralam3127/ipmg/blob/main/.github/SECURITY.md).
+
+## Contributing
+
+Contributions are welcome.
+[CONTRIBUTING.md](https://github.com/sameeralam3127/ipmg/blob/main/.github/CONTRIBUTING.md)
+covers the development setup, the tests, and the commit format that drives
+releases, and
+[ARCHITECTURE.md](https://github.com/sameeralam3127/ipmg/blob/main/docs/ARCHITECTURE.md)
+explains the code. Everyone taking part is expected to follow the
+[Code of Conduct](https://github.com/sameeralam3127/ipmg/blob/main/.github/CODE_OF_CONDUCT.md).
+
+If IPMG saves you time, a star on
+[GitHub](https://github.com/sameeralam3127/ipmg) helps other people find it.
+
+## License
+
+MIT — free for commercial and personal use.

{ipmg-4.0.0b1 → ipmg-4.2.0}/pyproject.toml

@@ -13,7 +13,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ipmg"
-version = "4.0.0-beta.1"  # Managed automatically by semantic-release
+version = "4.2.0"  # Managed automatically by semantic-release
 description = "Network discovery and change detection: ping sweeps, scan history, and reports for what changed on your network"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -73,13 +73,17 @@ web = [
     "websockets>=12",
     "python-multipart>=0.0.9",
 ]
-# Everything; what the one-line installers and the Docker image install.
-all = ["ipmg[web]"]
+# SNMPv3 encryption (`--snmp` with a privacy key). SNMP v2c and v3 without
+# encryption need nothing extra.
+snmp = ["cryptography>=42"]
+# Everything.
+all = ["ipmg[web,snmp]"]
 dev = [
-    "ipmg[web]",
+    "ipmg[web,snmp]",
     "pytest>=7.4",
     "pytest-cov>=5.0",
     "ruff>=0.4",
+    "mypy>=1.10",
     "pre-commit>=3.5.0",
     "python-semantic-release>=10.5.3",
     # The TestClient's HTTP client. Starlette 1.x wants httpx2 and warns
@@ -99,10 +103,11 @@ ipmg = "ipmg.cli.commands:run"
 
 [dependency-groups]
 dev = [
-    "ipmg[web]",
+    "ipmg[web,snmp]",
     "pytest>=7.4",
     "pytest-cov>=5.0",
     "ruff>=0.4",
+    "mypy>=1.10",
     "pre-commit>=3.5.0",
     "python-semantic-release>=10.5.3",
     # The TestClient's HTTP client. Starlette 1.x wants httpx2 and warns
@@ -160,6 +165,14 @@ where = ["src"]
 # Testing
 # ==========================================================
 
+[tool.mypy]
+python_version = "3.10"
+# Optional extras (openpyxl stubs, pysnmp) are not all typed.
+ignore_missing_imports = true
+warn_unused_ignores = true
+files = ["src"]
+
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 pythonpath = ["src"]
@@ -189,8 +202,9 @@ line-length = 100
 target-version = "py310"
 
 [tool.ruff.lint]
-select = ["E", "F", "W", "I", "C90"]
-ignore = ["E501"]
+select = ["E", "F", "W", "I", "C90", "UP"]
+# UP038 (isinstance(x, A | B)) is slower than a tuple and deprecated in ruff.
+ignore = ["E501", "UP038"]
 
 [tool.ruff.lint.isort]
 combine-as-imports = true

{ipmg-4.0.0b1 → ipmg-4.2.0}/src/ipmg/__init__.py

@@ -2,4 +2,4 @@
 ipmg - IP Management & Ping Monitoring Tool
 """
 
-__version__ = "4.0.0-beta.1"
+__version__ = "4.2.0"