ifpretty 0.1.0__tar.gz

ifpretty-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 iklo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ifpretty-0.1.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: ifpretty
+Version: 0.1.0
+Summary: Prettify and enrich ifconfig output: aligned tables, IP/MAC/scope annotations, OUI vendor lookup, live DNS/DHCP/route, and a 1h bandwidth graph.
+Author-email: iklo <tiktachack@gmail.com>
+License: MIT
+Keywords: ifconfig,network,networking,cli,terminal,rich,macos
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13
+Dynamic: license-file
+
+# ifpretty
+
+Prettify and **enrich** `ifconfig` output — aligned tables, color, decoded flags,
+IP/MAC/scope annotations, OUI vendor lookup, live DNS/DHCP/route, and a 1‑hour
+bandwidth graph. Built on [rich](https://github.com/Textualize/rich); macOS‑focused.
+
+```
+ifconfig | ifpretty
+```
+
+## Install
+
+```sh
+pip install ifpretty
+```
+
+## Usage
+
+```sh
+ifconfig | ifpretty            # boxed table per interface (default), borders aligned
+ifconfig | ifpretty --records  # compact label/value record layout
+ifconfig | ifpretty --table    # single wide table, all fields as columns (<=240)
+ifconfig | ifpretty --live      # + route, traffic, friendly names, DNS, DHCP (macOS)
+ifconfig | ifpretty --check     # + ping the default gateway for latency (macOS)
+ifconfig | ifpretty --explain   # append a legend explaining the flags/options seen
+ifconfig en0 | ifpretty
+```
+
+It reads raw `ifconfig` on **stdin**, so you stay in control of which interfaces
+to show.
+
+## What it adds
+
+**Always on (offline, deterministic):**
+
+- Per‑interface **role** (loopback / Ethernet·Wi‑Fi / VPN·tunnel / bridge / …).
+- **IP scope** for every address — loopback / link‑local / ULA / private / global —
+  plus IPv4 network + usable‑host count.
+- **MAC** kind (universal vs locally‑administered), **OUI vendor** (bundled IEEE
+  registry, no network), shared‑MAC notes (e.g. bridge members), and EUI‑64 detection.
+- **Media** speed/duplex with a half‑duplex ⚠ warning; jumbo / sub‑1280 MTU notes.
+- Decoded flag/option/nd6 bitfields; aligned IPv6 attribute columns.
+
+**`--live` (macOS, cross‑references the system):**
+
+- Default route + gateway, friendly hardware‑port names, per‑interface DNS and
+  search domains, DHCP server + lease, traffic counters (bytes + packets) and
+  error/collision counts.
+
+**`--check`:** pings the default gateway and reports latency.
+
+**1‑hour bandwidth graph:** schedule the recorder, then a Unicode sparkline of
+the last hour appears automatically:
+
+```sh
+# once, e.g. in crontab -e
+* * * * * /usr/local/bin/ifpretty --record
+```
+
+```
+1h in  ▁▁▁▂▄█▅▂▁▁▁▁   peak 10.0 Mbps
+1h out ▁▂▂▄▆█▄▂▂▁▁▁   peak 533.3 Kbps
+```
+
+History is stored at `~/.cache/ifpretty/samples.csv` (override with
+`IFPRETTY_HISTORY`).
+
+## Notes
+
+- Colors auto‑disable when piped; force with `CLICOLOR_FORCE=1`, disable with `NO_COLOR=1`.
+- `--live` / `--check` / `--record` use macOS tools (`route`, `netstat`,
+  `networksetup`, `scutil`, `ipconfig`, `ping`) and no‑op elsewhere.
+
+## License
+
+MIT

ifpretty-0.1.0/README.md

@@ -0,0 +1,76 @@
+# ifpretty
+
+Prettify and **enrich** `ifconfig` output — aligned tables, color, decoded flags,
+IP/MAC/scope annotations, OUI vendor lookup, live DNS/DHCP/route, and a 1‑hour
+bandwidth graph. Built on [rich](https://github.com/Textualize/rich); macOS‑focused.
+
+```
+ifconfig | ifpretty
+```
+
+## Install
+
+```sh
+pip install ifpretty
+```
+
+## Usage
+
+```sh
+ifconfig | ifpretty            # boxed table per interface (default), borders aligned
+ifconfig | ifpretty --records  # compact label/value record layout
+ifconfig | ifpretty --table    # single wide table, all fields as columns (<=240)
+ifconfig | ifpretty --live      # + route, traffic, friendly names, DNS, DHCP (macOS)
+ifconfig | ifpretty --check     # + ping the default gateway for latency (macOS)
+ifconfig | ifpretty --explain   # append a legend explaining the flags/options seen
+ifconfig en0 | ifpretty
+```
+
+It reads raw `ifconfig` on **stdin**, so you stay in control of which interfaces
+to show.
+
+## What it adds
+
+**Always on (offline, deterministic):**
+
+- Per‑interface **role** (loopback / Ethernet·Wi‑Fi / VPN·tunnel / bridge / …).
+- **IP scope** for every address — loopback / link‑local / ULA / private / global —
+  plus IPv4 network + usable‑host count.
+- **MAC** kind (universal vs locally‑administered), **OUI vendor** (bundled IEEE
+  registry, no network), shared‑MAC notes (e.g. bridge members), and EUI‑64 detection.
+- **Media** speed/duplex with a half‑duplex ⚠ warning; jumbo / sub‑1280 MTU notes.
+- Decoded flag/option/nd6 bitfields; aligned IPv6 attribute columns.
+
+**`--live` (macOS, cross‑references the system):**
+
+- Default route + gateway, friendly hardware‑port names, per‑interface DNS and
+  search domains, DHCP server + lease, traffic counters (bytes + packets) and
+  error/collision counts.
+
+**`--check`:** pings the default gateway and reports latency.
+
+**1‑hour bandwidth graph:** schedule the recorder, then a Unicode sparkline of
+the last hour appears automatically:
+
+```sh
+# once, e.g. in crontab -e
+* * * * * /usr/local/bin/ifpretty --record
+```
+
+```
+1h in  ▁▁▁▂▄█▅▂▁▁▁▁   peak 10.0 Mbps
+1h out ▁▂▂▄▆█▄▂▂▁▁▁   peak 533.3 Kbps
+```
+
+History is stored at `~/.cache/ifpretty/samples.csv` (override with
+`IFPRETTY_HISTORY`).
+
+## Notes
+
+- Colors auto‑disable when piped; force with `CLICOLOR_FORCE=1`, disable with `NO_COLOR=1`.
+- `--live` / `--check` / `--record` use macOS tools (`route`, `netstat`,
+  `networksetup`, `scutil`, `ipconfig`, `ping`) and no‑op elsewhere.
+
+## License
+
+MIT

ifpretty-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ifpretty"
+version = "0.1.0"
+description = "Prettify and enrich ifconfig output: aligned tables, IP/MAC/scope annotations, OUI vendor lookup, live DNS/DHCP/route, and a 1h bandwidth graph."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [{ name = "iklo", email = "tiktachack@gmail.com" }]
+keywords = ["ifconfig", "network", "networking", "cli", "terminal", "rich", "macos"]
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: POSIX",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: System :: Networking",
+    "Topic :: System :: Monitoring",
+]
+dependencies = ["rich>=13"]
+
+[project.scripts]
+ifpretty = "ifpretty.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+ifpretty = ["data/*.gz"]

ifpretty-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ifpretty-0.1.0/src/ifpretty/__init__.py

@@ -0,0 +1,6 @@
+"""ifpretty — prettify and enrich `ifconfig` output."""
+
+from .cli import main
+
+__version__ = "0.1.0"
+__all__ = ["main", "__version__"]

ifpretty-0.1.0/src/ifpretty/__main__.py

@@ -0,0 +1,8 @@
+"""Enable `python -m ifpretty`."""
+
+import sys
+
+from .cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())