isitup-cli 0.1.3__tar.gz → 0.2.0__tar.gz

isitup_cli-0.2.0/PKG-INFO

@@ -0,0 +1,310 @@
+Metadata-Version: 2.4
+Name: isitup-cli
+Version: 0.2.0
+Summary: A small CLI that periodically checks whether servers respond to ping, HTTP, and TCP ports
+Author: stefan.insam
+Author-email: stefan.insam <stefan.insam@netgo.de>
+License-Expression: GPL-3.0-only
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Topic :: System :: Networking :: Monitoring
+Classifier: Topic :: Utilities
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: requests>=2.34.2
+Requires-Dist: rich>=15.0.0
+Requires-Python: >=3.14
+Project-URL: Repository, https://github.com/ramsesoriginal/isitup
+Project-URL: Issues, https://github.com/ramsesoriginal/isitup/issues
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/ramsesoriginal/isitup/main/logo/main_hero.svg" alt="isitup" width="720">
+
+  <p><strong>Is it up? Ping, HTTP, and TCP checks in one small, fast CLI.</strong></p>
+
+  [![PyPI](https://img.shields.io/pypi/v/isitup-cli?color=blue)](https://pypi.org/project/isitup-cli/)
+  [![CI](https://github.com/ramsesoriginal/isitup/actions/workflows/ci.yml/badge.svg)](https://github.com/ramsesoriginal/isitup/actions/workflows/ci.yml)
+  [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
+  [![Python 3.14+](https://img.shields.io/badge/python-3.14%2B-3776AB?logo=python&logoColor=white)](pyproject.toml)
+  [![uv](https://img.shields.io/badge/uv-managed-DE5FE9?logo=uv&logoColor=white)](https://github.com/astral-sh/uv)
+  [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+  [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+  [![GitHub stars](https://img.shields.io/github/stars/ramsesoriginal/isitup?style=social)](https://github.com/ramsesoriginal/isitup)
+</div>
+
+---
+
+**isitup** is a small CLI that periodically checks whether servers respond to ping and,
+depending on how the target is written, HTTP, a TCP port, or SSH:
+
+| Target | Checks |
+| --- | --- |
+| `example.com` | ping only |
+| `example.com:1337` | ping + TCP connect to port 1337 |
+| `http://example.com` / `https://example.com` | ping + HTTP (catching a 500, a DNS failure, an expired TLS certificate, a redirect loop, etc.) |
+| `https://example.com:1337` | ping + HTTP, against that port |
+| `ssh://example.com` / `ssh://example.com:1337` | ping + SSH (connects and verifies the server's SSH identification banner; defaults to port 22) |
+
+Ping is checked independently from the HTTP/TCP/SSH probe: many hosts (behind
+load balancers, CDNs, or firewalls) drop ICMP but serve their actual service
+just fine, so a blocked ping alone doesn't mark a target down: the "Status"
+column is based on the probe, with ping shown alongside as extra diagnostic
+info. A target only shows as `OFFLINE` when both ping and the probe fail; a
+ping-only target's status is based on ping alone, since there's nothing else
+to check.
+
+If the same host appears more than once (e.g. `example.com` and
+`https://example.com/health`), it's only pinged once per round. The ping
+result is shared across all targets pointing at that host.
+
+While checks are running you get a live spinner and a progress bar per
+target counting down its timeout; results are then shown in a table that
+updates in place (via [`rich`](https://github.com/Textualize/rich)) rather
+than reprinting on every round.
+
+Each target also keeps a rolling window of its last 20 response times for
+the session (HTTP response time, TCP connect time, or SSH connect+banner
+time, whichever applies), shown as Min/Max latency columns and a tiny
+sparkline ("Trend"), along with
+the last time it was seen online and the last time it was seen offline.
+This history is in-memory only and resets each time you start the tool.
+
+## Installation
+
+The package is published on PyPI as `isitup-cli`, but it installs a plain
+`isitup` command:
+
+```bash
+uv tool install isitup-cli
+# or: pipx install isitup-cli
+# or: pip install isitup-cli
+```
+
+To try unreleased changes straight from `main` instead (no PyPI release
+needed):
+
+```bash
+uv tool install git+https://github.com/ramsesoriginal/isitup
+```
+
+Either way, remove it later with `uv tool uninstall isitup`.
+
+## Usage
+
+```bash
+isitup example.com https://example.org db.internal:5432
+```
+
+`--url`/`-u` work the same way and can be freely mixed with positional
+targets: `isitup example.com -u https://example.org` is the same as
+`isitup example.com https://example.org`:
+
+```bash
+isitup --url example.com --url https://example.org --url db.internal:5432
+```
+
+Or with a config file:
+
+```bash
+cp config.example.yaml config.yaml
+# edit config.yaml
+isitup --config config.yaml
+```
+
+Config files and CLI-supplied targets (positional or `--url`) can be
+combined; the tool watches the union of both. The config file is watched for
+changes and reloaded automatically: add, remove, or edit targets without
+restarting the tool (CLI-supplied targets can't change at runtime, only
+what's in the file).
+
+### Options
+
+| Flag | Description |
+| --- | --- |
+| `-c`, `--config PATH` | YAML file listing targets; reloaded automatically on change |
+| `TARGET` (positional) | a target to monitor: same as `-u`/`--url`, just without the flag (repeatable) |
+| `-u`, `--url TARGET` | a target to monitor (repeatable): hostname, `hostname:port`, or a URL |
+| `-i`, `--interval SECONDS` | seconds between check rounds (default: 30) |
+| `--ping-timeout SECONDS` | ping reply timeout (default: 2) |
+| `--http-timeout SECONDS` | timeout for the HTTP request or TCP connect (default: 5) |
+| `--no-ping` | skip ICMP entirely, HTTP/TCP-only checks |
+| `--columns LIST` | comma-separated list of table columns to show, in order (interactive UI only; `--plain`/`--json` always include every field) — see below |
+| `--basic-auth USER:PASS` | HTTP Basic Auth for CLI-supplied HTTP targets that don't set their own `basic_auth:` in the config file — see below |
+| `--basic-auth-env USER_VAR:PASS_VAR` | same as `--basic-auth`, but reads the username/password from the named environment variables |
+| `--tag TAG` | tag applied to CLI-supplied targets (repeatable) — see below |
+| `--filter-tag TAG` | only monitor targets carrying at least one of the given tags (repeatable) — see below |
+| `--once` | run a single round and exit; exit code is `1` if any target is down, `0` otherwise. Useful as a cron/CI health gate |
+| `--plain` | print one plain-text line per target per round instead of the live UI (for logging/piping) |
+| `--json` | print one JSON object per target per round instead of the live UI (for machine consumption) |
+
+`--plain` and `--json` are mutually exclusive with each other, and both skip
+the interactive spinner/progress UI entirely.
+
+### Note on ping
+
+Some servers/networks (common on cloud providers, behind load balancers or
+CDNs) block ICMP echo requests entirely even though the service itself is
+perfectly reachable. The "Status" column already accounts for this and
+won't flag such a target as down (unless it's ping-only, in which case ping
+*is* the only signal there is). If you'd rather not run ping checks against
+a target at all (e.g. to skip the ~2s ping timeout), either set `ping: false`
+for it in the config file, or pass `--no-ping` to disable ICMP checks
+globally. Note that a ping-only target (bare hostname, no port) can't have
+`ping: false`, there would be nothing left to check.
+
+### SSH availability check
+
+`ssh://example.com` (or `ssh://example.com:1234` for a non-standard port,
+default 22) connects over TCP and reads the server's SSH identification
+banner (the string like `SSH-2.0-OpenSSH_9.6` that a compliant server sends
+before any client input, per RFC 4253) rather than just checking whether
+the port is open. If the port is open but the banner doesn't start with
+`SSH-`, the target is reported down with `error_kind: protocol` — this
+catches something else listening on the port. No SSH handshake, key
+exchange, or authentication is attempted, so no credentials are needed or
+used.
+
+### Customizing table columns
+
+The interactive table shows all of `target`, `status`, `ping`, `service`,
+`latency`, `min`, `max`, `trend`, `last_online`, `last_offline`, `detail`,
+`checked` by default, in that order. A few more are available but not
+shown by default — `tags` (see above) and the HTTP header columns
+`content_length`, `last_modified`, `etag`, `content_type`, `server`,
+`header_change` (see below). To show a different subset (or reorder
+them), pass `--columns` with a comma-separated list:
+
+```bash
+isitup --columns target,status,detail --url https://example.com
+```
+
+Or set it once in the config file:
+
+```yaml
+columns: [target, status, service, latency, detail]
+```
+
+`--columns` takes precedence over a config file's `columns:` list, which
+takes precedence over the default. This only affects the interactive UI —
+`--plain` and `--json` always include every field, since they're meant for
+machine consumption.
+
+### HTTP Basic Auth
+
+Set `basic_auth` on a config file target to send an `Authorization` header
+with its HTTP requests. Each of `username`/`password` can be given either
+literally or via a `*_env` reference to an environment variable (but not
+both):
+
+```yaml
+targets:
+  - name: Protected API
+    url: https://api.internal.example.com
+    basic_auth:
+      username: admin
+      password_env: API_PASSWORD   # read from $API_PASSWORD at startup
+```
+
+`basic_auth` only applies to `http://`/`https://` targets — it's rejected
+on a bare hostname or `hostname:port` target.
+
+For targets passed directly on the command line (positional or `--url`),
+use `--basic-auth USER:PASS` or `--basic-auth-env USER_VAR:PASS_VAR`
+instead. Either flag applies to every CLI-supplied HTTP target in that
+invocation, but never to config-file targets — those always use their own
+`basic_auth:` (or none), so the two never mix unexpectedly:
+
+```bash
+isitup --basic-auth-env API_USER:API_PASSWORD --url https://api.internal.example.com
+```
+
+### HTTP header/metadata tracking
+
+For HTTP(S) targets, a handful of response headers are captured every
+round — `Content-Length` (response size), `Last-Modified`, `ETag`,
+`Content-Type`, and `Server` — without ever touching the response body
+itself. `--plain`/`--json` always include them (nested under `http` in
+JSON, as `content_length=`/`last_modified=`/etc. fields in `--plain`),
+alongside a `last_header_change`/`header_change` timestamp: the last time
+any of those five values actually differed from the previous round (not
+set on the very first check, since there's nothing yet to compare against).
+This is handy for noticing "something on this page changed" without
+diffing the body yourself.
+
+In the interactive table these show up as the `content_length`,
+`last_modified`, `etag`, `content_type`, `server`, and `header_change`
+columns — available via `--columns`/config `columns:`, but not part of the
+default set (see above), so the table's default look is unaffected.
+
+### Tagging and grouping
+
+Any target (ping-only, TCP, or HTTP) can carry `tags` in the config file:
+
+```yaml
+targets:
+  - name: Prod Website
+    url: https://example.com
+    tags: [prod, web]
+  - name: Staging Website
+    url: https://staging.example.com
+    tags: [staging, web]
+```
+
+Tags show up as their own `Tags` table column — add it with `--columns
+target,tags,status,...` (or a config `columns:` list), since it isn't in
+the default set — and always as a `tags` field in `--plain`/`--json`
+output.
+
+To only monitor a subset, pass `--filter-tag` (repeatable — a target
+matches if it has *any* of the given tags):
+
+```bash
+isitup --config config.yaml --filter-tag prod
+```
+
+With no `--filter-tag` given, every target is monitored, same as today.
+For targets passed directly on the command line, `--tag TAG` (repeatable)
+tags every CLI-supplied target in that invocation — like `--basic-auth`,
+it never touches config-file targets, which set their own `tags:` instead.
+
+### Failure classification
+
+When the HTTP, TCP, or SSH probe fails, the specific reason is captured as
+`error_kind` (visible in `--json` output, and shown as a short tag like
+`DOWN (DNS)` in the Service column otherwise):
+
+| `error_kind` | Meaning |
+| --- | --- |
+| `dns` | the hostname failed to resolve |
+| `tls` | a TLS/certificate error (HTTP only, e.g. expired or self-signed cert) |
+| `redirect` | too many redirects (HTTP only, possible redirect loop) |
+| `timeout` | didn't complete within `--http-timeout` |
+| `connection` | connection refused or otherwise unreachable |
+| `protocol` | connected, but the server's response wasn't a valid SSH banner (SSH only) |
+| `client_error` / `server_error` | got a 4xx / 5xx HTTP response |
+| `request_error` | anything else `requests` raised |
+
+## Development
+
+```bash
+uv sync
+uv run isitup --once --url https://example.com
+
+uv run pytest       # tests
+uv run ruff check .    # lint
+uv run ruff format .   # format
+uv run mypy src tests  # type check
+```
+
+Every push and pull request runs this same lint/type-check/test suite via
+[GitHub Actions](.github/workflows/ci.yml), across Linux and Windows.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md).
+
+## License
+
+[GPL-3.0](LICENSE): see [LICENSE](LICENSE) for the full text.

isitup_cli-0.2.0/README.md

@@ -0,0 +1,289 @@
+<div align="center">
+  <img src="https://raw.githubusercontent.com/ramsesoriginal/isitup/main/logo/main_hero.svg" alt="isitup" width="720">
+
+  <p><strong>Is it up? Ping, HTTP, and TCP checks in one small, fast CLI.</strong></p>
+
+  [![PyPI](https://img.shields.io/pypi/v/isitup-cli?color=blue)](https://pypi.org/project/isitup-cli/)
+  [![CI](https://github.com/ramsesoriginal/isitup/actions/workflows/ci.yml/badge.svg)](https://github.com/ramsesoriginal/isitup/actions/workflows/ci.yml)
+  [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
+  [![Python 3.14+](https://img.shields.io/badge/python-3.14%2B-3776AB?logo=python&logoColor=white)](pyproject.toml)
+  [![uv](https://img.shields.io/badge/uv-managed-DE5FE9?logo=uv&logoColor=white)](https://github.com/astral-sh/uv)
+  [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+  [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+  [![GitHub stars](https://img.shields.io/github/stars/ramsesoriginal/isitup?style=social)](https://github.com/ramsesoriginal/isitup)
+</div>
+
+---
+
+**isitup** is a small CLI that periodically checks whether servers respond to ping and,
+depending on how the target is written, HTTP, a TCP port, or SSH:
+
+| Target | Checks |
+| --- | --- |
+| `example.com` | ping only |
+| `example.com:1337` | ping + TCP connect to port 1337 |
+| `http://example.com` / `https://example.com` | ping + HTTP (catching a 500, a DNS failure, an expired TLS certificate, a redirect loop, etc.) |
+| `https://example.com:1337` | ping + HTTP, against that port |
+| `ssh://example.com` / `ssh://example.com:1337` | ping + SSH (connects and verifies the server's SSH identification banner; defaults to port 22) |
+
+Ping is checked independently from the HTTP/TCP/SSH probe: many hosts (behind
+load balancers, CDNs, or firewalls) drop ICMP but serve their actual service
+just fine, so a blocked ping alone doesn't mark a target down: the "Status"
+column is based on the probe, with ping shown alongside as extra diagnostic
+info. A target only shows as `OFFLINE` when both ping and the probe fail; a
+ping-only target's status is based on ping alone, since there's nothing else
+to check.
+
+If the same host appears more than once (e.g. `example.com` and
+`https://example.com/health`), it's only pinged once per round. The ping
+result is shared across all targets pointing at that host.
+
+While checks are running you get a live spinner and a progress bar per
+target counting down its timeout; results are then shown in a table that
+updates in place (via [`rich`](https://github.com/Textualize/rich)) rather
+than reprinting on every round.
+
+Each target also keeps a rolling window of its last 20 response times for
+the session (HTTP response time, TCP connect time, or SSH connect+banner
+time, whichever applies), shown as Min/Max latency columns and a tiny
+sparkline ("Trend"), along with
+the last time it was seen online and the last time it was seen offline.
+This history is in-memory only and resets each time you start the tool.
+
+## Installation
+
+The package is published on PyPI as `isitup-cli`, but it installs a plain
+`isitup` command:
+
+```bash
+uv tool install isitup-cli
+# or: pipx install isitup-cli
+# or: pip install isitup-cli
+```
+
+To try unreleased changes straight from `main` instead (no PyPI release
+needed):
+
+```bash
+uv tool install git+https://github.com/ramsesoriginal/isitup
+```
+
+Either way, remove it later with `uv tool uninstall isitup`.
+
+## Usage
+
+```bash
+isitup example.com https://example.org db.internal:5432
+```
+
+`--url`/`-u` work the same way and can be freely mixed with positional
+targets: `isitup example.com -u https://example.org` is the same as
+`isitup example.com https://example.org`:
+
+```bash
+isitup --url example.com --url https://example.org --url db.internal:5432
+```
+
+Or with a config file:
+
+```bash
+cp config.example.yaml config.yaml
+# edit config.yaml
+isitup --config config.yaml
+```
+
+Config files and CLI-supplied targets (positional or `--url`) can be
+combined; the tool watches the union of both. The config file is watched for
+changes and reloaded automatically: add, remove, or edit targets without
+restarting the tool (CLI-supplied targets can't change at runtime, only
+what's in the file).
+
+### Options
+
+| Flag | Description |
+| --- | --- |
+| `-c`, `--config PATH` | YAML file listing targets; reloaded automatically on change |
+| `TARGET` (positional) | a target to monitor: same as `-u`/`--url`, just without the flag (repeatable) |
+| `-u`, `--url TARGET` | a target to monitor (repeatable): hostname, `hostname:port`, or a URL |
+| `-i`, `--interval SECONDS` | seconds between check rounds (default: 30) |
+| `--ping-timeout SECONDS` | ping reply timeout (default: 2) |
+| `--http-timeout SECONDS` | timeout for the HTTP request or TCP connect (default: 5) |
+| `--no-ping` | skip ICMP entirely, HTTP/TCP-only checks |
+| `--columns LIST` | comma-separated list of table columns to show, in order (interactive UI only; `--plain`/`--json` always include every field) — see below |
+| `--basic-auth USER:PASS` | HTTP Basic Auth for CLI-supplied HTTP targets that don't set their own `basic_auth:` in the config file — see below |
+| `--basic-auth-env USER_VAR:PASS_VAR` | same as `--basic-auth`, but reads the username/password from the named environment variables |
+| `--tag TAG` | tag applied to CLI-supplied targets (repeatable) — see below |
+| `--filter-tag TAG` | only monitor targets carrying at least one of the given tags (repeatable) — see below |
+| `--once` | run a single round and exit; exit code is `1` if any target is down, `0` otherwise. Useful as a cron/CI health gate |
+| `--plain` | print one plain-text line per target per round instead of the live UI (for logging/piping) |
+| `--json` | print one JSON object per target per round instead of the live UI (for machine consumption) |
+
+`--plain` and `--json` are mutually exclusive with each other, and both skip
+the interactive spinner/progress UI entirely.
+
+### Note on ping
+
+Some servers/networks (common on cloud providers, behind load balancers or
+CDNs) block ICMP echo requests entirely even though the service itself is
+perfectly reachable. The "Status" column already accounts for this and
+won't flag such a target as down (unless it's ping-only, in which case ping
+*is* the only signal there is). If you'd rather not run ping checks against
+a target at all (e.g. to skip the ~2s ping timeout), either set `ping: false`
+for it in the config file, or pass `--no-ping` to disable ICMP checks
+globally. Note that a ping-only target (bare hostname, no port) can't have
+`ping: false`, there would be nothing left to check.
+
+### SSH availability check
+
+`ssh://example.com` (or `ssh://example.com:1234` for a non-standard port,
+default 22) connects over TCP and reads the server's SSH identification
+banner (the string like `SSH-2.0-OpenSSH_9.6` that a compliant server sends
+before any client input, per RFC 4253) rather than just checking whether
+the port is open. If the port is open but the banner doesn't start with
+`SSH-`, the target is reported down with `error_kind: protocol` — this
+catches something else listening on the port. No SSH handshake, key
+exchange, or authentication is attempted, so no credentials are needed or
+used.
+
+### Customizing table columns
+
+The interactive table shows all of `target`, `status`, `ping`, `service`,
+`latency`, `min`, `max`, `trend`, `last_online`, `last_offline`, `detail`,
+`checked` by default, in that order. A few more are available but not
+shown by default — `tags` (see above) and the HTTP header columns
+`content_length`, `last_modified`, `etag`, `content_type`, `server`,
+`header_change` (see below). To show a different subset (or reorder
+them), pass `--columns` with a comma-separated list:
+
+```bash
+isitup --columns target,status,detail --url https://example.com
+```
+
+Or set it once in the config file:
+
+```yaml
+columns: [target, status, service, latency, detail]
+```
+
+`--columns` takes precedence over a config file's `columns:` list, which
+takes precedence over the default. This only affects the interactive UI —
+`--plain` and `--json` always include every field, since they're meant for
+machine consumption.
+
+### HTTP Basic Auth
+
+Set `basic_auth` on a config file target to send an `Authorization` header
+with its HTTP requests. Each of `username`/`password` can be given either
+literally or via a `*_env` reference to an environment variable (but not
+both):
+
+```yaml
+targets:
+  - name: Protected API
+    url: https://api.internal.example.com
+    basic_auth:
+      username: admin
+      password_env: API_PASSWORD   # read from $API_PASSWORD at startup
+```
+
+`basic_auth` only applies to `http://`/`https://` targets — it's rejected
+on a bare hostname or `hostname:port` target.
+
+For targets passed directly on the command line (positional or `--url`),
+use `--basic-auth USER:PASS` or `--basic-auth-env USER_VAR:PASS_VAR`
+instead. Either flag applies to every CLI-supplied HTTP target in that
+invocation, but never to config-file targets — those always use their own
+`basic_auth:` (or none), so the two never mix unexpectedly:
+
+```bash
+isitup --basic-auth-env API_USER:API_PASSWORD --url https://api.internal.example.com
+```
+
+### HTTP header/metadata tracking
+
+For HTTP(S) targets, a handful of response headers are captured every
+round — `Content-Length` (response size), `Last-Modified`, `ETag`,
+`Content-Type`, and `Server` — without ever touching the response body
+itself. `--plain`/`--json` always include them (nested under `http` in
+JSON, as `content_length=`/`last_modified=`/etc. fields in `--plain`),
+alongside a `last_header_change`/`header_change` timestamp: the last time
+any of those five values actually differed from the previous round (not
+set on the very first check, since there's nothing yet to compare against).
+This is handy for noticing "something on this page changed" without
+diffing the body yourself.
+
+In the interactive table these show up as the `content_length`,
+`last_modified`, `etag`, `content_type`, `server`, and `header_change`
+columns — available via `--columns`/config `columns:`, but not part of the
+default set (see above), so the table's default look is unaffected.
+
+### Tagging and grouping
+
+Any target (ping-only, TCP, or HTTP) can carry `tags` in the config file:
+
+```yaml
+targets:
+  - name: Prod Website
+    url: https://example.com
+    tags: [prod, web]
+  - name: Staging Website
+    url: https://staging.example.com
+    tags: [staging, web]
+```
+
+Tags show up as their own `Tags` table column — add it with `--columns
+target,tags,status,...` (or a config `columns:` list), since it isn't in
+the default set — and always as a `tags` field in `--plain`/`--json`
+output.
+
+To only monitor a subset, pass `--filter-tag` (repeatable — a target
+matches if it has *any* of the given tags):
+
+```bash
+isitup --config config.yaml --filter-tag prod
+```
+
+With no `--filter-tag` given, every target is monitored, same as today.
+For targets passed directly on the command line, `--tag TAG` (repeatable)
+tags every CLI-supplied target in that invocation — like `--basic-auth`,
+it never touches config-file targets, which set their own `tags:` instead.
+
+### Failure classification
+
+When the HTTP, TCP, or SSH probe fails, the specific reason is captured as
+`error_kind` (visible in `--json` output, and shown as a short tag like
+`DOWN (DNS)` in the Service column otherwise):
+
+| `error_kind` | Meaning |
+| --- | --- |
+| `dns` | the hostname failed to resolve |
+| `tls` | a TLS/certificate error (HTTP only, e.g. expired or self-signed cert) |
+| `redirect` | too many redirects (HTTP only, possible redirect loop) |
+| `timeout` | didn't complete within `--http-timeout` |
+| `connection` | connection refused or otherwise unreachable |
+| `protocol` | connected, but the server's response wasn't a valid SSH banner (SSH only) |
+| `client_error` / `server_error` | got a 4xx / 5xx HTTP response |
+| `request_error` | anything else `requests` raised |
+
+## Development
+
+```bash
+uv sync
+uv run isitup --once --url https://example.com
+
+uv run pytest       # tests
+uv run ruff check .    # lint
+uv run ruff format .   # format
+uv run mypy src tests  # type check
+```
+
+Every push and pull request runs this same lint/type-check/test suite via
+[GitHub Actions](.github/workflows/ci.yml), across Linux and Windows.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md).
+
+## License
+
+[GPL-3.0](LICENSE): see [LICENSE](LICENSE) for the full text.

{isitup_cli-0.1.3 → isitup_cli-0.2.0}/pyproject.toml

@@ -1,12 +1,13 @@
 [project]
 name = "isitup-cli"
-version = "0.1.3"
+version = "0.2.0"
 description = "A small CLI that periodically checks whether servers respond to ping, HTTP, and TCP ports"
 readme = "README.md"
 license = "GPL-3.0-only"
 license-files = ["LICENSE"]
 requires-python = ">=3.14"
 classifiers = [
+    "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Intended Audience :: System Administrators",
     "Topic :: System :: Networking :: Monitoring",

{isitup_cli-0.1.3 → isitup_cli-0.2.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "isitup-cli"
-version = "0.1.3"
+version = "0.2.0"
 description = "A small CLI that periodically checks whether servers respond to ping, HTTP, and TCP ports"
 readme = "README.md"
 license = "GPL-3.0-only"
@@ -10,6 +10,7 @@ authors = [
 ]
 requires-python = ">=3.14"
 classifiers = [
+    "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Intended Audience :: System Administrators",
     "Topic :: System :: Networking :: Monitoring",

isitup_cli-0.2.0/src/isitup/__init__.py

@@ -0,0 +1,3 @@
+from .cli import __version__, main
+
+__all__ = ["main", "__version__"]